Class
AtspiAccessible
Description [src]
class Atspi.Accessible : Atspi.Object
implements Atspi.Action, Atspi.Collection, Atspi.Component, Atspi.Document, Atspi.EditableText, Atspi.Hypertext, Atspi.Image, Atspi.Selection, Atspi.Table, Atspi.TableCell, Atspi.Text, Atspi.Value {
accessible_parent: AtspiAccessible*,
children: GPtrArray*,
role: AtspiRole,
interfaces: gint,
name: char*,
description: char*,
states: AtspiStateSet*,
attributes: GHashTable*,
cached_properties: guint,
priv: AtspiAccessiblePrivate*
}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.
Instance methods
atspi_accessible_clear_cache
Clears the cached information for the given accessible and all of its descendants.
atspi_accessible_get_accessible_id
Gets the accessible id of the accessible. This is not meant to be presented to the user, but to be an id which is stable over application development. Typically, this is the gtkbuilder id.
since: 2.34
atspi_accessible_get_atspi_version
Gets the AT-SPI IPC specification version supported by the application
pointed to by the AtspiAccessible object.
Only works on application root objects.
atspi_accessible_get_attributes
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.
atspi_accessible_get_attributes_as_array
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.
atspi_accessible_get_child_at_index
Gets the AtspiAccessible child of an AtspiAccessible object at a given index.
atspi_accessible_get_child_count
Gets the number of children contained by an AtspiAccessible object.
atspi_accessible_get_collection
Gets the AtspiCollection interface for an AtspiAccessible.
deprecated: 2.10
atspi_accessible_get_component
Gets the AtspiComponent interface for an AtspiAccessible.
deprecated: 2.10
atspi_accessible_get_document
Gets the AtspiDocument interface for an AtspiAccessible.
deprecated: 2.10
atspi_accessible_get_editable_text
Gets the AtspiEditableText interface for an AtspiAccessible.
deprecated: 2.10
atspi_accessible_get_editable_text_iface
Gets the AtspiEditableText interface for an AtspiAccessible.
atspi_accessible_get_help_text
Gets the help text associated with the accessible, if set. When this is present, it provides information that a screen reader can relay to the user to explain how to interact with the object.
since: 2.52
atspi_accessible_get_hypertext
Gets the AtspiHypertext interface for an AtspiAccessible.
deprecated: 2.10
atspi_accessible_get_id
Gets the application id for a AtspiAccessible object.
Only works on application root objects.
atspi_accessible_get_index_in_parent
Gets the index of an AtspiAccessible object within its parent’s
AtspiAccessible children list.
atspi_accessible_get_interfaces
A set of pointers to all interfaces supported by an AtspiAccessible.
atspi_accessible_get_localized_role_name
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 ().
atspi_accessible_get_process_id
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.
atspi_accessible_get_relation_set
Gets the set of AtspiRelation objects which describes this AtspiAccessible object’s
relationships with other AtspiAccessible objects.
atspi_accessible_get_role
Gets the UI role played by an AtspiAccessible object.
This role’s name can be obtained via atspi_accessible_get_role_name ().
atspi_accessible_get_role_name
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 ().
atspi_accessible_get_selection
Gets the AtspiSelection interface for an AtspiAccessible.
deprecated: 2.10
atspi_accessible_get_toolkit_name
Gets the toolkit name for an AtspiAccessible object.
Only works on application root objects.
atspi_accessible_get_toolkit_version
Gets the toolkit version for an AtspiAccessible object.
Only works on application root objects.
atspi_accessible_set_cache_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.
Methods inherited from AtspiAction (8)
atspi_action_do_action
Invoke the action indicated by #index.
atspi_action_get_action_description
Get the description of ‘i-th’ action invocable on an
object implementing AtspiAction.
atspi_action_get_action_name
Get the name of the ‘i-th’ action invocable on an
object implementing AtspiAction.
atspi_action_get_description
Get the description of ‘i-th’ action invocable on an
object implementing AtspiAction.
deprecated: 2.10
atspi_action_get_key_binding
Get the keybindings for the i-th action invocable on an
object implementing AtspiAction, if any are defined.
The keybindings string format is as follows:
there are multiple parts to a keybinding string (typically 3).
They are delimited with “;”. The first is the action’s
keybinding which is usable if the object implementing the action
is currently posted to the screen, e.g. if a menu is posted
then these keybindings for the corresponding menu-items are
available. The second keybinding substring is the full key sequence
necessary to post the action’s widget and activate it, e.g. for
a menu item such as “File->Open” it would both post the menu and
activate the item. Thus the second keybinding string is available
during the lifetime of the containing toplevel window as a whole,
whereas the first keybinding string only works while the object
implementing AtkAction is posted. The third (and optional)
keybinding string is the “keyboard shortcut” which invokes the
action without posting any menus.
Meta-keys are indicated by the conventional strings
“<Control>”, “<Alt>”, “<Shift>”, “<Mod2>”,
etc. (we use the same string as gtk_accelerator_name() in gtk+-2.X.
atspi_action_get_localized_name
Get the name of the ‘i-th’ action invocable on an
object implementing AtspiAction.
atspi_action_get_n_actions
Get the number of actions invokable on an AtspiAction implementor.
atspi_action_get_name
Get the name of the ‘i-th’ action invocable on an
object implementing AtspiAction.
deprecated: 2.10
Methods inherited from AtspiCollection (5)
atspi_collection_get_active_descendant
atspi_collection_get_matches
Gets all AtspiAccessible objects from the collection matching a given
rule.
atspi_collection_get_matches_from
Gets all AtspiAccessible objects from the collection, before
current_object, matching a given rule.
atspi_collection_get_matches_to
Gets all AtspiAccessible objects from the collection, after
current_object, matching a given rule.
atspi_collection_is_ancestor_of
Not yet implemented.
Methods inherited from AtspiComponent (14)
atspi_component_contains
Queries whether a given AtspiComponent contains a particular point.
atspi_component_get_accessible_at_point
Gets the accessible child at a given coordinate within an AtspiComponent.
atspi_component_get_alpha
Gets the opacity/alpha value of a component, if alpha blending is in use.
atspi_component_get_extents
Gets the bounding box of the specified AtspiComponent.
The returned values are meaningful only if the Component has both
STATE_VISIBLE and STATE_SHOWING.
atspi_component_get_layer
Queries which layer the component is painted into, to help determine its visibility in terms of stacking order.
atspi_component_get_mdi_z_order
Queries the z stacking order of a component which is in the MDI or window layer. (Bigger z-order numbers mean nearer the top).
atspi_component_get_position
Gets the minimum x and y coordinates of the specified AtspiComponent.
The returned values are meaningful only if the Component has both
STATE_VISIBLE and STATE_SHOWING.
atspi_component_get_size
Gets the size of the specified AtspiComponent.
The returned values are meaningful only if the Component has both
STATE_VISIBLE and STATE_SHOWING.
atspi_component_grab_focus
Attempts to set the keyboard input focus to the specified
AtspiComponent.
atspi_component_scroll_to
Scrolls whatever container of the AtspiComponent object so it becomes
visible on the screen.
atspi_component_scroll_to_point
Scrolls whatever container of the AtspiComponent object so it becomes
visible on the screen at a given position.
atspi_component_set_extents
Moves and resizes the specified component.
atspi_component_set_position
Moves the component to the specified position.
atspi_component_set_size
Resizes the specified component to the given pixel dimensions.
Methods inherited from AtspiDocument (9)
atspi_document_get_attribute_value
Gets the value of a single attribute, if specified for the document as a whole.
deprecated: 2.10
atspi_document_get_attributes
Gets all constant attributes for the document as a whole. For attributes
that change within the document content, see atspi_text_get_attribute_run instead.
deprecated: 2.10
atspi_document_get_current_page_number
Gets the current page number of an AccessibleDocument object.
atspi_document_get_document_attribute_value
Gets the value of a single attribute, if specified for the document as a whole.
atspi_document_get_document_attributes
Gets all constant attributes for the document as a whole. For attributes
that change within the document content, see atspi_text_get_attribute_run instead.
atspi_document_get_locale
Gets the locale associated with the document’s content, e.g. the locale for LOCALE_TYPE_MESSAGES.
atspi_document_get_page_count
Gets the page count of an AccessibleDocument object.
atspi_document_get_text_selections
Returns an array of AtspiTextSelections within this document.
since: 2.52
atspi_document_set_text_selections
Makes 1 or more selections within this document denoted by the given array of AtspiTextSelections. Any existing physical selection (inside or outside this document) is replaced by the new selections. All objects within the given selection ranges must be descendants of this document. Otherwise FALSE will be returned.
since: 2.52
Methods inherited from AtspiEditableText (6)
atspi_editable_text_copy_text
Copies text from an AtspiEditableText object into the system clipboard.
atspi_editable_text_cut_text
Deletes text from an AtspiEditableText object, copying the
excised portion into the system clipboard.
atspi_editable_text_delete_text
Deletes text from an AtspiEditableText object, without copying the
excised portion into the system clipboard.
atspi_editable_text_insert_text
Inserts text into an AtspiEditableText object.
As with all character offsets, the specified position may not be the
same as the resulting byte offset, since the text is in a
variable-width encoding.
atspi_editable_text_paste_text
Inserts text from the system clipboard into an AtspiEditableText object.
As with all character offsets, the specified position may not be the
same as the resulting byte offset, since the text is in a
variable-width encoding.
atspi_editable_text_set_text_contents
Replace the entire text contents of an AtspiEditableText object.
Methods inherited from AtspiHypertext (3)
atspi_hypertext_get_link
Gets the AtspiHyperlink object at a specified index.
atspi_hypertext_get_link_index
Gets the index of the AtspiHyperlink object at a specified
character offset.
atspi_hypertext_get_n_links
Gets the total number of AtspiHyperlink objects that an
AtspiHypertext implementor has.
Methods inherited from AtspiImage (5)
atspi_image_get_image_description
Gets the description of the image displayed in an AtspiImage object.
atspi_image_get_image_extents
Gets the bounding box of the image displayed in a
specified AtspiImage implementor.
The returned values are meaningful only if the Image has both
STATE_VISIBLE and STATE_SHOWING.
atspi_image_get_image_locale
Gets the locale associated with an image and its textual representation.
atspi_image_get_image_position
Gets the minimum x and y coordinates of the image displayed in a
specified AtspiImage implementor.
The returned values are meaningful only if the Image has both
STATE_VISIBLE and STATE_SHOWING.
atspi_image_get_image_size
Gets the size of the image displayed in a specified AtspiImage object.
The returned values are meaningful only if the Image has both
STATE_VISIBLE and STATE_SHOWING.
Methods inherited from AtspiSelection (8)
atspi_selection_clear_selection
Clears the current selection, removing all selected children from the
specified AtspiSelection implementor’s selection list.
atspi_selection_deselect_child
Deselects a specific child of an AtspiSelection.
Note that child_index is the index of the child
in the parent container.
atspi_selection_deselect_selected_child
Removes a child from the selected children list of an AtspiSelection.
Note that child_index is the index in the selected-children list,
not the index in the parent container. selectedChildIndex in this
method, and child_index in #atspi_selection_select_child
are asymmetric.
atspi_selection_get_n_selected_children
Gets the number of children of an AtspiSelection implementor which are
currently selected.
atspi_selection_get_selected_child
Gets the i-th selected AtspiAccessible child of an AtspiSelection.
Note that selected_child_index refers to the index in the list
of ‘selected’
children and generally differs from that used in
#atspi_accessible_get_child_at_index or returned by
#atspi_accessible_get_index_in_parent.
selected_child_index must lie between 0
and #atspi_selection_get_n_selected_children - 1, inclusive.
atspi_selection_is_child_selected
Determines whether a particular child of an AtspiSelection implementor
is currently selected. Note that child_index is the index into the
standard AtspiAccessible container’s list of children.
atspi_selection_select_all
Attempts to select all of the children of an AtspiSelection implementor.
Not all AtspiSelection implementors support this operation.
atspi_selection_select_child
Adds a child to the selected children list of an AtspiSelection.
For AtspiSelection implementors that only allow
single selections, this may replace the (single) current selection.
Methods inherited from AtspiTable (26)
Please see AtspiTable for a full list of methods.
Methods inherited from AtspiTableCell (8)
atspi_table_cell_get_column_header_cells
Returns the column headers as an array of cell accessibles.
atspi_table_cell_get_column_index
atspi_table_cell_get_column_span
Returns the number of columns occupied by this cell accessible. The returned values are meaningful only if the table cell has both STATE_VISIBLE and STATE_SHOWING.
atspi_table_cell_get_position
Retrieves the tabular position of this cell.
atspi_table_cell_get_row_column_span
Gets the row and column indexes and extents of this cell accessible. The returned values are meaningful only if the table cell has both STATE_VISIBLE and STATE_SHOWING.
atspi_table_cell_get_row_header_cells
Returns the row headers as an array of cell accessibles.
atspi_table_cell_get_row_span
Returns the number of rows occupied by this cell accessible. The returned values are meaningful only if the table cell has both STATE_VISIBLE and STATE_SHOWING.
atspi_table_cell_get_table
Returns a reference to the accessible of the containing table.
Methods inherited from AtspiValue (6)
atspi_value_get_current_value
Gets the current value for an AtspiValue.
atspi_value_get_maximum_value
Gets the maximum allowed value for an AtspiValue.
atspi_value_get_minimum_increment
Gets the minimum increment by which an AtspiValue can be adjusted.
atspi_value_get_minimum_value
Gets the minimum allowed value for an AtspiValue.
atspi_value_get_text
Gets the human readable text alternative associated with the value.
text is a newly created string, that must be freed by the
caller. Can be NULL if no descriptor is available.
since: 2.46
atspi_value_set_current_value
Sets the current value of an AtspiValue.
Signals
Atspi.Accessible::mode-changed
The signal “mode-changed” is emitted by a screen reader to indicate that its mode has changed. This signal supports the following details: focus-tracking flat-review mouse-review say-all caret-tracking.
Atspi.Accessible::region-changed
The signal “region-changed” is emitted by a screen reader to indicate that it is now reading or tracking a new object, or, a new piece of text within an object. This allows a magnifier to gain the information needed to highlight the object that the screen reader is reading.
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Class structure
struct AtspiAccessibleClass {
AtspiObjectClass parent_class;
void (* region_changed) (
AtspiAccessible* accessible,
gint current_offset,
gint last_offset
);
void (* mode_changed) (
AtspiAccessible* accessible,
gboolean enabled
);
}No description available.
Class members
parent_class: AtspiObjectClassNo description available.
region_changed: void (* region_changed) ( AtspiAccessible* accessible, gint current_offset, gint last_offset )No description available.
mode_changed: void (* mode_changed) ( AtspiAccessible* accessible, gboolean enabled )No description available.