![]() |
![]() |
![]() |
libatspi Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces |
AtspiAccessible; AtspiAccessibleClass; AtspiAccessible * atspi_accessible_new (AtspiApplication *app
,const gchar *path
); 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.
AtspiAccessible * atspi_accessible_new (AtspiApplication *app
,const gchar *path
);
|
|
|
|
Returns : |
gchar * atspi_role_get_name (AtspiRole role
);
Get a localizeable string that indicates the name of an AtspiAccessibleRole. <em>DEPRECATED.</em>
|
an AtspiAccessibleRole object to query. |
Returns : |
a localizable string name for an AtspiAccessibleRole enumerated type. |
gchar * atspi_accessible_get_name (AtspiAccessible *obj
,GError **error
);
Get 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
);
Get 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
);
Get 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
);
Get 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
);
Get 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
);
Get the index of an AtspiAccessible object in its containing AtspiAccessible.
|
a pointer to the AtspiAccessible object on which to operate. |
|
|
Returns : |
a glong indicating the index of the AtspiAccessible object
in its parent (i.e. containing) AtspiAccessible instance,
or -1 if obj has no containing parent or on exception.
|
GArray * atspi_accessible_get_relation_set (AtspiAccessible *obj
,GError **error
);
Get the set of AtspiRelation objects which describe this AtspiAccessible object's relationships with other AtspiAccessible objects.
|
a pointer to the AtspiAccessible object on which to operate. |
|
|
Returns : |
an array of AtspiAccessibleRelation pointers. or NULL on exception. element-type AtspiAccessible*. transfer full AtspiAccessible*. |
AtspiRole atspi_accessible_get_role (AtspiAccessible *obj
,GError **error
);
Get the UI role of an AtspiAccessible object.
A UTF-8 string describing this role can be obtained via atspi_accessible_getRoleName()
.
|
a pointer to the AtspiAccessible object on which to operate. |
|
|
Returns : |
the AtspiRole of the object. |
gchar * atspi_accessible_get_role_name (AtspiAccessible *obj
,GError **error
);
Get a UTF-8 string describing the role this object plays in the UI.
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 UTF-8 string specifying the role of this AtspiAccessible object. |
gchar * atspi_accessible_get_localized_role_name (AtspiAccessible *obj
,GError **error
);
Get a UTF-8 string describing the (localized) role this object plays in the UI.
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 UTF-8 string specifying the role of this AtspiAccessible object. |
AtspiStateSet * atspi_accessible_get_state_set (AtspiAccessible *obj
);
Gets the current state of an object.
|
a pointer to the AtspiAccessible object on which to operate. |
Returns : |
a pointer to an AtspiStateSet representing the object's current state.. transfer full. |
GHashTable * atspi_accessible_get_attributes (AtspiAccessible *obj
,GError **error
);
Get 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 gchar* gchar*. |
GArray * atspi_accessible_get_attributes_as_array (AtspiAccessible *obj
,GError **error
);
Get 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_as_array instead.
|
The AtspiAccessible being queried. |
|
|
Returns : |
The name-value-pair attributes assigned to this object.. element-type gchar*. transfer full gchar*. |
gchar * atspi_accessible_get_toolkit_name (AtspiAccessible *obj
,GError **error
);
Get the toolkit for a 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
);
Get the toolkit version for a 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 ersion for the AtspiAccessible object. or NULL on exception |
AtspiAccessible * atspi_accessible_get_application (AtspiAccessible *obj
,GError **error
);
Get 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
);
Get 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
);
Get 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
);
Get 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
);
Get 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
);
Get 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
);
Get the AtspiHyperlink associated with the given AtspiAccessible, if supported.
|
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
);
Get 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
);
Get 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
);
Get 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
);
Get 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
);
Get 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
);
Get 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
);
obj: The AtspiAccessible to query.
|
|
Returns : |
A GArray of strings describing the interfaces supported by the object. Interfaces are denoted in short-hand (ie, "Component", "Text", etc.). element-type gchar*. transfer full gchar*. |