gi-atk-2.0.22: Atk bindings

Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Atk.Interfaces.Window

Contents

- Exported types
- Methods
  - Overloaded methods
- Signals
  - activate
  - create
  - deactivate
  - destroy
  - maximize
  - minimize
  - move
  - resize
  - restore

Description

`Window` should be implemented by the UI elements that represent a top-level window, such as the main window of an application or dialog.

Synopsis

- newtype Window = Window (ManagedPtr Window)
- class (GObject o, IsDescendantOf Window o) => IsWindow o
- toWindow :: (MonadIO m, IsWindow o) => o -> m Window
- type C_WindowActivateCallback = Ptr () -> Ptr () -> IO ()
- type WindowActivateCallback = IO ()
- afterWindowActivate :: (IsWindow a, MonadIO m) => a -> WindowActivateCallback -> m SignalHandlerId
- genClosure_WindowActivate :: MonadIO m => WindowActivateCallback -> m (GClosure C_WindowActivateCallback)
- mk_WindowActivateCallback :: C_WindowActivateCallback -> IO (FunPtr C_WindowActivateCallback)
- noWindowActivateCallback :: Maybe WindowActivateCallback
- onWindowActivate :: (IsWindow a, MonadIO m) => a -> WindowActivateCallback -> m SignalHandlerId
- wrap_WindowActivateCallback :: WindowActivateCallback -> C_WindowActivateCallback
- type C_WindowCreateCallback = Ptr () -> Ptr () -> IO ()
- type WindowCreateCallback = IO ()
- afterWindowCreate :: (IsWindow a, MonadIO m) => a -> WindowCreateCallback -> m SignalHandlerId
- genClosure_WindowCreate :: MonadIO m => WindowCreateCallback -> m (GClosure C_WindowCreateCallback)
- mk_WindowCreateCallback :: C_WindowCreateCallback -> IO (FunPtr C_WindowCreateCallback)
- noWindowCreateCallback :: Maybe WindowCreateCallback
- onWindowCreate :: (IsWindow a, MonadIO m) => a -> WindowCreateCallback -> m SignalHandlerId
- wrap_WindowCreateCallback :: WindowCreateCallback -> C_WindowCreateCallback
- type C_WindowDeactivateCallback = Ptr () -> Ptr () -> IO ()
- type WindowDeactivateCallback = IO ()
- afterWindowDeactivate :: (IsWindow a, MonadIO m) => a -> WindowDeactivateCallback -> m SignalHandlerId
- genClosure_WindowDeactivate :: MonadIO m => WindowDeactivateCallback -> m (GClosure C_WindowDeactivateCallback)
- mk_WindowDeactivateCallback :: C_WindowDeactivateCallback -> IO (FunPtr C_WindowDeactivateCallback)
- noWindowDeactivateCallback :: Maybe WindowDeactivateCallback
- onWindowDeactivate :: (IsWindow a, MonadIO m) => a -> WindowDeactivateCallback -> m SignalHandlerId
- wrap_WindowDeactivateCallback :: WindowDeactivateCallback -> C_WindowDeactivateCallback
- type C_WindowDestroyCallback = Ptr () -> Ptr () -> IO ()
- type WindowDestroyCallback = IO ()
- afterWindowDestroy :: (IsWindow a, MonadIO m) => a -> WindowDestroyCallback -> m SignalHandlerId
- genClosure_WindowDestroy :: MonadIO m => WindowDestroyCallback -> m (GClosure C_WindowDestroyCallback)
- mk_WindowDestroyCallback :: C_WindowDestroyCallback -> IO (FunPtr C_WindowDestroyCallback)
- noWindowDestroyCallback :: Maybe WindowDestroyCallback
- onWindowDestroy :: (IsWindow a, MonadIO m) => a -> WindowDestroyCallback -> m SignalHandlerId
- wrap_WindowDestroyCallback :: WindowDestroyCallback -> C_WindowDestroyCallback
- type C_WindowMaximizeCallback = Ptr () -> Ptr () -> IO ()
- type WindowMaximizeCallback = IO ()
- afterWindowMaximize :: (IsWindow a, MonadIO m) => a -> WindowMaximizeCallback -> m SignalHandlerId
- genClosure_WindowMaximize :: MonadIO m => WindowMaximizeCallback -> m (GClosure C_WindowMaximizeCallback)
- mk_WindowMaximizeCallback :: C_WindowMaximizeCallback -> IO (FunPtr C_WindowMaximizeCallback)
- noWindowMaximizeCallback :: Maybe WindowMaximizeCallback
- onWindowMaximize :: (IsWindow a, MonadIO m) => a -> WindowMaximizeCallback -> m SignalHandlerId
- wrap_WindowMaximizeCallback :: WindowMaximizeCallback -> C_WindowMaximizeCallback
- type C_WindowMinimizeCallback = Ptr () -> Ptr () -> IO ()
- type WindowMinimizeCallback = IO ()
- afterWindowMinimize :: (IsWindow a, MonadIO m) => a -> WindowMinimizeCallback -> m SignalHandlerId
- genClosure_WindowMinimize :: MonadIO m => WindowMinimizeCallback -> m (GClosure C_WindowMinimizeCallback)
- mk_WindowMinimizeCallback :: C_WindowMinimizeCallback -> IO (FunPtr C_WindowMinimizeCallback)
- noWindowMinimizeCallback :: Maybe WindowMinimizeCallback
- onWindowMinimize :: (IsWindow a, MonadIO m) => a -> WindowMinimizeCallback -> m SignalHandlerId
- wrap_WindowMinimizeCallback :: WindowMinimizeCallback -> C_WindowMinimizeCallback
- type C_WindowMoveCallback = Ptr () -> Ptr () -> IO ()
- type WindowMoveCallback = IO ()
- afterWindowMove :: (IsWindow a, MonadIO m) => a -> WindowMoveCallback -> m SignalHandlerId
- genClosure_WindowMove :: MonadIO m => WindowMoveCallback -> m (GClosure C_WindowMoveCallback)
- mk_WindowMoveCallback :: C_WindowMoveCallback -> IO (FunPtr C_WindowMoveCallback)
- noWindowMoveCallback :: Maybe WindowMoveCallback
- onWindowMove :: (IsWindow a, MonadIO m) => a -> WindowMoveCallback -> m SignalHandlerId
- wrap_WindowMoveCallback :: WindowMoveCallback -> C_WindowMoveCallback
- type C_WindowResizeCallback = Ptr () -> Ptr () -> IO ()
- type WindowResizeCallback = IO ()
- afterWindowResize :: (IsWindow a, MonadIO m) => a -> WindowResizeCallback -> m SignalHandlerId
- genClosure_WindowResize :: MonadIO m => WindowResizeCallback -> m (GClosure C_WindowResizeCallback)
- mk_WindowResizeCallback :: C_WindowResizeCallback -> IO (FunPtr C_WindowResizeCallback)
- noWindowResizeCallback :: Maybe WindowResizeCallback
- onWindowResize :: (IsWindow a, MonadIO m) => a -> WindowResizeCallback -> m SignalHandlerId
- wrap_WindowResizeCallback :: WindowResizeCallback -> C_WindowResizeCallback
- type C_WindowRestoreCallback = Ptr () -> Ptr () -> IO ()
- type WindowRestoreCallback = IO ()
- afterWindowRestore :: (IsWindow a, MonadIO m) => a -> WindowRestoreCallback -> m SignalHandlerId
- genClosure_WindowRestore :: MonadIO m => WindowRestoreCallback -> m (GClosure C_WindowRestoreCallback)
- mk_WindowRestoreCallback :: C_WindowRestoreCallback -> IO (FunPtr C_WindowRestoreCallback)
- noWindowRestoreCallback :: Maybe WindowRestoreCallback
- onWindowRestore :: (IsWindow a, MonadIO m) => a -> WindowRestoreCallback -> m SignalHandlerId
- wrap_WindowRestoreCallback :: WindowRestoreCallback -> C_WindowRestoreCallback

# Exported types

newtype Window Source #

Memory-managed wrapper type.

Constructors

Window (ManagedPtr Window) |

#### Instances

Instances details

Eq Window Source # |
Instance details Defined in GI.Atk.Interfaces.Window Methods (==) :: Window -> Window -> Bool # (/=) :: Window -> Window -> Bool #
GObject Window Source # |
Instance details Defined in GI.Atk.Interfaces.Window
TypedObject Window Source # |
Instance details Defined in GI.Atk.Interfaces.Window Methods glibType :: IO GType Source #
ManagedPtrNewtype Window Source # |
Instance details Defined in GI.Atk.Interfaces.Window Methods toManagedPtr :: Window -> ManagedPtr Window Source #
IsGValue Window Source # | Convert `Window` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.Atk.Interfaces.Window Methods toGValue :: Window -> IO GValue Source # fromGValue :: GValue -> IO Window Source #
HasParentTypes Window Source # |
Instance details Defined in GI.Atk.Interfaces.Window
type ParentTypes Window Source # |
Instance details Defined in GI.Atk.Interfaces.Window type ParentTypes Window = '[Object, Object]

class (GObject o, IsDescendantOf Window o) => IsWindow o Source #

Type class for types which can be safely cast to `Window`, for instance with `toWindow`.

#### Instances

Instances details

(GObject o, IsDescendantOf Window o) => IsWindow o Source # |
Instance details Defined in GI.Atk.Interfaces.Window

toWindow :: (MonadIO m, IsWindow o) => o -> m Window Source #

Cast to `Window`, for types for which this is known to be safe. For general casts, use `castTo`.

# Methods

## Overloaded methods

# Signals

## activate

type C_WindowActivateCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type WindowActivateCallback = IO () Source #

The signal activate is emitted when a window becomes the active window of the application or session.

Since: 2.2

afterWindowActivate :: (IsWindow a, MonadIO m) => a -> WindowActivateCallback -> m SignalHandlerId Source #

Connect a signal handler for the activate signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after window #activate callback

genClosure_WindowActivate :: MonadIO m => WindowActivateCallback -> m (GClosure C_WindowActivateCallback) Source #

Wrap the callback into a `GClosure`.

mk_WindowActivateCallback :: C_WindowActivateCallback -> IO (FunPtr C_WindowActivateCallback) Source #

Generate a function pointer callable from C code, from a `C_WindowActivateCallback`.

noWindowActivateCallback :: Maybe WindowActivateCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `WindowActivateCallback``.

onWindowActivate :: (IsWindow a, MonadIO m) => a -> WindowActivateCallback -> m SignalHandlerId Source #

Connect a signal handler for the activate signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on window #activate callback

wrap_WindowActivateCallback :: WindowActivateCallback -> C_WindowActivateCallback Source #

Wrap a `WindowActivateCallback` into a `C_WindowActivateCallback`.

## create

type C_WindowCreateCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type WindowCreateCallback = IO () Source #

The signal create is emitted when a new window is created.

Since: 2.2

afterWindowCreate :: (IsWindow a, MonadIO m) => a -> WindowCreateCallback -> m SignalHandlerId Source #

Connect a signal handler for the create signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after window #create callback

genClosure_WindowCreate :: MonadIO m => WindowCreateCallback -> m (GClosure C_WindowCreateCallback) Source #

Wrap the callback into a `GClosure`.

mk_WindowCreateCallback :: C_WindowCreateCallback -> IO (FunPtr C_WindowCreateCallback) Source #

Generate a function pointer callable from C code, from a `C_WindowCreateCallback`.

noWindowCreateCallback :: Maybe WindowCreateCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `WindowCreateCallback``.

onWindowCreate :: (IsWindow a, MonadIO m) => a -> WindowCreateCallback -> m SignalHandlerId Source #

Connect a signal handler for the create signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on window #create callback

wrap_WindowCreateCallback :: WindowCreateCallback -> C_WindowCreateCallback Source #

Wrap a `WindowCreateCallback` into a `C_WindowCreateCallback`.

## deactivate

type C_WindowDeactivateCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type WindowDeactivateCallback = IO () Source #

The signal deactivate is emitted when a window is no longer the active window of the application or session.

Since: 2.2

afterWindowDeactivate :: (IsWindow a, MonadIO m) => a -> WindowDeactivateCallback -> m SignalHandlerId Source #

Connect a signal handler for the deactivate signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after window #deactivate callback

genClosure_WindowDeactivate :: MonadIO m => WindowDeactivateCallback -> m (GClosure C_WindowDeactivateCallback) Source #

Wrap the callback into a `GClosure`.

mk_WindowDeactivateCallback :: C_WindowDeactivateCallback -> IO (FunPtr C_WindowDeactivateCallback) Source #

Generate a function pointer callable from C code, from a `C_WindowDeactivateCallback`.

noWindowDeactivateCallback :: Maybe WindowDeactivateCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `WindowDeactivateCallback``.

onWindowDeactivate :: (IsWindow a, MonadIO m) => a -> WindowDeactivateCallback -> m SignalHandlerId Source #

Connect a signal handler for the deactivate signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on window #deactivate callback

wrap_WindowDeactivateCallback :: WindowDeactivateCallback -> C_WindowDeactivateCallback Source #

Wrap a `WindowDeactivateCallback` into a `C_WindowDeactivateCallback`.

## destroy

type C_WindowDestroyCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type WindowDestroyCallback = IO () Source #

The signal destroy is emitted when a window is destroyed.

Since: 2.2

afterWindowDestroy :: (IsWindow a, MonadIO m) => a -> WindowDestroyCallback -> m SignalHandlerId Source #

Connect a signal handler for the destroy signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after window #destroy callback

genClosure_WindowDestroy :: MonadIO m => WindowDestroyCallback -> m (GClosure C_WindowDestroyCallback) Source #

Wrap the callback into a `GClosure`.

mk_WindowDestroyCallback :: C_WindowDestroyCallback -> IO (FunPtr C_WindowDestroyCallback) Source #

Generate a function pointer callable from C code, from a `C_WindowDestroyCallback`.

noWindowDestroyCallback :: Maybe WindowDestroyCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `WindowDestroyCallback``.

onWindowDestroy :: (IsWindow a, MonadIO m) => a -> WindowDestroyCallback -> m SignalHandlerId Source #

Connect a signal handler for the destroy signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on window #destroy callback

wrap_WindowDestroyCallback :: WindowDestroyCallback -> C_WindowDestroyCallback Source #

Wrap a `WindowDestroyCallback` into a `C_WindowDestroyCallback`.

## maximize

type C_WindowMaximizeCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type WindowMaximizeCallback = IO () Source #

The signal maximize is emitted when a window is maximized.

Since: 2.2

afterWindowMaximize :: (IsWindow a, MonadIO m) => a -> WindowMaximizeCallback -> m SignalHandlerId Source #

Connect a signal handler for the maximize signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after window #maximize callback

genClosure_WindowMaximize :: MonadIO m => WindowMaximizeCallback -> m (GClosure C_WindowMaximizeCallback) Source #

Wrap the callback into a `GClosure`.

mk_WindowMaximizeCallback :: C_WindowMaximizeCallback -> IO (FunPtr C_WindowMaximizeCallback) Source #

Generate a function pointer callable from C code, from a `C_WindowMaximizeCallback`.

noWindowMaximizeCallback :: Maybe WindowMaximizeCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `WindowMaximizeCallback``.

onWindowMaximize :: (IsWindow a, MonadIO m) => a -> WindowMaximizeCallback -> m SignalHandlerId Source #

Connect a signal handler for the maximize signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on window #maximize callback

wrap_WindowMaximizeCallback :: WindowMaximizeCallback -> C_WindowMaximizeCallback Source #

Wrap a `WindowMaximizeCallback` into a `C_WindowMaximizeCallback`.

## minimize

type C_WindowMinimizeCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type WindowMinimizeCallback = IO () Source #

The signal minimize is emitted when a window is minimized.

Since: 2.2

afterWindowMinimize :: (IsWindow a, MonadIO m) => a -> WindowMinimizeCallback -> m SignalHandlerId Source #

Connect a signal handler for the minimize signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after window #minimize callback

genClosure_WindowMinimize :: MonadIO m => WindowMinimizeCallback -> m (GClosure C_WindowMinimizeCallback) Source #

Wrap the callback into a `GClosure`.

mk_WindowMinimizeCallback :: C_WindowMinimizeCallback -> IO (FunPtr C_WindowMinimizeCallback) Source #

Generate a function pointer callable from C code, from a `C_WindowMinimizeCallback`.

noWindowMinimizeCallback :: Maybe WindowMinimizeCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `WindowMinimizeCallback``.

onWindowMinimize :: (IsWindow a, MonadIO m) => a -> WindowMinimizeCallback -> m SignalHandlerId Source #

Connect a signal handler for the minimize signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on window #minimize callback

wrap_WindowMinimizeCallback :: WindowMinimizeCallback -> C_WindowMinimizeCallback Source #

Wrap a `WindowMinimizeCallback` into a `C_WindowMinimizeCallback`.

## move

type C_WindowMoveCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type WindowMoveCallback = IO () Source #

The signal move is emitted when a window is moved.

Since: 2.2

afterWindowMove :: (IsWindow a, MonadIO m) => a -> WindowMoveCallback -> m SignalHandlerId Source #

Connect a signal handler for the move signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after window #move callback

genClosure_WindowMove :: MonadIO m => WindowMoveCallback -> m (GClosure C_WindowMoveCallback) Source #

Wrap the callback into a `GClosure`.

mk_WindowMoveCallback :: C_WindowMoveCallback -> IO (FunPtr C_WindowMoveCallback) Source #

Generate a function pointer callable from C code, from a `C_WindowMoveCallback`.

noWindowMoveCallback :: Maybe WindowMoveCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `WindowMoveCallback``.

onWindowMove :: (IsWindow a, MonadIO m) => a -> WindowMoveCallback -> m SignalHandlerId Source #

Connect a signal handler for the move signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on window #move callback

wrap_WindowMoveCallback :: WindowMoveCallback -> C_WindowMoveCallback Source #

Wrap a `WindowMoveCallback` into a `C_WindowMoveCallback`.

## resize

type C_WindowResizeCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type WindowResizeCallback = IO () Source #

The signal resize is emitted when a window is resized.

Since: 2.2

afterWindowResize :: (IsWindow a, MonadIO m) => a -> WindowResizeCallback -> m SignalHandlerId Source #

Connect a signal handler for the resize signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after window #resize callback

genClosure_WindowResize :: MonadIO m => WindowResizeCallback -> m (GClosure C_WindowResizeCallback) Source #

Wrap the callback into a `GClosure`.

mk_WindowResizeCallback :: C_WindowResizeCallback -> IO (FunPtr C_WindowResizeCallback) Source #

Generate a function pointer callable from C code, from a `C_WindowResizeCallback`.

noWindowResizeCallback :: Maybe WindowResizeCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `WindowResizeCallback``.

onWindowResize :: (IsWindow a, MonadIO m) => a -> WindowResizeCallback -> m SignalHandlerId Source #

Connect a signal handler for the resize signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on window #resize callback

wrap_WindowResizeCallback :: WindowResizeCallback -> C_WindowResizeCallback Source #

Wrap a `WindowResizeCallback` into a `C_WindowResizeCallback`.

## restore

type C_WindowRestoreCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type WindowRestoreCallback = IO () Source #

The signal restore is emitted when a window is restored.

Since: 2.2

afterWindowRestore :: (IsWindow a, MonadIO m) => a -> WindowRestoreCallback -> m SignalHandlerId Source #

Connect a signal handler for the restore signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after window #restore callback

genClosure_WindowRestore :: MonadIO m => WindowRestoreCallback -> m (GClosure C_WindowRestoreCallback) Source #

Wrap the callback into a `GClosure`.

mk_WindowRestoreCallback :: C_WindowRestoreCallback -> IO (FunPtr C_WindowRestoreCallback) Source #

Generate a function pointer callable from C code, from a `C_WindowRestoreCallback`.

noWindowRestoreCallback :: Maybe WindowRestoreCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `WindowRestoreCallback``.

onWindowRestore :: (IsWindow a, MonadIO m) => a -> WindowRestoreCallback -> m SignalHandlerId Source #

Connect a signal handler for the restore signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on window #restore callback

wrap_WindowRestoreCallback :: WindowRestoreCallback -> C_WindowRestoreCallback Source #

Wrap a `WindowRestoreCallback` into a `C_WindowRestoreCallback`.