gi-atk-2.0.27: Atk bindings

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

GI.Atk.Objects.Object

Contents

- Exported types
- Methods
  - addRelationship
  - getAccessibleId
  - getAttributes
  - getDescription
  - getHelpText
  - getIndexInParent
  - getLayer
  - getMdiZorder
  - getNAccessibleChildren
  - getName
  - getObjectLocale
  - getParent
  - getRole
  - initialize
  - notifyStateChange
  - peekParent
  - refAccessibleChild
  - refRelationSet
  - refStateSet
  - removePropertyChangeHandler
  - removeRelationship
  - setAccessibleId
  - setDescription
  - setHelpText
  - setName
  - setParent
  - setRole
- Properties
  - accessibleComponentLayer
  - accessibleComponentMdiZorder
  - accessibleDescription
  - accessibleHelpText
  - accessibleHypertextNlinks
  - accessibleId
  - accessibleName
  - accessibleParent
  - accessibleRole
  - accessibleTableCaption
  - accessibleTableCaptionObject
  - accessibleTableColumnDescription
  - accessibleTableColumnHeader
  - accessibleTableRowDescription
  - accessibleTableRowHeader
  - accessibleTableSummary
  - accessibleValue
- Signals
  - activeDescendantChanged
  - announcement
  - attributeChanged
  - childrenChanged
  - focusEvent
  - notification
  - propertyChange
  - stateChange
  - visibleDataChanged

Description

The base object class for the Accessibility Toolkit API.

This class is the primary class for accessibility support via the Accessibility ToolKit (ATK). Objects which are instances of `Object` (or instances of AtkObject-derived types) are queried for properties which relate basic (and generic) properties of a UI component such as name and description. Instances of `Object` may also be queried as to whether they implement other ATK interfaces (e.g. `Action`, `Component`, etc.), as appropriate to the role which a given UI component plays in a user interface.

All UI components in an application which provide useful information or services to the user must provide corresponding `Object` instances on request (in GTK+, for instance, usually on a call to `gtk_widget_get_accessible` ()), either via ATK support built into the toolkit for the widget class or ancestor class, or in the case of custom widgets, if the inherited `Object` implementation is insufficient, via instances of a new `Object` subclass.

See [class`atkObjectFactory`], [class`atkRegistry`]. (GTK+ users see also `GtkAccessible`).

Synopsis

- newtype Object = Object (ManagedPtr Object)
- class (GObject o, IsDescendantOf Object o) => IsObject o
- toObject :: (MonadIO m, IsObject o) => o -> m Object
- objectAddRelationship :: (HasCallStack, MonadIO m, IsObject a, IsObject b) => a -> RelationType -> b -> m Bool
- objectGetAccessibleId :: (HasCallStack, MonadIO m, IsObject a) => a -> m Text
- objectGetAttributes :: (HasCallStack, MonadIO m, IsObject a) => a -> m [Ptr ()]
- objectGetDescription :: (HasCallStack, MonadIO m, IsObject a) => a -> m Text
- objectGetHelpText :: (HasCallStack, MonadIO m, IsObject a) => a -> m Text
- objectGetIndexInParent :: (HasCallStack, MonadIO m, IsObject a) => a -> m Int32
- objectGetLayer :: (HasCallStack, MonadIO m, IsObject a) => a -> m Layer
- objectGetMdiZorder :: (HasCallStack, MonadIO m, IsObject a) => a -> m Int32
- objectGetNAccessibleChildren :: (HasCallStack, MonadIO m, IsObject a) => a -> m Int32
- objectGetName :: (HasCallStack, MonadIO m, IsObject a) => a -> m Text
- objectGetObjectLocale :: (HasCallStack, MonadIO m, IsObject a) => a -> m Text
- objectGetParent :: (HasCallStack, MonadIO m, IsObject a) => a -> m Object
- objectGetRole :: (HasCallStack, MonadIO m, IsObject a) => a -> m Role
- objectInitialize :: (HasCallStack, MonadIO m, IsObject a) => a -> Ptr () -> m ()
- objectNotifyStateChange :: (HasCallStack, MonadIO m, IsObject a) => a -> Word64 -> Bool -> m ()
- objectPeekParent :: (HasCallStack, MonadIO m, IsObject a) => a -> m Object
- objectRefAccessibleChild :: (HasCallStack, MonadIO m, IsObject a) => a -> Int32 -> m Object
- objectRefRelationSet :: (HasCallStack, MonadIO m, IsObject a) => a -> m RelationSet
- objectRefStateSet :: (HasCallStack, MonadIO m, IsObject a) => a -> m StateSet
- objectRemovePropertyChangeHandler :: (HasCallStack, MonadIO m, IsObject a) => a -> Word32 -> m ()
- objectRemoveRelationship :: (HasCallStack, MonadIO m, IsObject a, IsObject b) => a -> RelationType -> b -> m Bool
- objectSetAccessibleId :: (HasCallStack, MonadIO m, IsObject a) => a -> Text -> m ()
- objectSetDescription :: (HasCallStack, MonadIO m, IsObject a) => a -> Text -> m ()
- objectSetHelpText :: (HasCallStack, MonadIO m, IsObject a) => a -> Text -> m ()
- objectSetName :: (HasCallStack, MonadIO m, IsObject a) => a -> Text -> m ()
- objectSetParent :: (HasCallStack, MonadIO m, IsObject a, IsObject b) => a -> b -> m ()
- objectSetRole :: (HasCallStack, MonadIO m, IsObject a) => a -> Role -> m ()
- getObjectAccessibleComponentLayer :: (MonadIO m, IsObject o) => o -> m Int32
- getObjectAccessibleComponentMdiZorder :: (MonadIO m, IsObject o) => o -> m Int32
- clearObjectAccessibleDescription :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleDescription :: (IsObject o, MonadIO m) => Text -> m (GValueConstruct o)
- getObjectAccessibleDescription :: (MonadIO m, IsObject o) => o -> m (Maybe Text)
- setObjectAccessibleDescription :: (MonadIO m, IsObject o) => o -> Text -> m ()
- clearObjectAccessibleHelpText :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleHelpText :: (IsObject o, MonadIO m) => Text -> m (GValueConstruct o)
- getObjectAccessibleHelpText :: (MonadIO m, IsObject o) => o -> m (Maybe Text)
- setObjectAccessibleHelpText :: (MonadIO m, IsObject o) => o -> Text -> m ()
- getObjectAccessibleHypertextNlinks :: (MonadIO m, IsObject o) => o -> m Int32
- constructObjectAccessibleId :: (IsObject o, MonadIO m) => Text -> m (GValueConstruct o)
- getObjectAccessibleId :: (MonadIO m, IsObject o) => o -> m Text
- setObjectAccessibleId :: (MonadIO m, IsObject o) => o -> Text -> m ()
- clearObjectAccessibleName :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleName :: (IsObject o, MonadIO m) => Text -> m (GValueConstruct o)
- getObjectAccessibleName :: (MonadIO m, IsObject o) => o -> m (Maybe Text)
- setObjectAccessibleName :: (MonadIO m, IsObject o) => o -> Text -> m ()
- clearObjectAccessibleParent :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleParent :: (IsObject o, MonadIO m, IsObject a) => a -> m (GValueConstruct o)
- getObjectAccessibleParent :: (MonadIO m, IsObject o) => o -> m (Maybe Object)
- setObjectAccessibleParent :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m ()
- constructObjectAccessibleRole :: (IsObject o, MonadIO m) => Role -> m (GValueConstruct o)
- getObjectAccessibleRole :: (MonadIO m, IsObject o) => o -> m Role
- setObjectAccessibleRole :: (MonadIO m, IsObject o) => o -> Role -> m ()
- clearObjectAccessibleTableCaption :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleTableCaption :: (IsObject o, MonadIO m) => Text -> m (GValueConstruct o)
- getObjectAccessibleTableCaption :: (MonadIO m, IsObject o) => o -> m (Maybe Text)
- setObjectAccessibleTableCaption :: (MonadIO m, IsObject o) => o -> Text -> m ()
- clearObjectAccessibleTableCaptionObject :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleTableCaptionObject :: (IsObject o, MonadIO m, IsObject a) => a -> m (GValueConstruct o)
- getObjectAccessibleTableCaptionObject :: (MonadIO m, IsObject o) => o -> m (Maybe Object)
- setObjectAccessibleTableCaptionObject :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m ()
- clearObjectAccessibleTableColumnDescription :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleTableColumnDescription :: (IsObject o, MonadIO m) => Text -> m (GValueConstruct o)
- getObjectAccessibleTableColumnDescription :: (MonadIO m, IsObject o) => o -> m (Maybe Text)
- setObjectAccessibleTableColumnDescription :: (MonadIO m, IsObject o) => o -> Text -> m ()
- clearObjectAccessibleTableColumnHeader :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleTableColumnHeader :: (IsObject o, MonadIO m, IsObject a) => a -> m (GValueConstruct o)
- getObjectAccessibleTableColumnHeader :: (MonadIO m, IsObject o) => o -> m (Maybe Object)
- setObjectAccessibleTableColumnHeader :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m ()
- clearObjectAccessibleTableRowDescription :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleTableRowDescription :: (IsObject o, MonadIO m) => Text -> m (GValueConstruct o)
- getObjectAccessibleTableRowDescription :: (MonadIO m, IsObject o) => o -> m (Maybe Text)
- setObjectAccessibleTableRowDescription :: (MonadIO m, IsObject o) => o -> Text -> m ()
- clearObjectAccessibleTableRowHeader :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleTableRowHeader :: (IsObject o, MonadIO m, IsObject a) => a -> m (GValueConstruct o)
- getObjectAccessibleTableRowHeader :: (MonadIO m, IsObject o) => o -> m (Maybe Object)
- setObjectAccessibleTableRowHeader :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m ()
- clearObjectAccessibleTableSummary :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleTableSummary :: (IsObject o, MonadIO m, IsObject a) => a -> m (GValueConstruct o)
- getObjectAccessibleTableSummary :: (MonadIO m, IsObject o) => o -> m (Maybe Object)
- setObjectAccessibleTableSummary :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m ()
- constructObjectAccessibleValue :: (IsObject o, MonadIO m) => Double -> m (GValueConstruct o)
- getObjectAccessibleValue :: (MonadIO m, IsObject o) => o -> m Double
- setObjectAccessibleValue :: (MonadIO m, IsObject o) => o -> Double -> m ()
- type ObjectActiveDescendantChangedCallback = Maybe Object -> IO ()
- afterObjectActiveDescendantChanged :: (IsObject a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ObjectActiveDescendantChangedCallback) -> m SignalHandlerId
- onObjectActiveDescendantChanged :: (IsObject a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ObjectActiveDescendantChangedCallback) -> m SignalHandlerId
- type ObjectAnnouncementCallback = Text -> IO ()
- afterObjectAnnouncement :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectAnnouncementCallback) -> m SignalHandlerId
- onObjectAnnouncement :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectAnnouncementCallback) -> m SignalHandlerId
- type ObjectAttributeChangedCallback = Text -> Text -> IO ()
- afterObjectAttributeChanged :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectAttributeChangedCallback) -> m SignalHandlerId
- onObjectAttributeChanged :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectAttributeChangedCallback) -> m SignalHandlerId
- type ObjectChildrenChangedCallback = Word32 -> Maybe Object -> IO ()
- afterObjectChildrenChanged :: (IsObject a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ObjectChildrenChangedCallback) -> m SignalHandlerId
- onObjectChildrenChanged :: (IsObject a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ObjectChildrenChangedCallback) -> m SignalHandlerId
- type ObjectFocusEventCallback = Bool -> IO ()
- afterObjectFocusEvent :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectFocusEventCallback) -> m SignalHandlerId
- onObjectFocusEvent :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectFocusEventCallback) -> m SignalHandlerId
- type ObjectNotificationCallback = Text -> Int32 -> IO ()
- afterObjectNotification :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectNotificationCallback) -> m SignalHandlerId
- onObjectNotification :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectNotificationCallback) -> m SignalHandlerId
- type ObjectPropertyChangeCallback = Maybe PropertyValues -> IO ()
- afterObjectPropertyChange :: (IsObject a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ObjectPropertyChangeCallback) -> m SignalHandlerId
- onObjectPropertyChange :: (IsObject a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ObjectPropertyChangeCallback) -> m SignalHandlerId
- type ObjectStateChangeCallback = Text -> Bool -> IO ()
- afterObjectStateChange :: (IsObject a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ObjectStateChangeCallback) -> m SignalHandlerId
- onObjectStateChange :: (IsObject a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ObjectStateChangeCallback) -> m SignalHandlerId
- type ObjectVisibleDataChangedCallback = IO ()
- afterObjectVisibleDataChanged :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectVisibleDataChangedCallback) -> m SignalHandlerId
- onObjectVisibleDataChanged :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectVisibleDataChangedCallback) -> m SignalHandlerId

# Exported types

newtype Object Source #

Memory-managed wrapper type.

Constructors

Object (ManagedPtr Object) |

#### Instances

Instances details

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

class (GObject o, IsDescendantOf Object o) => IsObject o Source #

Type class for types which can be safely cast to `Object`, for instance with `toObject`.

#### Instances

Instances details

(GObject o, IsDescendantOf Object o) => IsObject o Source # |
Instance details Defined in GI.Atk.Objects.Object

toObject :: (MonadIO m, IsObject o) => o -> m Object Source #

Cast to `Object`, 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.

## addRelationship

objectAddRelationship Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a, IsObject b) |
=> a | `object`: The `Object` to which an AtkRelation is to be added.
-> RelationType | `relationship`: The `RelationType` of the relation
-> b | `target`: The `Object` which is to be the target of the relation.
-> m Bool | Returns: TRUE if the relationship is added.

Adds a relationship of the specified type with the specified target.

## getAccessibleId

objectGetAccessibleId Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> m Text | Returns: a character string representing the accessible id of the object, or NULL if no such string was set.

Gets the accessible id of the accessible.

Since: 2.34

## getAttributes

objectGetAttributes Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: An `Object`.
-> m [Ptr ()] | Returns: an `AtkAttributeSet` consisting of all explicit properties/annotations applied to the object, or an empty set if the object has no name-value pair attributes assigned to it. This `atkattributeset` should be freed by a call to `attributeSetFree`.

Get a list of properties applied to this object as a whole, as an `AtkAttributeSet` consisting of name-value pairs. As such these attributes may be considered weakly-typed properties or annotations, as distinct from strongly-typed object data available via other get/set methods. Not all objects have explicit "name-value pair" `AtkAttributeSet` properties.

Since: 1.12

## getDescription

objectGetDescription Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> m Text | Returns: a character string representing the accessible description of the accessible.

Gets the accessible description of the accessible.

## getHelpText

objectGetHelpText Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> m Text | Returns: a character string representing the help text or the object, or NULL if no such string was set.

Gets the help text associated with the accessible.

Since: 2.52

## getIndexInParent

objectGetIndexInParent Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> m Int32 | Returns: an integer which is the index of the accessible in its parent

Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.

## getLayer

objectGetLayer Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> m Layer | Returns: an `Layer` which is the layer of the accessible

Deprecated: Use atk_component_get_layer instead.

Gets the layer of the accessible.

## getMdiZorder

objectGetMdiZorder Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> m Int32 | Returns: a gint which is the zorder of the accessible, i.e. the depth at which the component is shown in relation to other components in the same container.

Deprecated: Use atk_component_get_mdi_zorder instead.

Gets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not ATK_LAYER_MDI.

## getNAccessibleChildren

objectGetNAccessibleChildren Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> m Int32 | Returns: an integer representing the number of accessible children of the accessible.

Gets the number of accessible children of the accessible.

## getName

objectGetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> m Text | Returns: a character string representing the accessible name of the object.

Gets the accessible name of the accessible.

## getObjectLocale

objectGetObjectLocale Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> m Text | Returns: a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of `accessible`.

Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of `accessible`.

Since: 2.8

## getParent

objectGetParent Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> m Object | Returns: an `Object` representing the accessible parent of the accessible

Gets the accessible parent of the accessible. By default this is the one assigned with `objectSetParent`, but it is assumed that ATK implementors have ways to get the parent of the object without the need of assigning it manually with `objectSetParent`, and will return it with this method.

If you are only interested on the parent assigned with `objectSetParent`, use `objectPeekParent`.

## getRole

objectGetRole Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> m Role | Returns: an `Role` which is the role of the accessible

Gets the role of the accessible.

## initialize

objectInitialize Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: a `Object`
-> Ptr () | `data`: a `gpointer` which identifies the object for which the AtkObject was created.
-> m () |

This function is called when implementing subclasses of `Object`. It does initialization required for the new object. It is intended that this function should called only in the ...`_new()` functions used to create an instance of a subclass of `Object`

## notifyStateChange

objectNotifyStateChange Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> Word64 | `state`: an `AtkState` whose state is changed
-> Bool | `value`: a gboolean which indicates whether the state is being set on or off
-> m () |

Emits a state-change signal for the specified state.

Note that as a general rule when the state of an existing object changes, emitting a notification is expected.

## peekParent

objectPeekParent Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> m Object | Returns: an `Object` representing the accessible parent of the accessible if assigned

Gets the accessible parent of the accessible, if it has been manually assigned with atk_object_set_parent. Otherwise, this function returns `Nothing`.

This method is intended as an utility for ATK implementors, and not to be exposed to accessible tools. See `objectGetParent` for further reference.

## refAccessibleChild

objectRefAccessibleChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> Int32 | `i`: a gint representing the position of the child, starting from 0
-> m Object | Returns: an `Object` representing the specified accessible child of the accessible.

Gets a reference to the specified accessible child of the object. The accessible children are 0-based so the first accessible child is at index 0, the second at index 1 and so on.

## refRelationSet

objectRefRelationSet Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> m RelationSet | Returns: an `RelationSet` representing the relation set of the object.

Gets the `RelationSet` associated with the object.

## refStateSet

objectRefStateSet Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> m StateSet | Returns: a reference to an `StateSet` which is the state set of the accessible

Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed.

## removePropertyChangeHandler

objectRemovePropertyChangeHandler Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> Word32 | `handlerId`: a guint which identifies the handler to be removed.
-> m () |

Deprecated: (Since version 2.12)See `atk_object_connect_property_change_handler()`

Removes a property change handler.

## removeRelationship

objectRemoveRelationship Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a, IsObject b) |
=> a | `object`: The `Object` from which an AtkRelation is to be removed.
-> RelationType | `relationship`: The `RelationType` of the relation
-> b | `target`: The `Object` which is the target of the relation to be removed.
-> m Bool | Returns: TRUE if the relationship is removed.

Removes a relationship of the specified type with the specified target.

## setAccessibleId

objectSetAccessibleId Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> Text | `id`: a character string to be set as the accessible id
-> m () |

Sets the accessible ID of the accessible. This is not meant to be presented to the user, but to be an ID which is stable over application development. Typically, this is the gtkbuilder ID. Such an ID will be available for instance to identify a given well-known accessible object for tailored screen reading, or for automatic regression testing.

Since: 2.34

## setDescription

objectSetDescription Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> Text | `description`: a character string to be set as the accessible description
-> m () |

Sets the accessible description of the accessible. You can't set the description to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "".

## setHelpText

objectSetHelpText Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> Text | `helpText`: a character string to be set as the accessible's help text
-> m () |

Sets the help text associated with the accessible. This can be used to expose context-sensitive information to help a user understand how to interact with the object.

Since: 2.52

## setName

objectSetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> Text | `name`: a character string to be set as the accessible name
-> m () |

Sets the accessible name of the accessible. You can't set the name to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "".

## setParent

objectSetParent Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a, IsObject b) |
=> a | `accessible`: an `Object`
-> b | `parent`: an `Object` to be set as the accessible parent
-> m () |

Sets the accessible parent of the accessible. `parent` can be NULL.

## setRole

objectSetRole Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) |
=> a | `accessible`: an `Object`
-> Role | `role`: an `Role` to be set as the role
-> m () |

Sets the role of the accessible.

# Properties

## accessibleComponentLayer

No description available in the introspection data.

getObjectAccessibleComponentLayer :: (MonadIO m, IsObject o) => o -> m Int32 Source #

Get the value of the “`accessible-component-layer`” property. When overloading is enabled, this is equivalent to

    get object #accessibleComponentLayer

## accessibleComponentMdiZorder

No description available in the introspection data.

getObjectAccessibleComponentMdiZorder :: (MonadIO m, IsObject o) => o -> m Int32 Source #

Get the value of the “`accessible-component-mdi-zorder`” property. When overloading is enabled, this is equivalent to

    get object #accessibleComponentMdiZorder

## accessibleDescription

No description available in the introspection data.

clearObjectAccessibleDescription :: (MonadIO m, IsObject o) => o -> m () Source #

Set the value of the “`accessible-description`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #accessibleDescription

constructObjectAccessibleDescription :: (IsObject o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`accessible-description`” property. This is rarely needed directly, but it is used by `new`.

getObjectAccessibleDescription :: (MonadIO m, IsObject o) => o -> m (Maybe Text) Source #

Get the value of the “`accessible-description`” property. When overloading is enabled, this is equivalent to

    get object #accessibleDescription

setObjectAccessibleDescription :: (MonadIO m, IsObject o) => o -> Text -> m () Source #

Set the value of the “`accessible-description`” property. When overloading is enabled, this is equivalent to

    set object [ #accessibleDescription := value ]

## accessibleHelpText

No description available in the introspection data.

clearObjectAccessibleHelpText :: (MonadIO m, IsObject o) => o -> m () Source #

Set the value of the “`accessible-help-text`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #accessibleHelpText

constructObjectAccessibleHelpText :: (IsObject o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`accessible-help-text`” property. This is rarely needed directly, but it is used by `new`.

getObjectAccessibleHelpText :: (MonadIO m, IsObject o) => o -> m (Maybe Text) Source #

Get the value of the “`accessible-help-text`” property. When overloading is enabled, this is equivalent to

    get object #accessibleHelpText

setObjectAccessibleHelpText :: (MonadIO m, IsObject o) => o -> Text -> m () Source #

Set the value of the “`accessible-help-text`” property. When overloading is enabled, this is equivalent to

    set object [ #accessibleHelpText := value ]

## accessibleHypertextNlinks

No description available in the introspection data.

getObjectAccessibleHypertextNlinks :: (MonadIO m, IsObject o) => o -> m Int32 Source #

Get the value of the “`accessible-hypertext-nlinks`” property. When overloading is enabled, this is equivalent to

    get object #accessibleHypertextNlinks

## accessibleId

No description available in the introspection data.

constructObjectAccessibleId :: (IsObject o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`accessible-id`” property. This is rarely needed directly, but it is used by `new`.

getObjectAccessibleId :: (MonadIO m, IsObject o) => o -> m Text Source #

Get the value of the “`accessible-id`” property. When overloading is enabled, this is equivalent to

    get object #accessibleId

setObjectAccessibleId :: (MonadIO m, IsObject o) => o -> Text -> m () Source #

Set the value of the “`accessible-id`” property. When overloading is enabled, this is equivalent to

    set object [ #accessibleId := value ]

## accessibleName

No description available in the introspection data.

clearObjectAccessibleName :: (MonadIO m, IsObject o) => o -> m () Source #

Set the value of the “`accessible-name`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #accessibleName

constructObjectAccessibleName :: (IsObject o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`accessible-name`” property. This is rarely needed directly, but it is used by `new`.

getObjectAccessibleName :: (MonadIO m, IsObject o) => o -> m (Maybe Text) Source #

Get the value of the “`accessible-name`” property. When overloading is enabled, this is equivalent to

    get object #accessibleName

setObjectAccessibleName :: (MonadIO m, IsObject o) => o -> Text -> m () Source #

Set the value of the “`accessible-name`” property. When overloading is enabled, this is equivalent to

    set object [ #accessibleName := value ]

## accessibleParent

No description available in the introspection data.

clearObjectAccessibleParent :: (MonadIO m, IsObject o) => o -> m () Source #

Set the value of the “`accessible-parent`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #accessibleParent

constructObjectAccessibleParent :: (IsObject o, MonadIO m, IsObject a) => a -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`accessible-parent`” property. This is rarely needed directly, but it is used by `new`.

getObjectAccessibleParent :: (MonadIO m, IsObject o) => o -> m (Maybe Object) Source #

Get the value of the “`accessible-parent`” property. When overloading is enabled, this is equivalent to

    get object #accessibleParent

setObjectAccessibleParent :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m () Source #

Set the value of the “`accessible-parent`” property. When overloading is enabled, this is equivalent to

    set object [ #accessibleParent := value ]

## accessibleRole

No description available in the introspection data.

constructObjectAccessibleRole :: (IsObject o, MonadIO m) => Role -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`accessible-role`” property. This is rarely needed directly, but it is used by `new`.

getObjectAccessibleRole :: (MonadIO m, IsObject o) => o -> m Role Source #

Get the value of the “`accessible-role`” property. When overloading is enabled, this is equivalent to

    get object #accessibleRole

setObjectAccessibleRole :: (MonadIO m, IsObject o) => o -> Role -> m () Source #

Set the value of the “`accessible-role`” property. When overloading is enabled, this is equivalent to

    set object [ #accessibleRole := value ]

## accessibleTableCaption

Table caption.

clearObjectAccessibleTableCaption :: (MonadIO m, IsObject o) => o -> m () Source #

Set the value of the “`accessible-table-caption`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #accessibleTableCaption

constructObjectAccessibleTableCaption :: (IsObject o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`accessible-table-caption`” property. This is rarely needed directly, but it is used by `new`.

getObjectAccessibleTableCaption :: (MonadIO m, IsObject o) => o -> m (Maybe Text) Source #

Get the value of the “`accessible-table-caption`” property. When overloading is enabled, this is equivalent to

    get object #accessibleTableCaption

setObjectAccessibleTableCaption :: (MonadIO m, IsObject o) => o -> Text -> m () Source #

Set the value of the “`accessible-table-caption`” property. When overloading is enabled, this is equivalent to

    set object [ #accessibleTableCaption := value ]

## accessibleTableCaptionObject

No description available in the introspection data.

clearObjectAccessibleTableCaptionObject :: (MonadIO m, IsObject o) => o -> m () Source #

Set the value of the “`accessible-table-caption-object`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #accessibleTableCaptionObject

constructObjectAccessibleTableCaptionObject :: (IsObject o, MonadIO m, IsObject a) => a -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`accessible-table-caption-object`” property. This is rarely needed directly, but it is used by `new`.

getObjectAccessibleTableCaptionObject :: (MonadIO m, IsObject o) => o -> m (Maybe Object) Source #

Get the value of the “`accessible-table-caption-object`” property. When overloading is enabled, this is equivalent to

    get object #accessibleTableCaptionObject

setObjectAccessibleTableCaptionObject :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m () Source #

Set the value of the “`accessible-table-caption-object`” property. When overloading is enabled, this is equivalent to

    set object [ #accessibleTableCaptionObject := value ]

## accessibleTableColumnDescription

Accessible table column description.

clearObjectAccessibleTableColumnDescription :: (MonadIO m, IsObject o) => o -> m () Source #

Set the value of the “`accessible-table-column-description`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #accessibleTableColumnDescription

constructObjectAccessibleTableColumnDescription :: (IsObject o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`accessible-table-column-description`” property. This is rarely needed directly, but it is used by `new`.

getObjectAccessibleTableColumnDescription :: (MonadIO m, IsObject o) => o -> m (Maybe Text) Source #

Get the value of the “`accessible-table-column-description`” property. When overloading is enabled, this is equivalent to

    get object #accessibleTableColumnDescription

setObjectAccessibleTableColumnDescription :: (MonadIO m, IsObject o) => o -> Text -> m () Source #

Set the value of the “`accessible-table-column-description`” property. When overloading is enabled, this is equivalent to

    set object [ #accessibleTableColumnDescription := value ]

## accessibleTableColumnHeader

Accessible table column header.

clearObjectAccessibleTableColumnHeader :: (MonadIO m, IsObject o) => o -> m () Source #

Set the value of the “`accessible-table-column-header`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #accessibleTableColumnHeader

constructObjectAccessibleTableColumnHeader :: (IsObject o, MonadIO m, IsObject a) => a -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`accessible-table-column-header`” property. This is rarely needed directly, but it is used by `new`.

getObjectAccessibleTableColumnHeader :: (MonadIO m, IsObject o) => o -> m (Maybe Object) Source #

Get the value of the “`accessible-table-column-header`” property. When overloading is enabled, this is equivalent to

    get object #accessibleTableColumnHeader

setObjectAccessibleTableColumnHeader :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m () Source #

Set the value of the “`accessible-table-column-header`” property. When overloading is enabled, this is equivalent to

    set object [ #accessibleTableColumnHeader := value ]

## accessibleTableRowDescription

Accessible table row description.

clearObjectAccessibleTableRowDescription :: (MonadIO m, IsObject o) => o -> m () Source #

Set the value of the “`accessible-table-row-description`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #accessibleTableRowDescription

constructObjectAccessibleTableRowDescription :: (IsObject o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`accessible-table-row-description`” property. This is rarely needed directly, but it is used by `new`.

getObjectAccessibleTableRowDescription :: (MonadIO m, IsObject o) => o -> m (Maybe Text) Source #

Get the value of the “`accessible-table-row-description`” property. When overloading is enabled, this is equivalent to

    get object #accessibleTableRowDescription

setObjectAccessibleTableRowDescription :: (MonadIO m, IsObject o) => o -> Text -> m () Source #

Set the value of the “`accessible-table-row-description`” property. When overloading is enabled, this is equivalent to

    set object [ #accessibleTableRowDescription := value ]

## accessibleTableRowHeader

Accessible table row header.

clearObjectAccessibleTableRowHeader :: (MonadIO m, IsObject o) => o -> m () Source #

Set the value of the “`accessible-table-row-header`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #accessibleTableRowHeader

constructObjectAccessibleTableRowHeader :: (IsObject o, MonadIO m, IsObject a) => a -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`accessible-table-row-header`” property. This is rarely needed directly, but it is used by `new`.

getObjectAccessibleTableRowHeader :: (MonadIO m, IsObject o) => o -> m (Maybe Object) Source #

Get the value of the “`accessible-table-row-header`” property. When overloading is enabled, this is equivalent to

    get object #accessibleTableRowHeader

setObjectAccessibleTableRowHeader :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m () Source #

Set the value of the “`accessible-table-row-header`” property. When overloading is enabled, this is equivalent to

    set object [ #accessibleTableRowHeader := value ]

## accessibleTableSummary

No description available in the introspection data.

clearObjectAccessibleTableSummary :: (MonadIO m, IsObject o) => o -> m () Source #

Set the value of the “`accessible-table-summary`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #accessibleTableSummary

constructObjectAccessibleTableSummary :: (IsObject o, MonadIO m, IsObject a) => a -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`accessible-table-summary`” property. This is rarely needed directly, but it is used by `new`.

getObjectAccessibleTableSummary :: (MonadIO m, IsObject o) => o -> m (Maybe Object) Source #

Get the value of the “`accessible-table-summary`” property. When overloading is enabled, this is equivalent to

    get object #accessibleTableSummary

setObjectAccessibleTableSummary :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m () Source #

Set the value of the “`accessible-table-summary`” property. When overloading is enabled, this is equivalent to

    set object [ #accessibleTableSummary := value ]

## accessibleValue

Numeric value of this object, in case being and AtkValue.

constructObjectAccessibleValue :: (IsObject o, MonadIO m) => Double -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`accessible-value`” property. This is rarely needed directly, but it is used by `new`.

getObjectAccessibleValue :: (MonadIO m, IsObject o) => o -> m Double Source #

Get the value of the “`accessible-value`” property. When overloading is enabled, this is equivalent to

    get object #accessibleValue

setObjectAccessibleValue :: (MonadIO m, IsObject o) => o -> Double -> m () Source #

Set the value of the “`accessible-value`” property. When overloading is enabled, this is equivalent to

    set object [ #accessibleValue := value ]

# Signals

## activeDescendantChanged

type ObjectActiveDescendantChangedCallback Source #

Arguments

= Maybe Object | `arg1`: the newly focused object.
-> IO () |

The "active-descendant-changed" signal is emitted by an object which has the state ATK_STATE_MANAGES_DESCENDANTS when the focus object in the object changes. For instance, a table will emit the signal when the cell in the table which has focus changes.

afterObjectActiveDescendantChanged :: (IsObject a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ObjectActiveDescendantChangedCallback) -> m SignalHandlerId Source #

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

    after object #activeDescendantChanged callback

This signal admits a optional parameter `detail`. If it's not `Nothing`, we will connect to “`active-descendant-changed::detail`” instead.

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.

onObjectActiveDescendantChanged :: (IsObject a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ObjectActiveDescendantChangedCallback) -> m SignalHandlerId Source #

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

    on object #activeDescendantChanged callback

This signal admits a optional parameter `detail`. If it's not `Nothing`, we will connect to “`active-descendant-changed::detail`” instead.

## announcement

type ObjectAnnouncementCallback Source #

Arguments

= Text | `arg1`: the text to be announced.
-> IO () |

The "announcement" signal can be emitted to pass an announcement on to be read by a screen reader.

Depcrecated (2.50): Use AtkObjectnotification instead.

Since: 2.46

afterObjectAnnouncement :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectAnnouncementCallback) -> m SignalHandlerId Source #

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

    after object #announcement 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.

onObjectAnnouncement :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectAnnouncementCallback) -> m SignalHandlerId Source #

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

    on object #announcement callback

## attributeChanged

type ObjectAttributeChangedCallback Source #

Arguments

= Text | `arg1`: the name of the attribute being modified, or `Nothing` if not available.
-> Text | `arg2`: the attribute's new value, or `null` if not available.
-> IO () |

The "attribute-changed" signal should be emitted when one of an object's attributes changes.

Since: 2.52

afterObjectAttributeChanged :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectAttributeChangedCallback) -> m SignalHandlerId Source #

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

    after object #attributeChanged 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.

onObjectAttributeChanged :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectAttributeChangedCallback) -> m SignalHandlerId Source #

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

    on object #attributeChanged callback

## childrenChanged

type ObjectChildrenChangedCallback Source #

Arguments

= Word32 | `arg1`: The index of the added or removed child. The value can be -1. This is used if the value is not known by the implementor when the child is added/removed or irrelevant.
-> Maybe Object | `arg2`: A gpointer to the child AtkObject which was added or removed. If the child was removed, it is possible that it is not available for the implementor. In that case this pointer can be NULL.
-> IO () |

The signal "children-changed" is emitted when a child is added or removed from an object. It supports two details: "add" and "remove"

afterObjectChildrenChanged :: (IsObject a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ObjectChildrenChangedCallback) -> m SignalHandlerId Source #

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

    after object #childrenChanged callback

This signal admits a optional parameter `detail`. If it's not `Nothing`, we will connect to “`children-changed::detail`” instead.

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.

onObjectChildrenChanged :: (IsObject a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ObjectChildrenChangedCallback) -> m SignalHandlerId Source #

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

    on object #childrenChanged callback

This signal admits a optional parameter `detail`. If it's not `Nothing`, we will connect to “`children-changed::detail`” instead.

## focusEvent

type ObjectFocusEventCallback Source #

Arguments

= Bool | `arg1`: a boolean value which indicates whether the object gained or lost focus.
-> IO () |

Deprecated: (Since version 2.9.4)Use the Object::stateChange signal instead.

The signal "focus-event" is emitted when an object gained or lost focus.

afterObjectFocusEvent :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectFocusEventCallback) -> m SignalHandlerId Source #

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

    after object #focusEvent 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.

onObjectFocusEvent :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectFocusEventCallback) -> m SignalHandlerId Source #

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

    on object #focusEvent callback

## notification

type ObjectNotificationCallback Source #

Arguments

= Text | `arg1`: the text to be announced.
-> Int32 | `arg2`: an `Live` specifying the politeness of the notification. Should be either ATK_LIVE_POLITE or ATK_LIVE_ASSERTIVE.
-> IO () |

The "notification" signal can be emitted to pass an announcement on to be read by a screen reader.

Since: 2.50

afterObjectNotification :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectNotificationCallback) -> m SignalHandlerId Source #

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

    after object #notification 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.

onObjectNotification :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectNotificationCallback) -> m SignalHandlerId Source #

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

    on object #notification callback

## propertyChange

type ObjectPropertyChangeCallback Source #

Arguments

= Maybe PropertyValues | `arg1`: an `PropertyValues` containing the new value of the property which changed.
-> IO () |

The signal "property-change" is emitted when an object's property value changes. `arg1` contains an `PropertyValues` with the name and the new value of the property whose value has changed. Note that, as with GObject notify, getting this signal does not guarantee that the value of the property has actually changed; it may also be emitted when the setter of the property is called to reinstate the previous value.

Toolkit implementor note: ATK implementors should use `objectNotify` to emit property-changed notifications. `Object`::`property-changed` is needed by the implementation of `atk_add_global_event_listener()` because GObject notify doesn't support emission hooks.

afterObjectPropertyChange :: (IsObject a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ObjectPropertyChangeCallback) -> m SignalHandlerId Source #

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

    after object #propertyChange callback

This signal admits a optional parameter `detail`. If it's not `Nothing`, we will connect to “`property-change::detail`” instead.

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.

onObjectPropertyChange :: (IsObject a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ObjectPropertyChangeCallback) -> m SignalHandlerId Source #

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

    on object #propertyChange callback

This signal admits a optional parameter `detail`. If it's not `Nothing`, we will connect to “`property-change::detail`” instead.

## stateChange

type ObjectStateChangeCallback Source #

Arguments

= Text | `arg1`: The name of the state which has changed
-> Bool | `arg2`: A boolean which indicates whether the state has been set or unset.
-> IO () |

The "state-change" signal is emitted when an object's state changes. The detail value identifies the state type which has changed.

afterObjectStateChange :: (IsObject a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ObjectStateChangeCallback) -> m SignalHandlerId Source #

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

    after object #stateChange callback

This signal admits a optional parameter `detail`. If it's not `Nothing`, we will connect to “`state-change::detail`” instead.

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.

onObjectStateChange :: (IsObject a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ObjectStateChangeCallback) -> m SignalHandlerId Source #

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

    on object #stateChange callback

This signal admits a optional parameter `detail`. If it's not `Nothing`, we will connect to “`state-change::detail`” instead.

## visibleDataChanged

type ObjectVisibleDataChangedCallback = IO () Source #

The "visible-data-changed" signal is emitted when the visual appearance of the object changed.

afterObjectVisibleDataChanged :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectVisibleDataChangedCallback) -> m SignalHandlerId Source #

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

    after object #visibleDataChanged 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.

onObjectVisibleDataChanged :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectVisibleDataChangedCallback) -> m SignalHandlerId Source #

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

    on object #visibleDataChanged callback