Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
GI.Atk.Objects.Object
Contents
- Exported types
- Methods
- addRelationship
- getAttributes
- getDescription
- getIndexInParent
- getLayer
- getMdiZorder
- getNAccessibleChildren
- getName
- getObjectLocale
- getParent
- getRole
- initialize
- notifyStateChange
- peekParent
- refAccessibleChild
- refRelationSet
- refStateSet
- removePropertyChangeHandler
- removeRelationship
- setDescription
- setName
- setParent
- setRole
- Properties
- accessibleComponentLayer
- accessibleComponentMdiZorder
- accessibleDescription
- accessibleHypertextNlinks
- accessibleName
- accessibleParent
- accessibleRole
- accessibleTableCaption
- accessibleTableCaptionObject
- accessibleTableColumnDescription
- accessibleTableColumnHeader
- accessibleTableRowDescription
- accessibleTableRowHeader
- accessibleTableSummary
- accessibleValue
- Signals
Description
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
).
- newtype Object = Object (ManagedPtr Object)
- class GObject o => IsObject o
- toObject :: (MonadIO m, IsObject o) => o -> m Object
- noObject :: Maybe Object
- data ObjectAddRelationshipMethodInfo
- objectAddRelationship :: (HasCallStack, MonadIO m, IsObject a, IsObject b) => a -> RelationType -> b -> m Bool
- data ObjectGetAttributesMethodInfo
- objectGetAttributes :: (HasCallStack, MonadIO m, IsObject a) => a -> m [Ptr ()]
- data ObjectGetDescriptionMethodInfo
- objectGetDescription :: (HasCallStack, MonadIO m, IsObject a) => a -> m Text
- data ObjectGetIndexInParentMethodInfo
- objectGetIndexInParent :: (HasCallStack, MonadIO m, IsObject a) => a -> m Int32
- data ObjectGetLayerMethodInfo
- objectGetLayer :: (HasCallStack, MonadIO m, IsObject a) => a -> m Layer
- data ObjectGetMdiZorderMethodInfo
- objectGetMdiZorder :: (HasCallStack, MonadIO m, IsObject a) => a -> m Int32
- data ObjectGetNAccessibleChildrenMethodInfo
- objectGetNAccessibleChildren :: (HasCallStack, MonadIO m, IsObject a) => a -> m Int32
- data ObjectGetNameMethodInfo
- objectGetName :: (HasCallStack, MonadIO m, IsObject a) => a -> m Text
- data ObjectGetObjectLocaleMethodInfo
- objectGetObjectLocale :: (HasCallStack, MonadIO m, IsObject a) => a -> m Text
- data ObjectGetParentMethodInfo
- objectGetParent :: (HasCallStack, MonadIO m, IsObject a) => a -> m Object
- data ObjectGetRoleMethodInfo
- objectGetRole :: (HasCallStack, MonadIO m, IsObject a) => a -> m Role
- data ObjectInitializeMethodInfo
- objectInitialize :: (HasCallStack, MonadIO m, IsObject a) => a -> Ptr () -> m ()
- data ObjectNotifyStateChangeMethodInfo
- objectNotifyStateChange :: (HasCallStack, MonadIO m, IsObject a) => a -> Word64 -> Bool -> m ()
- data ObjectPeekParentMethodInfo
- objectPeekParent :: (HasCallStack, MonadIO m, IsObject a) => a -> m Object
- data ObjectRefAccessibleChildMethodInfo
- objectRefAccessibleChild :: (HasCallStack, MonadIO m, IsObject a) => a -> Int32 -> m Object
- data ObjectRefRelationSetMethodInfo
- objectRefRelationSet :: (HasCallStack, MonadIO m, IsObject a) => a -> m RelationSet
- data ObjectRefStateSetMethodInfo
- objectRefStateSet :: (HasCallStack, MonadIO m, IsObject a) => a -> m StateSet
- data ObjectRemovePropertyChangeHandlerMethodInfo
- objectRemovePropertyChangeHandler :: (HasCallStack, MonadIO m, IsObject a) => a -> Word32 -> m ()
- data ObjectRemoveRelationshipMethodInfo
- objectRemoveRelationship :: (HasCallStack, MonadIO m, IsObject a, IsObject b) => a -> RelationType -> b -> m Bool
- data ObjectSetDescriptionMethodInfo
- objectSetDescription :: (HasCallStack, MonadIO m, IsObject a) => a -> Text -> m ()
- data ObjectSetNameMethodInfo
- objectSetName :: (HasCallStack, MonadIO m, IsObject a) => a -> Text -> m ()
- data ObjectSetParentMethodInfo
- objectSetParent :: (HasCallStack, MonadIO m, IsObject a, IsObject b) => a -> b -> m ()
- data ObjectSetRoleMethodInfo
- objectSetRole :: (HasCallStack, MonadIO m, IsObject a) => a -> Role -> m ()
- data ObjectAccessibleComponentLayerPropertyInfo
- getObjectAccessibleComponentLayer :: (MonadIO m, IsObject o) => o -> m Int32
- objectAccessibleComponentLayer :: AttrLabelProxy "accessibleComponentLayer"
- data ObjectAccessibleComponentMdiZorderPropertyInfo
- getObjectAccessibleComponentMdiZorder :: (MonadIO m, IsObject o) => o -> m Int32
- objectAccessibleComponentMdiZorder :: AttrLabelProxy "accessibleComponentMdiZorder"
- data ObjectAccessibleDescriptionPropertyInfo
- clearObjectAccessibleDescription :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleDescription :: IsObject o => Text -> IO (GValueConstruct o)
- getObjectAccessibleDescription :: (MonadIO m, IsObject o) => o -> m (Maybe Text)
- objectAccessibleDescription :: AttrLabelProxy "accessibleDescription"
- setObjectAccessibleDescription :: (MonadIO m, IsObject o) => o -> Text -> m ()
- data ObjectAccessibleHypertextNlinksPropertyInfo
- getObjectAccessibleHypertextNlinks :: (MonadIO m, IsObject o) => o -> m Int32
- objectAccessibleHypertextNlinks :: AttrLabelProxy "accessibleHypertextNlinks"
- data ObjectAccessibleNamePropertyInfo
- clearObjectAccessibleName :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleName :: IsObject o => Text -> IO (GValueConstruct o)
- getObjectAccessibleName :: (MonadIO m, IsObject o) => o -> m (Maybe Text)
- objectAccessibleName :: AttrLabelProxy "accessibleName"
- setObjectAccessibleName :: (MonadIO m, IsObject o) => o -> Text -> m ()
- data ObjectAccessibleParentPropertyInfo
- clearObjectAccessibleParent :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleParent :: (IsObject o, IsObject a) => a -> IO (GValueConstruct o)
- getObjectAccessibleParent :: (MonadIO m, IsObject o) => o -> m (Maybe Object)
- objectAccessibleParent :: AttrLabelProxy "accessibleParent"
- setObjectAccessibleParent :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m ()
- data ObjectAccessibleRolePropertyInfo
- constructObjectAccessibleRole :: IsObject o => Int32 -> IO (GValueConstruct o)
- getObjectAccessibleRole :: (MonadIO m, IsObject o) => o -> m Int32
- objectAccessibleRole :: AttrLabelProxy "accessibleRole"
- setObjectAccessibleRole :: (MonadIO m, IsObject o) => o -> Int32 -> m ()
- data ObjectAccessibleTableCaptionPropertyInfo
- clearObjectAccessibleTableCaption :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleTableCaption :: IsObject o => Text -> IO (GValueConstruct o)
- getObjectAccessibleTableCaption :: (MonadIO m, IsObject o) => o -> m (Maybe Text)
- objectAccessibleTableCaption :: AttrLabelProxy "accessibleTableCaption"
- setObjectAccessibleTableCaption :: (MonadIO m, IsObject o) => o -> Text -> m ()
- data ObjectAccessibleTableCaptionObjectPropertyInfo
- clearObjectAccessibleTableCaptionObject :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleTableCaptionObject :: (IsObject o, IsObject a) => a -> IO (GValueConstruct o)
- getObjectAccessibleTableCaptionObject :: (MonadIO m, IsObject o) => o -> m (Maybe Object)
- objectAccessibleTableCaptionObject :: AttrLabelProxy "accessibleTableCaptionObject"
- setObjectAccessibleTableCaptionObject :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m ()
- data ObjectAccessibleTableColumnDescriptionPropertyInfo
- clearObjectAccessibleTableColumnDescription :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleTableColumnDescription :: IsObject o => Text -> IO (GValueConstruct o)
- getObjectAccessibleTableColumnDescription :: (MonadIO m, IsObject o) => o -> m (Maybe Text)
- objectAccessibleTableColumnDescription :: AttrLabelProxy "accessibleTableColumnDescription"
- setObjectAccessibleTableColumnDescription :: (MonadIO m, IsObject o) => o -> Text -> m ()
- data ObjectAccessibleTableColumnHeaderPropertyInfo
- clearObjectAccessibleTableColumnHeader :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleTableColumnHeader :: (IsObject o, IsObject a) => a -> IO (GValueConstruct o)
- getObjectAccessibleTableColumnHeader :: (MonadIO m, IsObject o) => o -> m (Maybe Object)
- objectAccessibleTableColumnHeader :: AttrLabelProxy "accessibleTableColumnHeader"
- setObjectAccessibleTableColumnHeader :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m ()
- data ObjectAccessibleTableRowDescriptionPropertyInfo
- clearObjectAccessibleTableRowDescription :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleTableRowDescription :: IsObject o => Text -> IO (GValueConstruct o)
- getObjectAccessibleTableRowDescription :: (MonadIO m, IsObject o) => o -> m (Maybe Text)
- objectAccessibleTableRowDescription :: AttrLabelProxy "accessibleTableRowDescription"
- setObjectAccessibleTableRowDescription :: (MonadIO m, IsObject o) => o -> Text -> m ()
- data ObjectAccessibleTableRowHeaderPropertyInfo
- clearObjectAccessibleTableRowHeader :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleTableRowHeader :: (IsObject o, IsObject a) => a -> IO (GValueConstruct o)
- getObjectAccessibleTableRowHeader :: (MonadIO m, IsObject o) => o -> m (Maybe Object)
- objectAccessibleTableRowHeader :: AttrLabelProxy "accessibleTableRowHeader"
- setObjectAccessibleTableRowHeader :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m ()
- data ObjectAccessibleTableSummaryPropertyInfo
- clearObjectAccessibleTableSummary :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectAccessibleTableSummary :: (IsObject o, IsObject a) => a -> IO (GValueConstruct o)
- getObjectAccessibleTableSummary :: (MonadIO m, IsObject o) => o -> m (Maybe Object)
- objectAccessibleTableSummary :: AttrLabelProxy "accessibleTableSummary"
- setObjectAccessibleTableSummary :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m ()
- data ObjectAccessibleValuePropertyInfo
- constructObjectAccessibleValue :: IsObject o => Double -> IO (GValueConstruct o)
- getObjectAccessibleValue :: (MonadIO m, IsObject o) => o -> m Double
- objectAccessibleValue :: AttrLabelProxy "accessibleValue"
- setObjectAccessibleValue :: (MonadIO m, IsObject o) => o -> Double -> m ()
- type C_ObjectActiveDescendantChangedCallback = Ptr () -> Ptr () -> Ptr () -> IO ()
- type ObjectActiveDescendantChangedCallback = Ptr () -> IO ()
- data ObjectActiveDescendantChangedSignalInfo
- afterObjectActiveDescendantChanged :: (IsObject a, MonadIO m) => a -> ObjectActiveDescendantChangedCallback -> m SignalHandlerId
- genClosure_ObjectActiveDescendantChanged :: ObjectActiveDescendantChangedCallback -> IO Closure
- mk_ObjectActiveDescendantChangedCallback :: C_ObjectActiveDescendantChangedCallback -> IO (FunPtr C_ObjectActiveDescendantChangedCallback)
- noObjectActiveDescendantChangedCallback :: Maybe ObjectActiveDescendantChangedCallback
- onObjectActiveDescendantChanged :: (IsObject a, MonadIO m) => a -> ObjectActiveDescendantChangedCallback -> m SignalHandlerId
- wrap_ObjectActiveDescendantChangedCallback :: ObjectActiveDescendantChangedCallback -> Ptr () -> Ptr () -> Ptr () -> IO ()
- type C_ObjectChildrenChangedCallback = Ptr () -> Word32 -> Ptr () -> Ptr () -> IO ()
- type ObjectChildrenChangedCallback = Word32 -> Ptr () -> IO ()
- data ObjectChildrenChangedSignalInfo
- afterObjectChildrenChanged :: (IsObject a, MonadIO m) => a -> ObjectChildrenChangedCallback -> m SignalHandlerId
- genClosure_ObjectChildrenChanged :: ObjectChildrenChangedCallback -> IO Closure
- mk_ObjectChildrenChangedCallback :: C_ObjectChildrenChangedCallback -> IO (FunPtr C_ObjectChildrenChangedCallback)
- noObjectChildrenChangedCallback :: Maybe ObjectChildrenChangedCallback
- onObjectChildrenChanged :: (IsObject a, MonadIO m) => a -> ObjectChildrenChangedCallback -> m SignalHandlerId
- wrap_ObjectChildrenChangedCallback :: ObjectChildrenChangedCallback -> Ptr () -> Word32 -> Ptr () -> Ptr () -> IO ()
- type C_ObjectFocusEventCallback = Ptr () -> CInt -> Ptr () -> IO ()
- type ObjectFocusEventCallback = Bool -> IO ()
- data ObjectFocusEventSignalInfo
- afterObjectFocusEvent :: (IsObject a, MonadIO m) => a -> ObjectFocusEventCallback -> m SignalHandlerId
- genClosure_ObjectFocusEvent :: ObjectFocusEventCallback -> IO Closure
- mk_ObjectFocusEventCallback :: C_ObjectFocusEventCallback -> IO (FunPtr C_ObjectFocusEventCallback)
- noObjectFocusEventCallback :: Maybe ObjectFocusEventCallback
- onObjectFocusEvent :: (IsObject a, MonadIO m) => a -> ObjectFocusEventCallback -> m SignalHandlerId
- wrap_ObjectFocusEventCallback :: ObjectFocusEventCallback -> Ptr () -> CInt -> Ptr () -> IO ()
- type C_ObjectPropertyChangeCallback = Ptr () -> Ptr () -> Ptr () -> IO ()
- type ObjectPropertyChangeCallback = Ptr () -> IO ()
- data ObjectPropertyChangeSignalInfo
- afterObjectPropertyChange :: (IsObject a, MonadIO m) => a -> ObjectPropertyChangeCallback -> m SignalHandlerId
- genClosure_ObjectPropertyChange :: ObjectPropertyChangeCallback -> IO Closure
- mk_ObjectPropertyChangeCallback :: C_ObjectPropertyChangeCallback -> IO (FunPtr C_ObjectPropertyChangeCallback)
- noObjectPropertyChangeCallback :: Maybe ObjectPropertyChangeCallback
- onObjectPropertyChange :: (IsObject a, MonadIO m) => a -> ObjectPropertyChangeCallback -> m SignalHandlerId
- wrap_ObjectPropertyChangeCallback :: ObjectPropertyChangeCallback -> Ptr () -> Ptr () -> Ptr () -> IO ()
- type C_ObjectStateChangeCallback = Ptr () -> CString -> CInt -> Ptr () -> IO ()
- type ObjectStateChangeCallback = Text -> Bool -> IO ()
- data ObjectStateChangeSignalInfo
- afterObjectStateChange :: (IsObject a, MonadIO m) => a -> ObjectStateChangeCallback -> m SignalHandlerId
- genClosure_ObjectStateChange :: ObjectStateChangeCallback -> IO Closure
- mk_ObjectStateChangeCallback :: C_ObjectStateChangeCallback -> IO (FunPtr C_ObjectStateChangeCallback)
- noObjectStateChangeCallback :: Maybe ObjectStateChangeCallback
- onObjectStateChange :: (IsObject a, MonadIO m) => a -> ObjectStateChangeCallback -> m SignalHandlerId
- wrap_ObjectStateChangeCallback :: ObjectStateChangeCallback -> Ptr () -> CString -> CInt -> Ptr () -> IO ()
- type C_ObjectVisibleDataChangedCallback = Ptr () -> Ptr () -> IO ()
- type ObjectVisibleDataChangedCallback = IO ()
- data ObjectVisibleDataChangedSignalInfo
- afterObjectVisibleDataChanged :: (IsObject a, MonadIO m) => a -> ObjectVisibleDataChangedCallback -> m SignalHandlerId
- genClosure_ObjectVisibleDataChanged :: ObjectVisibleDataChangedCallback -> IO Closure
- mk_ObjectVisibleDataChangedCallback :: C_ObjectVisibleDataChangedCallback -> IO (FunPtr C_ObjectVisibleDataChangedCallback)
- noObjectVisibleDataChangedCallback :: Maybe ObjectVisibleDataChangedCallback
- onObjectVisibleDataChanged :: (IsObject a, MonadIO m) => a -> ObjectVisibleDataChangedCallback -> m SignalHandlerId
- wrap_ObjectVisibleDataChangedCallback :: ObjectVisibleDataChangedCallback -> Ptr () -> Ptr () -> IO ()
Exported types
Constructors
Object (ManagedPtr Object) |
Instances
GObject Object # | |
IsObject Object # | |
IsObject Object # | |
((~) * info (ResolveObjectMethod t Object), MethodInfo * info Object p) => IsLabel t (Object -> p) # | |
((~) * info (ResolveObjectMethod t Object), MethodInfo * info Object p) => IsLabelProxy t (Object -> p) # | |
HasAttributeList * Object # | |
type AttributeList Object # | |
type SignalList Object # | |
Methods
addRelationship
data ObjectAddRelationshipMethodInfo #
Instances
((~) * signature (RelationType -> b -> m Bool), MonadIO m, IsObject a, IsObject b) => MethodInfo * ObjectAddRelationshipMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a, IsObject b) | |
=> a |
|
-> RelationType |
|
-> b |
|
-> m Bool | Returns: TRUE if the relationship is added. |
Adds a relationship of the specified type with the specified target.
getAttributes
data ObjectGetAttributesMethodInfo #
Instances
((~) * signature (m [Ptr ()]), MonadIO m, IsObject a) => MethodInfo * ObjectGetAttributesMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> m [Ptr ()] | Returns: an |
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
data ObjectGetDescriptionMethodInfo #
Instances
((~) * signature (m Text), MonadIO m, IsObject a) => MethodInfo * ObjectGetDescriptionMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> m Text | Returns: a character string representing the accessible description of the accessible. |
Gets the accessible description of the accessible.
getIndexInParent
data ObjectGetIndexInParentMethodInfo #
Instances
((~) * signature (m Int32), MonadIO m, IsObject a) => MethodInfo * ObjectGetIndexInParentMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> 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
data ObjectGetLayerMethodInfo #
Instances
((~) * signature (m Layer), MonadIO m, IsObject a) => MethodInfo * ObjectGetLayerMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> m Layer | Returns: an |
Deprecated: Use atk_component_get_layer instead.
Gets the layer of the accessible.
getMdiZorder
data ObjectGetMdiZorderMethodInfo #
Instances
((~) * signature (m Int32), MonadIO m, IsObject a) => MethodInfo * ObjectGetMdiZorderMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> 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
data ObjectGetNAccessibleChildrenMethodInfo #
Instances
((~) * signature (m Int32), MonadIO m, IsObject a) => MethodInfo * ObjectGetNAccessibleChildrenMethodInfo a signature # | |
objectGetNAccessibleChildren #
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> m Int32 | Returns: an integer representing the number of accessible children of the accessible. |
Gets the number of accessible children of the accessible.
getName
data ObjectGetNameMethodInfo #
Instances
((~) * signature (m Text), MonadIO m, IsObject a) => MethodInfo * ObjectGetNameMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> m Text | Returns: a character string representing the accessible name of the object. |
Gets the accessible name of the accessible.
getObjectLocale
data ObjectGetObjectLocaleMethodInfo #
Instances
((~) * signature (m Text), MonadIO m, IsObject a) => MethodInfo * ObjectGetObjectLocaleMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> m Text | Returns: a UTF-8 string indicating the POSIX-style LC_MESSAGES
locale of |
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
of accessible
.
Since: 2.8
getParent
data ObjectGetParentMethodInfo #
Instances
((~) * signature (m Object), MonadIO m, IsObject a) => MethodInfo * ObjectGetParentMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> m Object | Returns: an |
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
data ObjectGetRoleMethodInfo #
Instances
((~) * signature (m Role), MonadIO m, IsObject a) => MethodInfo * ObjectGetRoleMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> m Role | Returns: an |
Gets the role of the accessible.
initialize
data ObjectInitializeMethodInfo #
Instances
((~) * signature (Ptr () -> m ()), MonadIO m, IsObject a) => MethodInfo * ObjectInitializeMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> Ptr () |
|
-> m () |
notifyStateChange
data ObjectNotifyStateChangeMethodInfo #
Instances
((~) * signature (Word64 -> Bool -> m ()), MonadIO m, IsObject a) => MethodInfo * ObjectNotifyStateChangeMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> Word64 |
|
-> Bool |
|
-> 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
data ObjectPeekParentMethodInfo #
Instances
((~) * signature (m Object), MonadIO m, IsObject a) => MethodInfo * ObjectPeekParentMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> m Object | Returns: an |
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
data ObjectRefAccessibleChildMethodInfo #
Instances
((~) * signature (Int32 -> m Object), MonadIO m, IsObject a) => MethodInfo * ObjectRefAccessibleChildMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> Int32 |
|
-> m Object | Returns: an |
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
data ObjectRefRelationSetMethodInfo #
Instances
((~) * signature (m RelationSet), MonadIO m, IsObject a) => MethodInfo * ObjectRefRelationSetMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> m RelationSet | Returns: an |
Gets the RelationSet
associated with the object.
refStateSet
data ObjectRefStateSetMethodInfo #
Instances
((~) * signature (m StateSet), MonadIO m, IsObject a) => MethodInfo * ObjectRefStateSetMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> m StateSet | Returns: a reference to an |
Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed.
removePropertyChangeHandler
data ObjectRemovePropertyChangeHandlerMethodInfo #
Instances
((~) * signature (Word32 -> m ()), MonadIO m, IsObject a) => MethodInfo * ObjectRemovePropertyChangeHandlerMethodInfo a signature # | |
objectRemovePropertyChangeHandler #
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> Word32 |
|
-> m () |
Deprecated: Since 2.12.Removes a property change handler.
No description available in the introspection data.
removeRelationship
data ObjectRemoveRelationshipMethodInfo #
Instances
((~) * signature (RelationType -> b -> m Bool), MonadIO m, IsObject a, IsObject b) => MethodInfo * ObjectRemoveRelationshipMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a, IsObject b) | |
=> a |
|
-> RelationType |
|
-> b |
|
-> m Bool | Returns: TRUE if the relationship is removed. |
Removes a relationship of the specified type with the specified target.
setDescription
data ObjectSetDescriptionMethodInfo #
Instances
((~) * signature (Text -> m ()), MonadIO m, IsObject a) => MethodInfo * ObjectSetDescriptionMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> Text |
|
-> 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
data ObjectSetNameMethodInfo #
Instances
((~) * signature (Text -> m ()), MonadIO m, IsObject a) => MethodInfo * ObjectSetNameMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> Text |
|
-> 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
data ObjectSetParentMethodInfo #
Instances
((~) * signature (b -> m ()), MonadIO m, IsObject a, IsObject b) => MethodInfo * ObjectSetParentMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a, IsObject b) | |
=> a |
|
-> b |
|
-> m () |
Sets the accessible parent of the accessible. parent
can be NULL.
setRole
data ObjectSetRoleMethodInfo #
Instances
((~) * signature (Role -> m ()), MonadIO m, IsObject a) => MethodInfo * ObjectSetRoleMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> Role |
|
-> m () |
Sets the role of the accessible.
Properties
accessibleComponentLayer
data ObjectAccessibleComponentLayerPropertyInfo #
Instances
getObjectAccessibleComponentLayer :: (MonadIO m, IsObject o) => o -> m Int32 #
objectAccessibleComponentLayer :: AttrLabelProxy "accessibleComponentLayer" #
accessibleComponentMdiZorder
data ObjectAccessibleComponentMdiZorderPropertyInfo #
Instances
getObjectAccessibleComponentMdiZorder :: (MonadIO m, IsObject o) => o -> m Int32 #
objectAccessibleComponentMdiZorder :: AttrLabelProxy "accessibleComponentMdiZorder" #
accessibleDescription
data ObjectAccessibleDescriptionPropertyInfo #
Instances
clearObjectAccessibleDescription :: (MonadIO m, IsObject o) => o -> m () #
constructObjectAccessibleDescription :: IsObject o => Text -> IO (GValueConstruct o) #
objectAccessibleDescription :: AttrLabelProxy "accessibleDescription" #
setObjectAccessibleDescription :: (MonadIO m, IsObject o) => o -> Text -> m () #
accessibleHypertextNlinks
data ObjectAccessibleHypertextNlinksPropertyInfo #
Instances
getObjectAccessibleHypertextNlinks :: (MonadIO m, IsObject o) => o -> m Int32 #
objectAccessibleHypertextNlinks :: AttrLabelProxy "accessibleHypertextNlinks" #
accessibleName
data ObjectAccessibleNamePropertyInfo #
Instances
clearObjectAccessibleName :: (MonadIO m, IsObject o) => o -> m () #
constructObjectAccessibleName :: IsObject o => Text -> IO (GValueConstruct o) #
objectAccessibleName :: AttrLabelProxy "accessibleName" #
setObjectAccessibleName :: (MonadIO m, IsObject o) => o -> Text -> m () #
accessibleParent
data ObjectAccessibleParentPropertyInfo #
Instances
clearObjectAccessibleParent :: (MonadIO m, IsObject o) => o -> m () #
constructObjectAccessibleParent :: (IsObject o, IsObject a) => a -> IO (GValueConstruct o) #
objectAccessibleParent :: AttrLabelProxy "accessibleParent" #
setObjectAccessibleParent :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m () #
accessibleRole
data ObjectAccessibleRolePropertyInfo #
Instances
constructObjectAccessibleRole :: IsObject o => Int32 -> IO (GValueConstruct o) #
getObjectAccessibleRole :: (MonadIO m, IsObject o) => o -> m Int32 #
objectAccessibleRole :: AttrLabelProxy "accessibleRole" #
setObjectAccessibleRole :: (MonadIO m, IsObject o) => o -> Int32 -> m () #
accessibleTableCaption
data ObjectAccessibleTableCaptionPropertyInfo #
Instances
clearObjectAccessibleTableCaption :: (MonadIO m, IsObject o) => o -> m () #
constructObjectAccessibleTableCaption :: IsObject o => Text -> IO (GValueConstruct o) #
objectAccessibleTableCaption :: AttrLabelProxy "accessibleTableCaption" #
setObjectAccessibleTableCaption :: (MonadIO m, IsObject o) => o -> Text -> m () #
accessibleTableCaptionObject
data ObjectAccessibleTableCaptionObjectPropertyInfo #
Instances
clearObjectAccessibleTableCaptionObject :: (MonadIO m, IsObject o) => o -> m () #
constructObjectAccessibleTableCaptionObject :: (IsObject o, IsObject a) => a -> IO (GValueConstruct o) #
objectAccessibleTableCaptionObject :: AttrLabelProxy "accessibleTableCaptionObject" #
setObjectAccessibleTableCaptionObject :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m () #
accessibleTableColumnDescription
data ObjectAccessibleTableColumnDescriptionPropertyInfo #
Instances
clearObjectAccessibleTableColumnDescription :: (MonadIO m, IsObject o) => o -> m () #
constructObjectAccessibleTableColumnDescription :: IsObject o => Text -> IO (GValueConstruct o) #
objectAccessibleTableColumnDescription :: AttrLabelProxy "accessibleTableColumnDescription" #
setObjectAccessibleTableColumnDescription :: (MonadIO m, IsObject o) => o -> Text -> m () #
accessibleTableColumnHeader
data ObjectAccessibleTableColumnHeaderPropertyInfo #
Instances
clearObjectAccessibleTableColumnHeader :: (MonadIO m, IsObject o) => o -> m () #
constructObjectAccessibleTableColumnHeader :: (IsObject o, IsObject a) => a -> IO (GValueConstruct o) #
objectAccessibleTableColumnHeader :: AttrLabelProxy "accessibleTableColumnHeader" #
setObjectAccessibleTableColumnHeader :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m () #
accessibleTableRowDescription
data ObjectAccessibleTableRowDescriptionPropertyInfo #
Instances
clearObjectAccessibleTableRowDescription :: (MonadIO m, IsObject o) => o -> m () #
constructObjectAccessibleTableRowDescription :: IsObject o => Text -> IO (GValueConstruct o) #
objectAccessibleTableRowDescription :: AttrLabelProxy "accessibleTableRowDescription" #
setObjectAccessibleTableRowDescription :: (MonadIO m, IsObject o) => o -> Text -> m () #
accessibleTableRowHeader
data ObjectAccessibleTableRowHeaderPropertyInfo #
Instances
clearObjectAccessibleTableRowHeader :: (MonadIO m, IsObject o) => o -> m () #
constructObjectAccessibleTableRowHeader :: (IsObject o, IsObject a) => a -> IO (GValueConstruct o) #
objectAccessibleTableRowHeader :: AttrLabelProxy "accessibleTableRowHeader" #
setObjectAccessibleTableRowHeader :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m () #
accessibleTableSummary
data ObjectAccessibleTableSummaryPropertyInfo #
Instances
clearObjectAccessibleTableSummary :: (MonadIO m, IsObject o) => o -> m () #
constructObjectAccessibleTableSummary :: (IsObject o, IsObject a) => a -> IO (GValueConstruct o) #
objectAccessibleTableSummary :: AttrLabelProxy "accessibleTableSummary" #
setObjectAccessibleTableSummary :: (MonadIO m, IsObject o, IsObject a) => o -> a -> m () #
accessibleValue
data ObjectAccessibleValuePropertyInfo #
Instances
constructObjectAccessibleValue :: IsObject o => Double -> IO (GValueConstruct o) #
getObjectAccessibleValue :: (MonadIO m, IsObject o) => o -> m Double #
objectAccessibleValue :: AttrLabelProxy "accessibleValue" #
setObjectAccessibleValue :: (MonadIO m, IsObject o) => o -> Double -> m () #
Signals
activeDescendantChanged
type ObjectActiveDescendantChangedCallback = Ptr () -> IO () #
afterObjectActiveDescendantChanged :: (IsObject a, MonadIO m) => a -> ObjectActiveDescendantChangedCallback -> m SignalHandlerId #
mk_ObjectActiveDescendantChangedCallback :: C_ObjectActiveDescendantChangedCallback -> IO (FunPtr C_ObjectActiveDescendantChangedCallback) #
onObjectActiveDescendantChanged :: (IsObject a, MonadIO m) => a -> ObjectActiveDescendantChangedCallback -> m SignalHandlerId #
wrap_ObjectActiveDescendantChangedCallback :: ObjectActiveDescendantChangedCallback -> Ptr () -> Ptr () -> Ptr () -> IO () #
childrenChanged
type ObjectChildrenChangedCallback = Word32 -> Ptr () -> IO () #
afterObjectChildrenChanged :: (IsObject a, MonadIO m) => a -> ObjectChildrenChangedCallback -> m SignalHandlerId #
mk_ObjectChildrenChangedCallback :: C_ObjectChildrenChangedCallback -> IO (FunPtr C_ObjectChildrenChangedCallback) #
onObjectChildrenChanged :: (IsObject a, MonadIO m) => a -> ObjectChildrenChangedCallback -> m SignalHandlerId #
wrap_ObjectChildrenChangedCallback :: ObjectChildrenChangedCallback -> Ptr () -> Word32 -> Ptr () -> Ptr () -> IO () #
focusEvent
type ObjectFocusEventCallback = Bool -> IO () #
Deprecated: (Since version 2.9.4)Use the Object
::state-change
signal instead.
afterObjectFocusEvent :: (IsObject a, MonadIO m) => a -> ObjectFocusEventCallback -> m SignalHandlerId #
mk_ObjectFocusEventCallback :: C_ObjectFocusEventCallback -> IO (FunPtr C_ObjectFocusEventCallback) #
onObjectFocusEvent :: (IsObject a, MonadIO m) => a -> ObjectFocusEventCallback -> m SignalHandlerId #
wrap_ObjectFocusEventCallback :: ObjectFocusEventCallback -> Ptr () -> CInt -> Ptr () -> IO () #
propertyChange
type ObjectPropertyChangeCallback = Ptr () -> IO () #
afterObjectPropertyChange :: (IsObject a, MonadIO m) => a -> ObjectPropertyChangeCallback -> m SignalHandlerId #
mk_ObjectPropertyChangeCallback :: C_ObjectPropertyChangeCallback -> IO (FunPtr C_ObjectPropertyChangeCallback) #
onObjectPropertyChange :: (IsObject a, MonadIO m) => a -> ObjectPropertyChangeCallback -> m SignalHandlerId #
wrap_ObjectPropertyChangeCallback :: ObjectPropertyChangeCallback -> Ptr () -> Ptr () -> Ptr () -> IO () #
stateChange
type ObjectStateChangeCallback = Text -> Bool -> IO () #
afterObjectStateChange :: (IsObject a, MonadIO m) => a -> ObjectStateChangeCallback -> m SignalHandlerId #
mk_ObjectStateChangeCallback :: C_ObjectStateChangeCallback -> IO (FunPtr C_ObjectStateChangeCallback) #
onObjectStateChange :: (IsObject a, MonadIO m) => a -> ObjectStateChangeCallback -> m SignalHandlerId #
wrap_ObjectStateChangeCallback :: ObjectStateChangeCallback -> Ptr () -> CString -> CInt -> Ptr () -> IO () #
visibleDataChanged
type C_ObjectVisibleDataChangedCallback = Ptr () -> Ptr () -> IO () #
type ObjectVisibleDataChangedCallback = IO () #
afterObjectVisibleDataChanged :: (IsObject a, MonadIO m) => a -> ObjectVisibleDataChangedCallback -> m SignalHandlerId #
mk_ObjectVisibleDataChangedCallback :: C_ObjectVisibleDataChangedCallback -> IO (FunPtr C_ObjectVisibleDataChangedCallback) #
onObjectVisibleDataChanged :: (IsObject a, MonadIO m) => a -> ObjectVisibleDataChangedCallback -> m SignalHandlerId #
wrap_ObjectVisibleDataChangedCallback :: ObjectVisibleDataChangedCallback -> Ptr () -> Ptr () -> IO () #