Top | ![]() |
![]() |
![]() |
![]() |
AtspiAccessible implements AtspiAction, AtspiCollection, AtspiComponent, AtspiDocument, AtspiEditableText, AtspiHypertext, AtspiImage, AtspiSelection, AtspiTable, AtspiText and AtspiValue.
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.
gchar * atspi_accessible_get_description (AtspiAccessible *obj
,GError **error
);
Gets the description of an AtspiAccessible object.
AtspiAccessible * atspi_accessible_get_parent (AtspiAccessible *obj
,GError **error
);
Gets an AtspiAccessible object's parent container.
a pointer to the
AtspiAccessible object which contains the given
AtspiAccessible instance, or NULL if the obj
has no
parent container.
[nullable][transfer full]
gint atspi_accessible_get_child_count (AtspiAccessible *obj
,GError **error
);
Gets the number of children contained by an AtspiAccessible object.
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.
obj |
a pointer to the AtspiAccessible object on which to operate. |
|
child_index |
a long indicating which child is specified. |
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 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 GArray of AtspiRelation pointers or NULL on exception.
[element-type AtspiRelation*][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()
.
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()
.
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 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.
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.
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.
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 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 UTF-8 string indicating the toolkit version for the AtspiAccessible object or NULL on exception.
gchar * atspi_accessible_get_atspi_version (AtspiAccessible *obj
,GError **error
);
Gets the AT-SPI IPC specification version supported by the application pointed to by the AtspiAccessible object. Only works on application root objects.
a UTF-8 string indicating the AT-SPI version for the AtspiAccessible object or NULL on exception.
gint atspi_accessible_get_id (AtspiAccessible *obj
,GError **error
);
Gets the application id for a AtspiAccessible object. Only works on application root objects.
AtspiAccessible * atspi_accessible_get_application (AtspiAccessible *obj
,GError **error
);
Gets the containing AtspiApplication for an object.
AtspiAction *
atspi_accessible_get_action (AtspiAccessible *obj
);
atspi_accessible_get_action
has been deprecated since version 2.10 and should not be used in newly-written code.
Use atspi_accessible_get_action_iface instead.
Gets the AtspiAction interface for an AtspiAccessible.
[rename-to atspi_accessible_get_action_iface]
a pointer to an AtspiAction interface
instance, or NULL if obj
does not implement AtspiAction.
[transfer full]
AtspiCollection *
atspi_accessible_get_collection (AtspiAccessible *obj
);
atspi_accessible_get_collection
has been deprecated since version 2.10 and should not be used in newly-written code.
Use atspi_accessible_get_collection_iface instead.
Gets the AtspiCollection interface for an AtspiAccessible.
[rename-to atspi_accessible_get_collection_iface]
a pointer to an AtspiCollection interface
instance, or NULL if obj
does not implement AtspiCollection.
[transfer full]
AtspiComponent *
atspi_accessible_get_component (AtspiAccessible *obj
);
atspi_accessible_get_component
has been deprecated since version 2.10 and should not be used in newly-written code.
Use atspi_accessible_get_component_iface instead.
Gets the AtspiComponent interface for an AtspiAccessible.
[rename-to atspi_accessible_get_component_iface]
a pointer to an AtspiComponent interface
instance, or NULL if obj
does not implement AtspiComponent.
[transfer full]
AtspiDocument *
atspi_accessible_get_document (AtspiAccessible *obj
);
atspi_accessible_get_document
has been deprecated since version 2.10 and should not be used in newly-written code.
Use atspi_accessible_get_document_iface instead.
Gets the AtspiDocument interface for an AtspiAccessible.
[rename-to atspi_accessible_get_document_iface]
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
);
atspi_accessible_get_editable_text
has been deprecated since version 2.10 and should not be used in newly-written code.
Use atspi_accessible_get_editable_text_iface instead.
Gets the AtspiEditableText interface for an AtspiAccessible.
[rename-to atspi_accessible_get_editable_text_iface]
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.
the AtspiHyperlink object associated with the given AtspiAccessible, or NULL if not supported.
[transfer full]
AtspiHypertext *
atspi_accessible_get_hypertext (AtspiAccessible *obj
);
atspi_accessible_get_hypertext
has been deprecated since version 2.10 and should not be used in newly-written code.
Use atspi_accessible_get_hypertext_iface instead.
Gets the AtspiHypertext interface for an AtspiAccessible.
[rename-to atspi_accessible_get_hypertext_iface]
a pointer to an AtspiHypertext interface
instance, or NULL if obj
does not implement AtspiHypertext.
[transfer full]
AtspiImage *
atspi_accessible_get_image (AtspiAccessible *obj
);
atspi_accessible_get_image
has been deprecated since version 2.10 and should not be used in newly-written code.
Use atspi_accessible_get_image_iface instead.
Gets the AtspiImage interface for an AtspiAccessible.
[rename-to atspi_accessible_get_image_iface]
a pointer to an AtspiImage interface instance, or
NULL if obj
does not implement AtspiImage.
[transfer full]
AtspiSelection *
atspi_accessible_get_selection (AtspiAccessible *obj
);
atspi_accessible_get_selection
has been deprecated since version 2.10 and should not be used in newly-written code.
Use atspi_accessible_get_selection_iface instead.
Gets the AtspiSelection interface for an AtspiAccessible.
[rename-to atspi_accessible_get_selection_iface]
a pointer to an AtspiSelection interface
instance, or NULL if obj
does not implement AtspiSelection.
[transfer full]
AtspiTable *
atspi_accessible_get_table (AtspiAccessible *obj
);
atspi_accessible_get_table
has been deprecated since version 2.10 and should not be used in newly-written code.
Use atspi_accessible_get_table_iface instead.
Gets the AtspiTable interface for an AtspiAccessible.
[rename-to atspi_accessible_get_table_iface]
a pointer to an AtspiTable interface instance, or
NULL if obj
does not implement AtspiTable.
[transfer full]
AtspiTableCell *
atspi_accessible_get_table_cell (AtspiAccessible *obj
);
Gets the AtspiTableCell interface for an AtspiAccessible.
a pointer to an AtspiTableCell interface instance,
or NULL if obj
does not implement AtspiTable.
[transfer full]
AtspiText *
atspi_accessible_get_text (AtspiAccessible *obj
);
atspi_accessible_get_text
has been deprecated since version 2.10 and should not be used in newly-written code.
Use atspi_accessible_get_text_iface instead.
Gets the AtspiTable interface for an AtspiAccessible.
[rename-to atspi_accessible_get_text_iface]
AtspiValue *
atspi_accessible_get_value (AtspiAccessible *obj
);
atspi_accessible_get_value
has been deprecated since version 2.10 and should not be used in newly-written code.
Use atspi_accessible_get_value_iface instead.
Gets the AtspiTable interface for an AtspiAccessible.
[rename-to atspi_accessible_get_value_iface]
a pointer to an AtspiValue interface instance, or
NULL if obj
does not implement AtspiValue.
[transfer full]
const gchar * atspi_accessible_get_object_locale (AtspiAccessible *accessible
,GError **error
);
void atspi_accessible_set_cache_mask (AtspiAccessible *accessible
,AtspiCache mask
);
Sets the type of data to cache for accessibles. If this is not set for an application or is reset to ATSPI_CACHE_UNDEFINED, then the desktop's cache flag will be used. If the desktop's cache flag is also undefined, then all possible data will be cached. This function is intended to work around bugs in toolkits where the proper events are not raised / to aid in testing for such bugs.
accessible |
The AtspiAccessible to operate on. Must be the desktop or the root of an application. |
|
mask |
An AtspiCache specifying a bit mask of the types of data to cache. |
void
atspi_accessible_clear_cache (AtspiAccessible *obj
);
Clears the cached information for the given accessible and all of its descendants.
guint atspi_accessible_get_process_id (AtspiAccessible *accessible
,GError **error
);
Returns the process id associated with the given accessible. Mainly added for debugging; it is a shortcut to explicitly querying the accessible's app->bus_name and then calling GetConnectionUnixProcessID.
AtspiAction *
atspi_accessible_get_action_iface (AtspiAccessible *obj
);
Gets the AtspiAction interface for an AtspiAccessible.
a pointer to an AtspiAction interface
instance, or NULL if obj
does not implement AtspiAction.
[transfer full]
AtspiCollection *
atspi_accessible_get_collection_iface (AtspiAccessible *obj
);
Gets the AtspiCollection interface for an AtspiAccessible.
a pointer to an AtspiCollection interface
instance, or NULL if obj
does not implement AtspiCollection.
[transfer full]
AtspiComponent *
atspi_accessible_get_component_iface (AtspiAccessible *obj
);
Gets the AtspiComponent interface for an AtspiAccessible.
a pointer to an AtspiComponent interface
instance, or NULL if obj
does not implement AtspiComponent.
[transfer full]
AtspiDocument *
atspi_accessible_get_document_iface (AtspiAccessible *obj
);
Gets the AtspiDocument interface for an AtspiAccessible.
a pointer to an AtspiDocument interface
instance, or NULL if obj
does not implement AtspiDocument.
[transfer full]
AtspiEditableText *
atspi_accessible_get_editable_text_iface
(AtspiAccessible *obj
);
Gets the AtspiEditableText interface for an AtspiAccessible.
a pointer to an AtspiEditableText interface
instance, or NULL if obj
does not implement AtspiEditableText.
[transfer full]
AtspiHypertext *
atspi_accessible_get_hypertext_iface (AtspiAccessible *obj
);
Gets the AtspiHypertext interface for an AtspiAccessible.
a pointer to an AtspiHypertext interface
instance, or NULL if obj
does not implement AtspiHypertext.
[transfer full]
AtspiImage *
atspi_accessible_get_image_iface (AtspiAccessible *obj
);
Gets the AtspiImage interface for an AtspiAccessible.
a pointer to an AtspiImage interface instance, or
NULL if obj
does not implement AtspiImage.
[transfer full]
AtspiSelection *
atspi_accessible_get_selection_iface (AtspiAccessible *obj
);
Gets the AtspiSelection interface for an AtspiAccessible.
a pointer to an AtspiSelection interface
instance, or NULL if obj
does not implement AtspiSelection.
[transfer full]
AtspiTable *
atspi_accessible_get_table_iface (AtspiAccessible *obj
);
Gets the AtspiTable interface for an AtspiAccessible.
a pointer to an AtspiTable interface instance, or
NULL if obj
does not implement AtspiTable.
[transfer full]
AtspiText *
atspi_accessible_get_text_iface (AtspiAccessible *obj
);
Gets the AtspiTable interface for an AtspiAccessible.
AtspiValue *
atspi_accessible_get_value_iface (AtspiAccessible *obj
);
Gets the AtspiTable interface for an AtspiAccessible.
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.
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]