Accessible

Accessible

Object Hierarchy:

Description:

[ CCode ( type_id = "atspi_accessible_get_type ()" ) ]
public class Accessible : Object, Action, Collection, Component, Document, EditableText, Hypertext, Image, Selection, Table, TableCell, Text, Value

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.

Namespace: Atspi

Package: atspi-2

Content:

Creation methods:

protected Accessible ()

Methods:

public void clear_cache ()
Clears the cached information for the given accessible and all of its descendants.
public string get_accessible_id () throws Error
Gets the accessible id of the accessible.
public Action get_action ()
Gets the Action interface for an Accessible.
public Action get_action_iface ()
Gets the Action interface for an Accessible.
public Accessible get_application () throws Error
Gets the containing Application for an object.
public string get_atspi_version () throws Error
Gets the AT-SPI IPC specification version supported by the application pointed to by the Accessible object.
public HashTable<string,string> get_attributes () throws Error
Gets the AttributeSet representing any assigned name-value pair attributes or annotations for this object.
public Array<string> get_attributes_as_array () throws Error
Gets a Array representing any assigned name-value pair attributes or annotations for this object.
public Accessible get_child_at_index (int child_index) throws Error
Gets the Accessible child of an Accessible object at a given index.
public int get_child_count () throws Error
Gets the number of children contained by an Accessible object.
public Collection get_collection ()
Gets the Collection interface for an Accessible.
public Collection get_collection_iface ()
Gets the Collection interface for an Accessible.
public Component get_component ()
Gets the Component interface for an Accessible.
public Component get_component_iface ()
Gets the Component interface for an Accessible.
public string get_description () throws Error
Gets the description of an Accessible object.
public Document get_document ()
Gets the Document interface for an Accessible.
public Document get_document_iface ()
Gets the Document interface for an Accessible.
public EditableText get_editable_text ()
Gets the EditableText interface for an Accessible.
public EditableText get_editable_text_iface ()
Gets the EditableText interface for an Accessible.
public Hyperlink get_hyperlink ()
Gets the Hyperlink interface for an Accessible.
public Hypertext get_hypertext ()
Gets the Hypertext interface for an Accessible.
public Hypertext get_hypertext_iface ()
Gets the Hypertext interface for an Accessible.
public int get_id () throws Error
Gets the application id for a Accessible object.
public Image get_image ()
Gets the Image interface for an Accessible.
public Image get_image_iface ()
Gets the Image interface for an Accessible.
public int get_index_in_parent () throws Error
Gets the index of an Accessible object within its parent's Accessible children list.
public Array<string> get_interfaces ()
A set of pointers to all interfaces supported by an Accessible.
public string get_localized_role_name () throws Error
Gets a UTF-8 string corresponding to the name of the role played by an object, translated to the current locale.
public string get_name () throws Error
Gets the name of an Accessible object.
public unowned string get_object_locale () throws Error
public Accessible? get_parent () throws Error
Gets an Accessible object's parent container.
public uint get_process_id () throws Error
Returns the process id associated with the given accessible.
public Array<Relation> get_relation_set () throws Error
Gets the set of Relation objects which describes this Accessible object's relationships with other Accessible objects.
public Role get_role () throws Error
Gets the UI role played by an Accessible object.
public string get_role_name () throws Error
Gets a UTF-8 string corresponding to the name of the role played by an object.
public Selection get_selection ()
Gets the Selection interface for an Accessible.
public Selection get_selection_iface ()
Gets the Selection interface for an Accessible.
public StateSet get_state_set ()
Gets the states currently held by an object.
public Table get_table ()
Gets the Table interface for an Accessible.
public TableCell get_table_cell ()
Gets the TableCell interface for an Accessible.
public Table get_table_iface ()
Gets the Table interface for an Accessible.
public Text get_text ()
Gets the Table interface for an Accessible.
public Text get_text_iface ()
Gets the Table interface for an Accessible.
public string get_toolkit_name () throws Error
Gets the toolkit name for an Accessible object.
public string get_toolkit_version () throws Error
Gets the toolkit version for an Accessible object.
public Value get_value ()
Gets the Table interface for an Accessible.
public Value get_value_iface ()
Gets the Table interface for an Accessible.
public void set_cache_mask (Cache mask)
Sets the type of data to cache for accessibles.

Signals:

public virtual signal void mode_changed (int enabled, string why)
The signal "mode-changed" is emitted by a screen reader to indicate that its mode has changed.
public virtual signal void region_changed (int current_offset, int last_offset)
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.