From: Piotr Trojanowski
+ | + | + | libatspi Reference Manual | ++ |
---|---|---|---|---|
+Top + Â |Â + Description + Â |Â + Object Hierarchy + Â |Â + Implemented Interfaces + |
+AtspiAccessible+AtspiAccessible â The base interface which is implemented by all accessible objects. + |
++ |
AtspiAccessible; +struct AtspiAccessibleClass; +gchar * atspi_role_get_name (+AtspiRole role
); +gchar * atspi_accessible_get_name (AtspiAccessible *obj
, +GError **error
); +gchar * atspi_accessible_get_description (AtspiAccessible *obj
, +GError **error
); +AtspiAccessible * atspi_accessible_get_parent (AtspiAccessible *obj
, +GError **error
); +gint atspi_accessible_get_child_count (AtspiAccessible *obj
, +GError **error
); +AtspiAccessible * atspi_accessible_get_child_at_index (AtspiAccessible *obj
, +gint child_index
, +GError **error
); +gint atspi_accessible_get_index_in_parent + (AtspiAccessible *obj
, +GError **error
); +GArray * atspi_accessible_get_relation_set (AtspiAccessible *obj
, +GError **error
); +AtspiRole atspi_accessible_get_role (AtspiAccessible *obj
, +GError **error
); +gchar * atspi_accessible_get_role_name (AtspiAccessible *obj
, +GError **error
); +gchar * atspi_accessible_get_localized_role_name + (AtspiAccessible *obj
, +GError **error
); +AtspiStateSet * atspi_accessible_get_state_set (AtspiAccessible *obj
); +GHashTable * atspi_accessible_get_attributes (AtspiAccessible *obj
, +GError **error
); +GArray * atspi_accessible_get_attributes_as_array + (AtspiAccessible *obj
, +GError **error
); +gchar * atspi_accessible_get_toolkit_name (AtspiAccessible *obj
, +GError **error
); +gchar * atspi_accessible_get_toolkit_version + (AtspiAccessible *obj
, +GError **error
); +AtspiAccessible * atspi_accessible_get_application (AtspiAccessible *obj
, +GError **error
); +AtspiAction * atspi_accessible_get_action (AtspiAccessible *obj
); +AtspiCollection * atspi_accessible_get_collection (AtspiAccessible *obj
); +AtspiComponent * atspi_accessible_get_component (AtspiAccessible *obj
); +AtspiDocument * atspi_accessible_get_document (AtspiAccessible *obj
); +AtspiEditableText * atspi_accessible_get_editable_text (AtspiAccessible *obj
); +AtspiHyperlink * atspi_accessible_get_hyperlink (AtspiAccessible *obj
); +AtspiHypertext * atspi_accessible_get_hypertext (AtspiAccessible *obj
); +AtspiImage * atspi_accessible_get_image (AtspiAccessible *obj
); +AtspiSelection * atspi_accessible_get_selection (AtspiAccessible *obj
); +AtspiTable * atspi_accessible_get_table (AtspiAccessible *obj
); +AtspiText * atspi_accessible_get_text (AtspiAccessible *obj
); +AtspiValue * atspi_accessible_get_value (AtspiAccessible *obj
); +GArray * atspi_accessible_get_interfaces (AtspiAccessible *obj
); +
+AtspiAccessible implements + AtspiAction, AtspiCollection, AtspiComponent, AtspiDocument, AtspiEditableText, AtspiHypertext, AtspiImage, AtspiSelection, AtspiTable, AtspiText and AtspiValue.
++The base interface which is implemented by all accessible objects. +All objects support interfaces for querying their contained 'children' +and position in the accessible-object hierarchy, whether or not they +actually have children. +
+struct AtspiAccessibleClass { + AtspiObjectClass parent_class; +}; ++
+
+gchar * atspi_role_get_name (AtspiRole role
);
++Gets a localizable string that indicates the name of an AtspiRole. +<em>DEPRECATED.</em> +
+ +gchar * atspi_accessible_get_name (+AtspiAccessible *obj
, +GError **error
);
+Gets the name of an AtspiAccessible object. +
+
|
+a pointer to the AtspiAccessible object on which to operate. | +
Returns : |
+a UTF-8 string indicating the name of the AtspiAccessible object +or NULL on exception. | +
gchar * atspi_accessible_get_description (+AtspiAccessible *obj
, +GError **error
);
+Gets the description of an AtspiAccessible object. +
+
|
+a pointer to the AtspiAccessible object on which to operate. | +
Returns : |
+a UTF-8 string describing the AtspiAccessible object +or NULL on exception. | +
AtspiAccessible * atspi_accessible_get_parent (+AtspiAccessible *obj
, +GError **error
);
+Gets an AtspiAccessible object's parent container. +
+
|
+a pointer to the AtspiAccessible object to query. | +
Returns : |
+a pointer to the AtspiAccessible object which
+contains the given AtspiAccessible instance, or NULL if the obj
+has no parent container. [transfer full]
+ |
+
gint atspi_accessible_get_child_count (+AtspiAccessible *obj
, +GError **error
);
+Gets the number of children contained by an AtspiAccessible object. +
+
|
+a pointer to the AtspiAccessible object on which to operate. | +
Returns : |
+a long indicating the number of AtspiAccessible children +contained by an AtspiAccessible object or -1 on exception. | +
AtspiAccessible * atspi_accessible_get_child_at_index (+AtspiAccessible *obj
, +gint child_index
, +GError **error
);
+Gets the AtspiAccessible child of an AtspiAccessible object at a given index. +
+
|
+a pointer to the AtspiAccessible object on which to operate. | +
|
+a long indicating which child is specified. | +
Returns : |
+a pointer to the AtspiAccessible child object at
+index child_index or NULL on exception. [transfer full]
+ |
+
gint atspi_accessible_get_index_in_parent + (+AtspiAccessible *obj
, +GError **error
);
+Gets the index of an AtspiAccessible object within its parent's +AtspiAccessible children list. +
+
|
+a pointer to the AtspiAccessible object on which to operate. | +
Returns : |
+a glong indicating the index of the AtspiAccessible object
+in its parent,
+or -1 if obj has no containing parent or on exception. |
+
GArray * atspi_accessible_get_relation_set (+AtspiAccessible *obj
, +GError **error
);
+Gets the set of AtspiRelation objects which describes this AtspiAccessible object's +relationships with other AtspiAccessible objects. +
+
|
+a pointer to the AtspiAccessible object on which to operate. | +
Returns : |
+a GArray of +AtspiRelation pointers or NULL on exception. [element-type AtspiAccessible*][transfer full] + | +
AtspiRole atspi_accessible_get_role (+AtspiAccessible *obj
, +GError **error
);
+Gets the UI role played by an AtspiAccessible object.
+This role's name can be obtained via atspi_accessible_get_role_name()
.
+
|
+a pointer to the AtspiAccessible object on which to operate. | +
Returns : |
+the AtspiRole of an AtspiAccessible object. | +
gchar * atspi_accessible_get_role_name (+AtspiAccessible *obj
, +GError **error
);
+Gets a UTF-8 string corresponding to the name of the role played by an object.
+This method will return useful values for roles that fall outside the
+enumeration used in atspi_accessible_get_role()
.
+
|
+a pointer to the AtspiAccessible object on which to operate. | +
Returns : |
+a UTF-8 string specifying the type of UI role played by an +AtspiAccessible object. | +
gchar * atspi_accessible_get_localized_role_name + (+AtspiAccessible *obj
, +GError **error
);
+Gets a UTF-8 string corresponding to the name of the role played by an
+object, translated to the current locale.
+This method will return useful values for roles that fall outside the
+enumeration used in atspi_accessible_getRole()
.
+
|
+a pointer to the AtspiAccessible object on which to operate. | +
Returns : |
+a localized, UTF-8 string specifying the type of UI role played +by an AtspiAccessible object. | +
AtspiStateSet * atspi_accessible_get_state_set (AtspiAccessible *obj
);
++Gets the states currently held by an object. +
+
|
+a pointer to the AtspiAccessible object on which to operate. | +
Returns : |
+a pointer to an AtspiStateSet representing an +object's current state set. [transfer full] + | +
GHashTable * atspi_accessible_get_attributes (+AtspiAccessible *obj
, +GError **error
);
+Gets the AttributeSet representing any assigned +name-value pair attributes or annotations for this object. +For typographic, textual, or textually-semantic attributes, see +atspi_text_get_attributes instead. +
+
|
+The AtspiAccessible being queried. | +
Returns : |
+The name-value-pair +attributes assigned to this object. [element-type gchar* gchar*][transfer full] + | +
GArray * atspi_accessible_get_attributes_as_array + (+AtspiAccessible *obj
, +GError **error
);
+Gets a GArray representing any assigned +name-value pair attributes or annotations for this object. +For typographic, textual, or textually-semantic attributes, see +atspi_text_get_attributes_as_array instead. +
+
|
+The AtspiAccessible being queried. | +
Returns : |
+The name-value-pair +attributes assigned to this object. [element-type gchar*][transfer full] + | +
gchar * atspi_accessible_get_toolkit_name (+AtspiAccessible *obj
, +GError **error
);
+Gets the toolkit name for an AtspiAccessible object. +Only works on application root objects. +
+
|
+a pointer to the AtspiAccessible object on which to operate. | +
Returns : |
+a UTF-8 string indicating the toolkit name for the AtspiAccessible object or NULL on exception. | +
gchar * atspi_accessible_get_toolkit_version + (+AtspiAccessible *obj
, +GError **error
);
+Gets the toolkit version for an AtspiAccessible object. +Only works on application root objects. +
+
|
+a pointer to the AtspiAccessible object on which to operate. | +
Returns : |
+a UTF-8 string indicating the toolkit version for the AtspiAccessible object or NULL on exception. | +
AtspiAccessible * atspi_accessible_get_application (+AtspiAccessible *obj
, +GError **error
);
+Gets the containing AtspiApplication for an object. +
+
|
+The AtspiAccessible being queried. | +
Returns : |
+the containing AtspiApplication instance for +this object. [transfer full] + | +
AtspiAction * atspi_accessible_get_action (AtspiAccessible *obj
);
++Gets the AtspiAction interface for an AtspiAccessible. +
+
|
+a pointer to the AtspiAccessible instance to query. | +
Returns : |
+a pointer to an AtspiAction interface
+instance, or NULL if obj does not implement AtspiAction. [transfer full]
+ |
+
AtspiCollection * atspi_accessible_get_collection (AtspiAccessible *obj
);
++Gets the AtspiCollection interface for an AtspiAccessible. +
+
|
+a pointer to the AtspiAccessible instance to query. | +
Returns : |
+a pointer to an AtspiCollection interface
+instance, or NULL if obj does not implement AtspiCollection. [transfer full]
+ |
+
AtspiComponent * atspi_accessible_get_component (AtspiAccessible *obj
);
++Gets the AtspiComponent interface for an AtspiAccessible. +
+
|
+a pointer to the AtspiAccessible instance to query. | +
Returns : |
+a pointer to an AtspiComponent interface
+instance, or NULL if obj does not implement AtspiComponent. [transfer full]
+ |
+
AtspiDocument * atspi_accessible_get_document (AtspiAccessible *obj
);
++Gets the AtspiDocument interface for an AtspiAccessible. +
+
|
+a pointer to the AtspiAccessible instance to query. | +
Returns : |
+a pointer to an AtspiDocument interface
+instance, or NULL if obj does not implement AtspiDocument. [transfer full]
+ |
+
AtspiEditableText * atspi_accessible_get_editable_text (AtspiAccessible *obj
);
++Gets the AtspiEditableText interface for an AtspiAccessible. +
+
|
+a pointer to the AtspiAccessible instance to query. | +
Returns : |
+a pointer to an AtspiEditableText interface
+instance, or NULL if obj does not implement AtspiEditableText. [transfer full]
+ |
+
AtspiHyperlink * atspi_accessible_get_hyperlink (AtspiAccessible *obj
);
++Gets the AtspiHyperlink interface for an AtspiAccessible. +
+
|
+a pointer to the AtspiAccessible object on which to operate. | +
Returns : |
+the AtspiHyperlink object associated with +the given AtspiAccessible, or NULL if not supported. [transfer full] + | +
AtspiHypertext * atspi_accessible_get_hypertext (AtspiAccessible *obj
);
++Gets the AtspiHypertext interface for an AtspiAccessible. +
+
|
+a pointer to the AtspiAccessible instance to query. | +
Returns : |
+a pointer to an AtspiHypertext interface
+instance, or NULL if obj does not implement AtspiHypertext. [transfer full]
+ |
+
AtspiImage * atspi_accessible_get_image (AtspiAccessible *obj
);
++Gets the AtspiImage interface for an AtspiAccessible. +
+
|
+a pointer to the AtspiAccessible instance to query. | +
Returns : |
+a pointer to an AtspiImage interface instance, or
+NULL if obj does not implement AtspiImage. [transfer full]
+ |
+
AtspiSelection * atspi_accessible_get_selection (AtspiAccessible *obj
);
++Gets the AtspiSelection interface for an AtspiAccessible. +
+
|
+a pointer to the AtspiAccessible instance to query. | +
Returns : |
+a pointer to an AtspiSelection interface
+instance, or NULL if obj does not implement AtspiSelection. [transfer full]
+ |
+
AtspiTable * atspi_accessible_get_table (AtspiAccessible *obj
);
++Gets the AtspiTable interface for an AtspiAccessible. +
+
|
+a pointer to the AtspiAccessible instance to query. | +
Returns : |
+a pointer to an AtspiTable interface instance, or
+NULL if obj does not implement AtspiTable. [transfer full]
+ |
+
AtspiText * atspi_accessible_get_text (AtspiAccessible *obj
);
++Gets the AtspiTable interface for an AtspiAccessible. +
+
|
+a pointer to the AtspiAccessible instance to query. | +
Returns : |
+a pointer to an AtspiText interface instance, or
+NULL if obj does not implement AtspiText. [transfer full]
+ |
+
AtspiValue * atspi_accessible_get_value (AtspiAccessible *obj
);
++Gets the AtspiTable interface for an AtspiAccessible. +
+
|
+a pointer to the AtspiAccessible instance to query. | +
Returns : |
+a pointer to an AtspiValue interface instance, or
+NULL if obj does not implement AtspiValue. [transfer full]
+ |
+
GArray * atspi_accessible_get_interfaces (AtspiAccessible *obj
);
++A set of pointers to all interfaces supported by an AtspiAccessible. +
+
|
+The AtspiAccessible to query. | +
Returns : |
+A GArray of strings +describing the interfaces supported by the object. Interfaces are +denoted in short-hand (i.e. "Component", "Text" etc.). [element-type gchar*][transfer full] + | +
+ | + | + | libatspi Reference Manual | ++ |
---|---|---|---|---|
+Top + Â |Â + Description + Â |Â + Object Hierarchy + |
+atspi-devicelistener+atspi-devicelistener â An interface for creating and manipulating +device listeners. + |
++ |
gboolean (*AtspiDeviceListenerCB) (+const AtspiDeviceEvent *stroke
, +void *user_data
); +gboolean (*AtspiDeviceListenerSimpleCB) (const AtspiDeviceEvent *stroke
); +struct AtspiDeviceListener; +struct AtspiDeviceListenerClass; +AtspiDeviceListener * atspi_device_listener_new (AtspiDeviceListenerCB callback
, +void *user_data
, +GDestroyNotify callback_destroyed
); +AtspiDeviceListener * atspi_device_listener_new_simple (AtspiDeviceListenerSimpleCB callback
, +GDestroyNotify callback_destroyed
); +void atspi_device_listener_add_callback (AtspiDeviceListener *listener
, +AtspiDeviceListenerCB callback
, +GDestroyNotify callback_destroyed
, +void *user_data
); +void atspi_device_listener_remove_callback + (AtspiDeviceListener *listener
, +AtspiDeviceListenerCB callback
); +
+An interface for creating and manipulating +device listeners with callback functions. +
+gboolean (*AtspiDeviceListenerCB) (+const AtspiDeviceEvent *stroke
, +void *user_data
);
+A callback function prototype via which clients receive device event notifications. +
+
|
+The AtspiDeviceEvent for which notification is +being received. [transfer full] + | +
|
+Data which is passed to the client each time this callback is notified. | +
Returns : |
++TRUE if the client wishes to consume/preempt the event, preventing it from being +relayed to the currently focussed application, FALSE if the event delivery should proceed as normal. | +
gboolean (*AtspiDeviceListenerSimpleCB) (const AtspiDeviceEvent *stroke
);
++Similar to AtspiDeviceListenerCB, but with no user data. +
+
|
+The AtspiDeviceEvent for which notification is +being received. [transfer full] + | +
Returns : |
++TRUE if the client wishes to consume/preempt the event, preventing it from being +relayed to the currently focussed application, FALSE if the event delivery should proceed as normal. | +
struct AtspiDeviceListenerClass { + GObjectClass parent_class; + gboolean (*device_event) (AtspiDeviceListener *, const AtspiDeviceEvent *); +}; ++
+
+AtspiDeviceListener * atspi_device_listener_new (+AtspiDeviceListenerCB callback
, +void *user_data
, +GDestroyNotify callback_destroyed
);
+Creates a new AtspiDeviceListener with a specified callback function. +
+
|
+an AtspiDeviceListenerCB callback function, +or NULL. [scope notified] + | +
|
+a pointer to data which will be passed to the +callback when invoked. [closure] + | +
|
+A GDestroyNotify called when the listener is freed +and data associated with the callback should be freed. It can be NULL. | +
Returns : |
+a pointer to a newly-created AtspiDeviceListener. [transfer full] + | +
AtspiDeviceListener * atspi_device_listener_new_simple (+AtspiDeviceListenerSimpleCB callback
, +GDestroyNotify callback_destroyed
);
+Creates a new AtspiDeviceListener with a specified callback function. +This method is similar to atspi_device_listener_new, but callback +takes no user data. +
+
|
+an AtspiDeviceListenerCB callback function, +or NULL. [scope notified] + | +
|
+A GDestroyNotify called when the listener is freed +and data associated with the callback should be freed. It an be NULL. | +
Returns : |
+a pointer to a newly-created AtspiDeviceListener. | +
void atspi_device_listener_add_callback (+AtspiDeviceListener *listener
, +AtspiDeviceListenerCB callback
, +GDestroyNotify callback_destroyed
, +void *user_data
);
+Adds an in-process callback function to an existing AtspiDeviceListener. +
+
|
+the AtspiDeviceListener instance to modify. | +
|
+an AtspiDeviceListenerCB function pointer. [scope notified] + | +
|
+A GDestroyNotify called when the listener is freed +and data associated with the callback should be freed. It can be NULL. | +
|
+a pointer to data which will be passed to the +callback when invoked. [closure] + | +
void atspi_device_listener_remove_callback + (+AtspiDeviceListener *listener
, +AtspiDeviceListenerCB callback
);
+Removes an in-process callback function from an existing +AtspiDeviceListener. +
+
|
+the AtspiDeviceListener instance to modify. | +
|
+an AtspiDeviceListenerCB function pointer. [scope call] + | +
+ | + | + | libatspi Reference Manual | ++ |
---|---|---|---|---|
+Top + Â |Â + Description + Â |Â + Object Hierarchy + |
+atspi-event-listener+atspi-event-listener â A generic interface implemented by objects for the receipt of event +notifications. + |
++ |
void (*AtspiEventListenerCB) (+const AtspiEvent *event
, +void *user_data
); +void (*AtspiEventListenerSimpleCB) (const AtspiEvent *event
); +struct AtspiEventListener; +struct AtspiEventListenerClass; +GType atspi_event_listener_get_type (void
); +AtspiEventListener * atspi_event_listener_new (AtspiEventListenerCB callback
, +gpointer user_data
, +GDestroyNotify callback_destroyed
); +AtspiEventListener * atspi_event_listener_new_simple (AtspiEventListenerSimpleCB callback
, +GDestroyNotify callback_destroyed
); +gboolean atspi_event_listener_register (AtspiEventListener *listener
, +const gchar *event_type
, +GError **error
); +gboolean atspi_event_listener_register_from_callback + (AtspiEventListenerCB callback
, +void *user_data
, +GDestroyNotify callback_destroyed
, +const gchar *event_type
, +GError **error
); +gboolean atspi_event_listener_register_no_data + (AtspiEventListenerSimpleCB callback
, +GDestroyNotify callback_destroyed
, +const gchar *event_type
, +GError **error
); +gboolean atspi_event_listener_deregister (AtspiEventListener *listener
, +const gchar *event_type
, +GError **error
); +gboolean atspi_event_listener_deregister_from_callback + (AtspiEventListenerCB callback
, +void *user_data
, +const gchar *event_type
, +GError **error
); +gboolean atspi_event_listener_deregister_no_data + (AtspiEventListenerSimpleCB callback
, +const gchar *event_type
, +GError **error
); +
+A generic interface implemented by objects for the receipt of event +notifications. atspi-event-listener is the interface via which clients of +the atspi-registry receive notification of changes to an application's user +interface and content. +
+void (*AtspiEventListenerCB) (+const AtspiEvent *event
, +void *user_data
);
+A function prototype for callbacks via which clients are notified of AT-SPI events. +
+
|
+The event for which notification is sent. [transfer full] + | +
|
+User data which is passed to the callback each time a notification takes place. | +
void (*AtspiEventListenerSimpleCB) (const AtspiEvent *event
);
++Like AtspiEventlistenerCB, but with no user_data. +
+
|
+The event for which notification is sent. [transfer full] + | +
struct AtspiEventListenerClass { + GObjectClass parent_class; +}; ++
+
+AtspiEventListener * atspi_event_listener_new (+AtspiEventListenerCB callback
, +gpointer user_data
, +GDestroyNotify callback_destroyed
);
+Creates a new AtspiEventListener associated with a specified callback
.
+
|
+An AtspiEventListenerCB to be called +when an event is fired. [scope notified] + | +
|
+data to pass to the callback. [closure] + | +
|
+A GDestroyNotify called when the listener is freed +and data associated with the callback should be freed. Can be NULL. | +
Returns : |
+A new AtspiEventListener. [transfer full] + | +
AtspiEventListener * atspi_event_listener_new_simple (+AtspiEventListenerSimpleCB callback
, +GDestroyNotify callback_destroyed
);
+Creates a new AtspiEventListener associated with a specified callback
.
+
|
+An AtspiEventListenerSimpleCB to be called +when an event is fired. [scope notified] + | +
|
+A GDestroyNotify called when the listener is freed +and data associated with the callback should be freed. Can be NULL. | +
Returns : |
+A new AtspiEventListener. [transfer full] + | +
gboolean atspi_event_listener_register (+AtspiEventListener *listener
, +const gchar *event_type
, +GError **error
);
+Adds an in-process callback function to an existing AtspiEventListener. +
++Legal object event types: +
++ (property change events) +
++ object:property-change + object:property-change:accessible-name + object:property-change:accessible-description + object:property-change:accessible-parent + object:property-change:accessible-value + object:property-change:accessible-role + object:property-change:accessible-table-caption + object:property-change:accessible-table-column-description + object:property-change:accessible-table-column-header + object:property-change:accessible-table-row-description + object:property-change:accessible-table-row-header + object:property-change:accessible-table-summary +
++ (other object events) +
++ object:state-changed + object:children-changed + object:visible-data-changed + object:selection-changed + object:text-selection-changed + object:text-changed + object:text-caret-moved + object:row-inserted + object:row-reordered + object:row-deleted + object:column-inserted + object:column-reordered + object:column-deleted + object:model-changed + object:active-descendant-changed +
++ (window events) +
++ window:minimize + window:maximize + window:restore + window:close + window:create + window:reparent + window:desktop-create + window:desktop-destroy + window:activate + window:deactivate + window:raise + window:lower + window:move + window:resize + window:shade + window:unshade + window:restyle +
++ (other events) +
++ focus: + mouse:abs + mouse:rel + mouse:b1p + mouse:b1r + mouse:b2p + mouse:b2r + mouse:b3p + mouse:b3r +
++NOTE: this character string may be UTF-8, but should not contain byte +value 56 + (ascii ':'), except as a delimiter, since non-UTF-8 string + delimiting functions are used internally. + In general, listening to + toolkit-specific events is not recommended. +
+
|
+The AtspiEventListener to register against an event type. | +
|
+a character string indicating the type of events for which +notification is requested. Format is +EventClass:major_type:minor_type:detail +where all subfields other than EventClass are optional. +EventClasses include "object", "window", "mouse", +and toolkit events (e.g. "Gtk", "AWT"). +Examples: "focus:", "Gtk:GtkWidget:button_press_event". | +
Returns : |
++TRUE if successful, otherwise FALSE. | +
gboolean atspi_event_listener_register_from_callback + (+AtspiEventListenerCB callback
, +void *user_data
, +GDestroyNotify callback_destroyed
, +const gchar *event_type
, +GError **error
);
+Registers an AtspiEventListenerCB against an event_type
.
+
|
+the AtspiEventListenerCB to be registered +against an event type. [scope notified] + | +
|
+User data to be passed to the callback. [closure] + | +
|
+A GDestroyNotify called when the callback is destroyed. | +
|
+a character string indicating the type of events for which +notification is requested. See atspi_event_listener_register +for a description of the format. | +
Returns : |
++TRUE if successfull, otherwise FALSE. | +
gboolean atspi_event_listener_register_no_data + (+AtspiEventListenerSimpleCB callback
, +GDestroyNotify callback_destroyed
, +const gchar *event_type
, +GError **error
);
+Registers an AtspiEventListenetSimpleCB. The method is similar to
+atspi_event_listener_register, but callback
takes no user_data.
+
|
+the AtspiEventListenerSimpleCB to be +registered against an event type. [scope notified] + | +
|
+A GDestroyNotify called when the callback is destroyed. | +
|
+a character string indicating the type of events for which +notification is requested. Format is +EventClass:major_type:minor_type:detail +where all subfields other than EventClass are optional. +EventClasses include "object", "window", "mouse", +and toolkit events (e.g. "Gtk", "AWT"). +Examples: "focus:", "Gtk:GtkWidget:button_press_event". | +
Returns : |
++TRUE if successfull, otherwise FALSE. | +
gboolean atspi_event_listener_deregister (+AtspiEventListener *listener
, +const gchar *event_type
, +GError **error
);
+Deregisters an AtspiEventListener from the registry, for a specific + event type. +
+
|
+The AtspiEventListener to deregister. | +
|
+a string specifying the event type for which this +listener is to be deregistered. | +
Returns : |
++TRUE if successful, otherwise FALSE. | +
gboolean atspi_event_listener_deregister_from_callback + (+AtspiEventListenerCB callback
, +void *user_data
, +const gchar *event_type
, +GError **error
);
+Deregisters an AtspiEventListenerCB from the registry, for a specific + event type. +
+
|
+the AtspiEventListenerCB registered against an +event type. [scope call] + | +
|
+User data that was passed in for this callback. [closure] + | +
|
+a string specifying the event type for which this +listener is to be deregistered. | +
Returns : |
++TRUE if successful, otherwise FALSE. | +
gboolean atspi_event_listener_deregister_no_data + (+AtspiEventListenerSimpleCB callback
, +const gchar *event_type
, +GError **error
);
+deregisters an AtspiEventListenerSimpleCB from the registry, for a specific + event type. +
+
|
+the AtspiEventListenerSimpleCB registered against +an event type. [scope call] + | +
|
+a string specifying the event type for which this +listener is to be deregistered. | +
Returns : |
++TRUE if successful, otherwise FALSE. | +
+ | + | + | libatspi Reference Manual | ++ |
---|---|---|---|---|
+Top + Â |Â + Description + Â |Â + Object Hierarchy + |
+atspi-hyperlink+atspi-hyperlink â Instances of atspi-hyperlink are the means by which end users +and clients interact with linked content. + |
++ |
AtspiHyperlink; +struct AtspiHyperlinkClass; +gint atspi_hyperlink_get_n_anchors (+AtspiHyperlink *obj
, +GError **error
); +gchar * atspi_hyperlink_get_uri (AtspiHyperlink *obj
, +int i
, +GError **error
); +AtspiAccessible * atspi_hyperlink_get_object (AtspiHyperlink *obj
, +gint i
, +GError **error
); +AtspiRange * atspi_hyperlink_get_index_range (AtspiHyperlink *obj
, +GError **error
); +gint atspi_hyperlink_get_start_index (AtspiHyperlink *obj
, +GError **error
); +gint atspi_hyperlink_get_end_index (AtspiHyperlink *obj
, +GError **error
); +gboolean atspi_hyperlink_is_valid (AtspiHyperlink *obj
, +GError **error
); +
+ Instances of atspi-hyperlink are returned by + atspi-hypertext objects, and are the means by + which end users and clients interact with linked, + and in some cases embedded, content. These instances + may have multiple "anchors", where an anchor corresponds to a + reference to a particular resource with a corresponding resource + identified (URI). +
+struct AtspiHyperlinkClass { + AtspiObjectClass parent_class; +}; ++
+
+gint atspi_hyperlink_get_n_anchors (+AtspiHyperlink *obj
, +GError **error
);
+Gets the total number of anchors which an AtspiHyperlink implementor has. +Though typical hyperlinks have only one anchor, client-side image maps and +other hypertext objects may potentially activate or refer to multiple +URIs. For each anchor there is a corresponding URI and object. +
++see: atspi_hyperlink_get_uri and atspi_hyperlink_get_object. +
+
|
+a pointer to the AtspiHyperlink object on which to operate. | +
Returns : |
+a gint indicating the number of anchors in this hyperlink. | +
gchar * atspi_hyperlink_get_uri (+AtspiHyperlink *obj
, +int i
, +GError **error
);
+Gets the URI associated with a particular hyperlink anchor. +
+
|
+a pointer to the AtspiHyperlink implementor on which to operate. | +
|
+a (zero-index) integer indicating which hyperlink anchor to query. | +
Returns : |
+a UTF-8 string giving the URI of the ith hyperlink anchor. |
+
AtspiAccessible * atspi_hyperlink_get_object (+AtspiHyperlink *obj
, +gint i
, +GError **error
);
+Gets the object associated with a particular hyperlink anchor, as an +AtspiAccessible. +
+
|
+a pointer to the AtspiHyperlink implementor on which to operate. | +
|
+a (zero-index) gint indicating which hyperlink anchor to query. | +
Returns : |
+an AtspiAccessible that represents the object
+associated with the ith anchor of the specified AtspiHyperlink. [transfer full]
+ |
+
AtspiRange * atspi_hyperlink_get_index_range (+AtspiHyperlink *obj
, +GError **error
);
+Gets the starting and ending character offsets of the text range +associated with an AtspiHyperlink, in its originating AtspiHypertext. +
+
|
+a pointer to the AtspiHyperlink implementor on which to operate. | +
gint atspi_hyperlink_get_start_index (+AtspiHyperlink *obj
, +GError **error
);
+Gets the starting character offset of the text range associated with + an AtspiHyperlink, in its originating AtspiHypertext. +
+
|
+a pointer to the AtspiHyperlink implementor on which to operate. | +
gint atspi_hyperlink_get_end_index (+AtspiHyperlink *obj
, +GError **error
);
+Gets the ending character offset of the text range associated with + an AtspiHyperlink, in its originating AtspiHypertext. +
+
|
+a pointer to the AtspiHyperlink implementor on which to operate. | +
gboolean atspi_hyperlink_is_valid (+AtspiHyperlink *obj
, +GError **error
);
+Tells whether an AtspiHyperlink object is still valid with respect to its + originating hypertext object. +
+
|
+a pointer to the AtspiHyperlink on which to operate. | +
Returns : |
++TRUE if the specified AtspiHyperlink is still valid with respect +to its originating AtspiHypertext object, FALSE otherwise. | +
+ | + | + | libatspi Reference Manual | ++ |
---|---|---|---|---|
+Top + Â |Â + Description + Â |Â + Object Hierarchy + |
+atspi-matchrule+atspi-matchrule â An interface that allows the definition of match rules +for accessible objects. + |
++ |
struct AtspiMatchRule; +struct AtspiMatchRuleClass; +AtspiMatchRule * atspi_match_rule_new (+AtspiStateSet *states
, +AtspiCollectionMatchType statematchtype
, +GHashTable *attributes
, +AtspiCollectionMatchType attributematchtype
, +GArray *roles
, +AtspiCollectionMatchType rolematchtype
, +GArray *interfaces
, +AtspiCollectionMatchType interfacematchtype
, +gboolean invert
); +
AtspiMatchRule * atspi_match_rule_new (+AtspiStateSet *states
, +AtspiCollectionMatchType statematchtype
, +GHashTable *attributes
, +AtspiCollectionMatchType attributematchtype
, +GArray *roles
, +AtspiCollectionMatchType rolematchtype
, +GArray *interfaces
, +AtspiCollectionMatchType interfacematchtype
, +gboolean invert
);
+Creates a new AtspiMatchRule with specified states
, attributes
,
+interfaces
, and roles
.
+
|
+An AtspiStateSet specifying the states to match or NULL if none. | +
|
+An AtspiCollectionMatchType specifying how to interpret
+states . |
+
|
+A GHashTable specifying +attributes to match. [element-type gchar* gchar*] + | +
|
+An AtspiCollectionMatchType specifying how to
+interpret attributes . |
+
|
+A GArray of roles to match, or NULL if +not applicable. [element-type AtspiRole] + | +
|
+An AtspiCollectionMatchType specifying how to
+interpret roles . |
+
|
+An array of interfaces to match, or +NULL if not applicable. Interface names should be specified +by their DBus names (org.a11y.Atspi.Accessible, +org.a11y.Atspi.Component, etc). [element-type gchar*] + | +
|
+An AtspiCollectionMatchType specifying how to
+interpret interfaces . |
+
|
+if TRUE, the match rule should be denied (inverted); if FALSE, +it should not. For example, if the match rule defines that a match is +an object of ROLE_HEADING which has STATE_FOCUSABLE and a click action, +inverting it would match all objects that are not of ROLE_HEADING, +focusable and clickable at the same time. | +
Returns : |
+A new AtspiMatchRule. [transfer full] + | +
+ | + | + | libatspi Reference Manual | ++ |
---|---|---|---|---|
+Top + Â |Â + Description + Â |Â + Object Hierarchy + |
+ | + | + | libatspi Reference Manual | ++ |
---|---|---|---|---|
+Top + Â |Â + Description + Â |Â + Object Hierarchy + |
+atspi-relation+atspi-relation â An interface via which non-hierarchical relationships + are indicated. + |
++ |
struct AtspiRelation; +struct AtspiRelationClass; +AtspiRelationType atspi_relation_get_relation_type (+AtspiRelation *obj
); +gint atspi_relation_get_n_targets (AtspiRelation *obj
); +AtspiAccessible * atspi_relation_get_target (AtspiRelation *obj
, +gint i
); +
+ An interface via which non-hierarchical relationships + are indicated. An instance of this interface represents + a "one-to-many" correspondance. +
+AtspiRelationType atspi_relation_get_relation_type (AtspiRelation *obj
);
++Gets the type of relationship represented by an AtspiRelation. +
+
|
+a pointer to the AtspiRelation object to query. | +
Returns : |
+an AtspiRelationType indicating the type of relation +encapsulated in this AtspiRelation object. | +
gint atspi_relation_get_n_targets (AtspiRelation *obj
);
++Gets the number of objects which this relationship has as its + target objects (the subject is the AtspiAccessible from which this + AtspiRelation originated). +
+
|
+a pointer to the AtspiRelation object to query. | +
Returns : |
+a gint indicating how many target objects which the +originating AtspiAccessible object has the AtspiRelation +relationship with. | +
AtspiAccessible * atspi_relation_get_target (+AtspiRelation *obj
, +gint i
);
+Gets the i
-th target of a specified AtspiRelation relationship.
+
|
+a pointer to the AtspiRelation object to query. | +
|
+a (zero-index) gint indicating which (of possibly several) target is requested. | +
Returns : |
+an AtspiAccessible which is the i -th object
+with which the originating AtspiAccessible has relationship
+specified in the AtspiRelation object. [transfer full]
+ |
+
+ | + | + | libatspi Reference Manual | ++ |
---|---|---|---|---|
+Top + Â |Â + Description + Â |Â + Object Hierarchy + |
+atspi-stateset+atspi-stateset â The atspi-stateset objects implement wrappers around a +bitmap of accessible states. + |
++ |
struct AtspiStateSet; +struct AtspiStateSetClass; +AtspiStateSet * atspi_state_set_new (+GArray *states
); +void atspi_state_set_set_by_name (AtspiStateSet *set
, +const gchar *name
, +gboolean enabled
); +void atspi_state_set_add (AtspiStateSet *set
, +AtspiStateType state
); +AtspiStateSet * atspi_state_set_compare (AtspiStateSet *set
, +AtspiStateSet *set2
); +gboolean atspi_state_set_contains (AtspiStateSet *set
, +AtspiStateType state
); +gboolean atspi_state_set_equals (AtspiStateSet *set
, +AtspiStateSet *set2
); +GArray * atspi_state_set_get_states (AtspiStateSet *set
); +gboolean atspi_state_set_is_empty (AtspiStateSet *set
); +void atspi_state_set_remove (AtspiStateSet *set
, +AtspiStateType state
); +
+The atspi-stateset objects implement wrappers around a +bitmap of accessible states. +
+AtspiStateSet * atspi_state_set_new (GArray *states
);
+
+Generates an AtspiStateSet with the given states
.
+
|
+An array of states with which the +method initializes the state set. [element-type AtspiStateType] + | +
Returns : |
+A new AtspiStateSet with the given states. | +
void atspi_state_set_set_by_name (+AtspiStateSet *set
, +const gchar *name
, +gboolean enabled
);
+Enables/disables a state in an AtspiStateSet according to its name
.
+
|
+a pointer to the AtspiStateSet object on which to operate. | +
|
+a string corresponding to a state name. | +
|
+if TRUE, name should be enabled in the set in question;
+otherwise, it should be disabled. |
+
void atspi_state_set_add (+AtspiStateSet *set
, +AtspiStateType state
);
+Adds a particular AtspiState to an AtspiStateSet (i.e. sets the + given state to TRUE in the stateset). +
+
|
+a pointer to the AtspiStateSet object on which to operate. | +
|
+an AtspiStateType to be added to the specified AtspiStateSet. | +
AtspiStateSet * atspi_state_set_compare (+AtspiStateSet *set
, +AtspiStateSet *set2
);
+Determines the differences between two instances of AtspiStateSet. +
+
+see
atspi_state_set_equals.
+
|
+a pointer to the first AtspiStateSet object on which to operate. | +
|
+a pointer to the second AtspiStateSet object on which to operate. | +
Returns : |
+an AtspiStateSet object containing all states +contained on one of the two sets but not the other. [transfer full] + | +
gboolean atspi_state_set_contains (+AtspiStateSet *set
, +AtspiStateType state
);
+Determines whether a given AtspiStateSet includes a given state; that is,
+ whether state
is true for the set
in question.
+
|
+a pointer to the AtspiStateSet object on which to operate. | +
|
+an AtspiStateType for which the specified AtspiStateSet +will be queried. | +
Returns : |
+
+TRUE if state is true/included in the given AtspiStateSet,
+otherwise FALSE. |
+
gboolean atspi_state_set_equals (+AtspiStateSet *set
, +AtspiStateSet *set2
);
+Determines whether two instances of AtspiStateSet are equivalent (i.e. + consist of the same AtspiStates). Useful for checking multiple + state variables at once. +
+
+see
atspi_state_set_compare.
+
|
+a pointer to the first AtspiStateSet object on which to operate. | +
|
+a pointer to the second AtspiStateSet object on which to operate. | +
Returns : |
++TRUE if the two AtspiStateSets are equivalent, +otherwise FALSE. | +
GArray * atspi_state_set_get_states (AtspiStateSet *set
);
++Returns the states in an AtspiStateSet as an array. +
+
|
+The AtspiStateSet to be queried. | +
Returns : |
+A GArray of state +types representing the current state. [element-type AtspiStateType][transfer full] + | +
gboolean atspi_state_set_is_empty (AtspiStateSet *set
);
+
|
+The AtspiStateSet to query. | +
Returns : |
++TRUE if the state set contains no states; FALSE otherwise. | +
void atspi_state_set_remove (+AtspiStateSet *set
, +AtspiStateType state
);
+Removes a particular AtspiState to an AtspiStateSet (i.e. sets the + given state to FALSE in the stateset.) +
+
|
+a pointer to the AtspiStateSet object on which to operate. | +
|
+an AtspiStateType to remove from the specified set . |
+
+ | Â | ++ | libatspi Reference Manual | +Â | +
---|---|---|---|---|
+O + Â |Â + A + Â |Â + E + Â |Â + S + Â |Â + T + Â |Â + C + Â |Â + S + |
Parameter for returning results. Default is transfer full.
NULL is ok, both for passing and for returning.
Generics and defining elements of containers and arrays.
The callback is valid only during the call to the method.
Free data after the code is done.
This parameter is a 'user_data', for callbacks; many bindings can pass NULL here.
The callback is valid until the GDestroyNotify argument is called.
+ | Â | ++ | libatspi Reference Manual | ++ |
---|---|---|---|---|
+A + Â |Â + B + Â |Â + C + Â |Â + D + Â |Â + E + Â |Â + G + Â |Â + H + Â |Â + I + Â |Â + K + Â |Â + L + Â |Â + M + Â |Â + O + Â |Â + P + Â |Â + R + Â |Â + S + Â |Â + T + Â |Â + V + |
+ | Â | ++ | libatspi Reference Manual | ++ |
---|
libatspi Reference Manual |
---|
+ for libatspi 2.1. + The latest version of this documentation can be found on-line at + http://developer.gnome.org/libatspi/. +