GI.Atk.Objects.Object

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 also: ObjectFactory, Registry. (GTK+ users see also GtkAccessible).

Exported types

newtype Object

Memory-managed wrapper type.

Constructors

Object (ManagedPtr Object)

Instances

GObject Object

Defined in GI.Atk.Objects.Object

Methods

gobjectType :: IO GType

HasParentTypes Object

Defined in GI.Atk.Objects.Object

type ParentTypes Object

Defined in GI.Atk.Objects.Object

type ParentTypes Object = Object ': ([] :: [Type])

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

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

Instances

(GObject o, IsDescendantOf Object o) => IsObject o

Defined in GI.Atk.Objects.Object

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

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

noObject :: Maybe Object

A convenience alias for Nothing :: Maybe Object.

Methods

addRelationship

objectAddRelationship

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.

getAttributes

objectGetAttributes

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

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.

getIndexInParent

objectGetIndexInParent

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Arguments

:: (HasCallStack, MonadIO m, IsObject a)

=> a

accessible: an Object

-> Word32

handlerId: a guint which identifies the handler to be removed.

-> m ()

Deprecated: Since 2.12.Removes a property change handler.

No description available in the introspection data.

removeRelationship

objectRemoveRelationship

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.

setDescription

objectSetDescription

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 "".

setName

objectSetName

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

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

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

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

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 ()

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

clear #accessibleDescription

constructObjectAccessibleDescription :: IsObject o => Text -> IO (GValueConstruct o)

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)

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 ()

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

set object [ #accessibleDescription := value ]

accessibleHypertextNlinks

No description available in the introspection data.

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

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

get object #accessibleHypertextNlinks

accessibleName

No description available in the introspection data.

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

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

clear #accessibleName

constructObjectAccessibleName :: IsObject o => Text -> IO (GValueConstruct o)

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)

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 ()

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 ()

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

clear #accessibleParent

constructObjectAccessibleParent :: (IsObject o, IsObject a) => a -> IO (GValueConstruct o)

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)

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 ()

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 => Role -> IO (GValueConstruct o)

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

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 ()

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 ()

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

clear #accessibleTableCaption

constructObjectAccessibleTableCaption :: IsObject o => Text -> IO (GValueConstruct o)

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)

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 ()

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 ()

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, IsObject a) => a -> IO (GValueConstruct o)

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)

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 ()

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 ()

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 => Text -> IO (GValueConstruct o)

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)

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 ()

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 ()

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, IsObject a) => a -> IO (GValueConstruct o)

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)

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 ()

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 ()

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 => Text -> IO (GValueConstruct o)

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)

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 ()

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 ()

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, IsObject a) => a -> IO (GValueConstruct o)

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)

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 ()

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 ()

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

clear #accessibleTableSummary

constructObjectAccessibleTableSummary :: (IsObject o, IsObject a) => a -> IO (GValueConstruct o)

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)

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 ()

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 => Double -> IO (GValueConstruct o)

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

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 ()

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

set object [ #accessibleValue := value ]

Signals

activeDescendantChanged

type C_ObjectActiveDescendantChangedCallback = Ptr () -> Ptr Object -> Ptr () -> IO ()

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

type ObjectActiveDescendantChangedCallback

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 -> ObjectActiveDescendantChangedCallback -> m SignalHandlerId

Connect a signal handler for the “active-descendant-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after object #activeDescendantChanged callback

genClosure_ObjectActiveDescendantChanged :: MonadIO m => ObjectActiveDescendantChangedCallback -> m (GClosure C_ObjectActiveDescendantChangedCallback)

Wrap the callback into a GClosure.

mk_ObjectActiveDescendantChangedCallback :: C_ObjectActiveDescendantChangedCallback -> IO (FunPtr C_ObjectActiveDescendantChangedCallback)

Generate a function pointer callable from C code, from a C_ObjectActiveDescendantChangedCallback.

noObjectActiveDescendantChangedCallback :: Maybe ObjectActiveDescendantChangedCallback

A convenience synonym for Nothing :: Maybe ObjectActiveDescendantChangedCallback.

onObjectActiveDescendantChanged :: (IsObject a, MonadIO m) => a -> ObjectActiveDescendantChangedCallback -> m SignalHandlerId

Connect a signal handler for the “active-descendant-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on object #activeDescendantChanged callback

wrap_ObjectActiveDescendantChangedCallback :: ObjectActiveDescendantChangedCallback -> C_ObjectActiveDescendantChangedCallback

Wrap a ObjectActiveDescendantChangedCallback into a C_ObjectActiveDescendantChangedCallback.

childrenChanged

type C_ObjectChildrenChangedCallback = Ptr () -> Word32 -> Ptr Object -> Ptr () -> IO ()

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

type ObjectChildrenChangedCallback

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 form an object. It supports two details: "add" and "remove"

afterObjectChildrenChanged :: (IsObject a, MonadIO m) => a -> ObjectChildrenChangedCallback -> m SignalHandlerId

Connect a signal handler for the “children-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after object #childrenChanged callback

genClosure_ObjectChildrenChanged :: MonadIO m => ObjectChildrenChangedCallback -> m (GClosure C_ObjectChildrenChangedCallback)

Wrap the callback into a GClosure.

mk_ObjectChildrenChangedCallback :: C_ObjectChildrenChangedCallback -> IO (FunPtr C_ObjectChildrenChangedCallback)

Generate a function pointer callable from C code, from a C_ObjectChildrenChangedCallback.

noObjectChildrenChangedCallback :: Maybe ObjectChildrenChangedCallback

A convenience synonym for Nothing :: Maybe ObjectChildrenChangedCallback.

onObjectChildrenChanged :: (IsObject a, MonadIO m) => a -> ObjectChildrenChangedCallback -> m SignalHandlerId

Connect a signal handler for the “children-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on object #childrenChanged callback

wrap_ObjectChildrenChangedCallback :: ObjectChildrenChangedCallback -> C_ObjectChildrenChangedCallback

Wrap a ObjectChildrenChangedCallback into a C_ObjectChildrenChangedCallback.

focusEvent

type C_ObjectFocusEventCallback = Ptr () -> CInt -> Ptr () -> IO ()

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

type ObjectFocusEventCallback

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::state-change signal instead.

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

afterObjectFocusEvent :: (IsObject a, MonadIO m) => a -> ObjectFocusEventCallback -> m SignalHandlerId

Connect a signal handler for the “focus-event” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after object #focusEvent callback

genClosure_ObjectFocusEvent :: MonadIO m => ObjectFocusEventCallback -> m (GClosure C_ObjectFocusEventCallback)

Wrap the callback into a GClosure.

mk_ObjectFocusEventCallback :: C_ObjectFocusEventCallback -> IO (FunPtr C_ObjectFocusEventCallback)

Generate a function pointer callable from C code, from a C_ObjectFocusEventCallback.

noObjectFocusEventCallback :: Maybe ObjectFocusEventCallback

A convenience synonym for Nothing :: Maybe ObjectFocusEventCallback.

onObjectFocusEvent :: (IsObject a, MonadIO m) => a -> ObjectFocusEventCallback -> m SignalHandlerId

Connect a signal handler for the “focus-event” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on object #focusEvent callback

wrap_ObjectFocusEventCallback :: ObjectFocusEventCallback -> C_ObjectFocusEventCallback

Wrap a ObjectFocusEventCallback into a C_ObjectFocusEventCallback.

propertyChange

type C_ObjectPropertyChangeCallback = Ptr () -> Ptr PropertyValues -> Ptr () -> IO ()

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

type ObjectPropertyChangeCallback

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 -> ObjectPropertyChangeCallback -> m SignalHandlerId

Connect a signal handler for the “property-change” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after object #propertyChange callback

genClosure_ObjectPropertyChange :: MonadIO m => ObjectPropertyChangeCallback -> m (GClosure C_ObjectPropertyChangeCallback)

Wrap the callback into a GClosure.

mk_ObjectPropertyChangeCallback :: C_ObjectPropertyChangeCallback -> IO (FunPtr C_ObjectPropertyChangeCallback)

Generate a function pointer callable from C code, from a C_ObjectPropertyChangeCallback.

noObjectPropertyChangeCallback :: Maybe ObjectPropertyChangeCallback

A convenience synonym for Nothing :: Maybe ObjectPropertyChangeCallback.

onObjectPropertyChange :: (IsObject a, MonadIO m) => a -> ObjectPropertyChangeCallback -> m SignalHandlerId

Connect a signal handler for the “property-change” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on object #propertyChange callback

wrap_ObjectPropertyChangeCallback :: ObjectPropertyChangeCallback -> C_ObjectPropertyChangeCallback

Wrap a ObjectPropertyChangeCallback into a C_ObjectPropertyChangeCallback.

stateChange

type C_ObjectStateChangeCallback = Ptr () -> CString -> CInt -> Ptr () -> IO ()

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

type ObjectStateChangeCallback

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 -> ObjectStateChangeCallback -> m SignalHandlerId

Connect a signal handler for the “state-change” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after object #stateChange callback

genClosure_ObjectStateChange :: MonadIO m => ObjectStateChangeCallback -> m (GClosure C_ObjectStateChangeCallback)

Wrap the callback into a GClosure.

mk_ObjectStateChangeCallback :: C_ObjectStateChangeCallback -> IO (FunPtr C_ObjectStateChangeCallback)

Generate a function pointer callable from C code, from a C_ObjectStateChangeCallback.

noObjectStateChangeCallback :: Maybe ObjectStateChangeCallback

A convenience synonym for Nothing :: Maybe ObjectStateChangeCallback.

onObjectStateChange :: (IsObject a, MonadIO m) => a -> ObjectStateChangeCallback -> m SignalHandlerId

Connect a signal handler for the “state-change” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on object #stateChange callback

wrap_ObjectStateChangeCallback :: ObjectStateChangeCallback -> C_ObjectStateChangeCallback

Wrap a ObjectStateChangeCallback into a C_ObjectStateChangeCallback.

visibleDataChanged

type C_ObjectVisibleDataChangedCallback = Ptr () -> Ptr () -> IO ()

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

type ObjectVisibleDataChangedCallback = IO ()

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

afterObjectVisibleDataChanged :: (IsObject a, MonadIO m) => a -> ObjectVisibleDataChangedCallback -> m SignalHandlerId

Connect a signal handler for the “visible-data-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after object #visibleDataChanged callback

genClosure_ObjectVisibleDataChanged :: MonadIO m => ObjectVisibleDataChangedCallback -> m (GClosure C_ObjectVisibleDataChangedCallback)

Wrap the callback into a GClosure.

mk_ObjectVisibleDataChangedCallback :: C_ObjectVisibleDataChangedCallback -> IO (FunPtr C_ObjectVisibleDataChangedCallback)

Generate a function pointer callable from C code, from a C_ObjectVisibleDataChangedCallback.

noObjectVisibleDataChangedCallback :: Maybe ObjectVisibleDataChangedCallback

A convenience synonym for Nothing :: Maybe ObjectVisibleDataChangedCallback.

onObjectVisibleDataChanged :: (IsObject a, MonadIO m) => a -> ObjectVisibleDataChangedCallback -> m SignalHandlerId

Connect a signal handler for the “visible-data-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on object #visibleDataChanged callback

wrap_ObjectVisibleDataChangedCallback :: ObjectVisibleDataChangedCallback -> C_ObjectVisibleDataChangedCallback

Wrap a ObjectVisibleDataChangedCallback into a C_ObjectVisibleDataChangedCallback.