gi-atk-2.0.28: Atk bindings

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

GI.Atk.Interfaces.Window

Contents

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

Description

The ATK Interface provided by UI components that represent a top-level window.

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

See [class`atkObject`]

Synopsis

- newtype Window = Window (ManagedPtr Window)
- class (GObject o, IsDescendantOf Window o) => IsWindow o
- toWindow :: (MonadIO m, IsWindow o) => o -> m Window
- type WindowActivateCallback = IO ()
- afterWindowActivate :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowActivateCallback) -> m SignalHandlerId
- onWindowActivate :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowActivateCallback) -> m SignalHandlerId
- type WindowCreateCallback = IO ()
- afterWindowCreate :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowCreateCallback) -> m SignalHandlerId
- onWindowCreate :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowCreateCallback) -> m SignalHandlerId
- type WindowDeactivateCallback = IO ()
- afterWindowDeactivate :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowDeactivateCallback) -> m SignalHandlerId
- onWindowDeactivate :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowDeactivateCallback) -> m SignalHandlerId
- type WindowDestroyCallback = IO ()
- afterWindowDestroy :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowDestroyCallback) -> m SignalHandlerId
- onWindowDestroy :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowDestroyCallback) -> m SignalHandlerId
- type WindowMaximizeCallback = IO ()
- afterWindowMaximize :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowMaximizeCallback) -> m SignalHandlerId
- onWindowMaximize :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowMaximizeCallback) -> m SignalHandlerId
- type WindowMinimizeCallback = IO ()
- afterWindowMinimize :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowMinimizeCallback) -> m SignalHandlerId
- onWindowMinimize :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowMinimizeCallback) -> m SignalHandlerId
- type WindowMoveCallback = IO ()
- afterWindowMove :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowMoveCallback) -> m SignalHandlerId
- onWindowMove :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowMoveCallback) -> m SignalHandlerId
- type WindowResizeCallback = IO ()
- afterWindowResize :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowResizeCallback) -> m SignalHandlerId
- onWindowResize :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowResizeCallback) -> m SignalHandlerId
- type WindowRestoreCallback = IO ()
- afterWindowRestore :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowRestoreCallback) -> m SignalHandlerId
- onWindowRestore :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowRestoreCallback) -> m SignalHandlerId

# 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 Source # (/=) :: Window -> Window -> Bool Source #
GObject Window Source # |
Instance details Defined in GI.Atk.Interfaces.Window
ManagedPtrNewtype Window Source # |
Instance details Defined in GI.Atk.Interfaces.Window Methods toManagedPtr :: Window -> ManagedPtr Window Source #
TypedObject Window Source # |
Instance details Defined in GI.Atk.Interfaces.Window Methods glibType :: IO GType Source #
HasParentTypes Window Source # |
Instance details Defined in GI.Atk.Interfaces.Window
IsGValue (Maybe Window) Source # | Convert `Window` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Atk.Interfaces.Window Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe Window -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe Window) Source #
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

### Click to display all available methods, including inherited ones

Expand

#### Methods

addRelationship, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, initialize, isFloating, notify, notifyByPspec, notifyStateChange, peekParent, ref, refAccessibleChild, refRelationSet, refSink, refStateSet, removePropertyChangeHandler, removeRelationship, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

#### Getters

getAccessibleId, getAttributes, getData, getDescription, getHelpText, getIndexInParent, getLayer, getMdiZorder, getNAccessibleChildren, getName, getObjectLocale, getParent, getProperty, getQdata, getRole.

#### Setters

setAccessibleId, setData, setDataFull, setDescription, setHelpText, setName, setParent, setProperty, setRole.

# Signals

## activate

type WindowActivateCallback = IO () Source #

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

Since: 2.2

afterWindowActivate :: (IsWindow a, MonadIO m) => a -> ((?self :: 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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onWindowActivate :: (IsWindow a, MonadIO m) => a -> ((?self :: 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

## create

type WindowCreateCallback = IO () Source #

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

Since: 2.2

afterWindowCreate :: (IsWindow a, MonadIO m) => a -> ((?self :: 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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onWindowCreate :: (IsWindow a, MonadIO m) => a -> ((?self :: 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

## deactivate

type WindowDeactivateCallback = IO () Source #

The signal Window::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 -> ((?self :: 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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onWindowDeactivate :: (IsWindow a, MonadIO m) => a -> ((?self :: 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

## destroy

type WindowDestroyCallback = IO () Source #

The signal Window::destroy is emitted when a window is destroyed.

Since: 2.2

afterWindowDestroy :: (IsWindow a, MonadIO m) => a -> ((?self :: 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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onWindowDestroy :: (IsWindow a, MonadIO m) => a -> ((?self :: 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

## maximize

type WindowMaximizeCallback = IO () Source #

The signal Window::maximize is emitted when a window is maximized.

Since: 2.2

afterWindowMaximize :: (IsWindow a, MonadIO m) => a -> ((?self :: 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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onWindowMaximize :: (IsWindow a, MonadIO m) => a -> ((?self :: 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

## minimize

type WindowMinimizeCallback = IO () Source #

The signal Window::minimize is emitted when a window is minimized.

Since: 2.2

afterWindowMinimize :: (IsWindow a, MonadIO m) => a -> ((?self :: 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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onWindowMinimize :: (IsWindow a, MonadIO m) => a -> ((?self :: 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

## move

type WindowMoveCallback = IO () Source #

The signal Window::move is emitted when a window is moved.

Since: 2.2

afterWindowMove :: (IsWindow a, MonadIO m) => a -> ((?self :: 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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onWindowMove :: (IsWindow a, MonadIO m) => a -> ((?self :: 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

## resize

type WindowResizeCallback = IO () Source #

The signal Window::resize is emitted when a window is resized.

Since: 2.2

afterWindowResize :: (IsWindow a, MonadIO m) => a -> ((?self :: 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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onWindowResize :: (IsWindow a, MonadIO m) => a -> ((?self :: 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

## restore

type WindowRestoreCallback = IO () Source #

The signal Window::restore is emitted when a window is restored.

Since: 2.2

afterWindowRestore :: (IsWindow a, MonadIO m) => a -> ((?self :: 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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onWindowRestore :: (IsWindow a, MonadIO m) => a -> ((?self :: 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