Atspi.Accessible¶
- Subclasses:
None
Methods¶
- Inherited:
GObject.Object (37), Atspi.Action (6), Atspi.Collection (5), Atspi.Component (14), Atspi.Document (7), Atspi.EditableText (6), Atspi.Hypertext (3), Atspi.Image (5), Atspi.Selection (8), Atspi.Table (26), Atspi.TableCell (8), Atspi.Text (24), Atspi.Value (6)
- Structs:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
|
|
|
Properties¶
None
Signals¶
- Inherited:
Name |
Short Description |
---|---|
The signal “mode-changed” is emitted by a screen reader to indicate that its mode has 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. |
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
accessible_parent |
r |
||
attributes |
r |
||
cached_properties |
r |
||
children |
[ |
r |
|
description |
r |
||
interfaces |
r |
||
name |
r |
||
parent |
r |
||
role |
r |
||
states |
r |
Class Details¶
- class Atspi.Accessible(**kwargs)¶
- Bases:
Atspi.Object
,Atspi.Action
,Atspi.Collection
,Atspi.Component
,Atspi.Document
,Atspi.EditableText
,Atspi.Hypertext
,Atspi.Image
,Atspi.Selection
,Atspi.Table
,Atspi.TableCell
,Atspi.Text
,Atspi.Value
- Abstract:
No
- Structure:
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.
- clear_cache()¶
Clears the cached information for the given accessible and all of its descendants.
- clear_cache_single()¶
Clears the cached information only for the given accessible.
- get_accessible_id()¶
- Raises:
- Returns:
a character string representing the accessible id of the
Atspi.Accessible
object orNone
on exception.- Return type:
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.
New in version 2.34.
- get_action()¶
- Returns:
a pointer to an
Atspi.Action
interface instance, orNone
if self does not implementAtspi.Action
.- Return type:
Gets the
Atspi.Action
interface for anAtspi.Accessible
.Deprecated since version 2.10: Use
Atspi.Accessible.get_action_iface
instead.
- get_action_iface()¶
- Returns:
a pointer to an
Atspi.Action
interface instance, orNone
if self does not implementAtspi.Action
.- Return type:
Gets the
Atspi.Action
interface for anAtspi.Accessible
.
- get_application()¶
- Raises:
- Returns:
the containing
Atspi.Application
instance for this object.- Return type:
Gets the containing
Atspi.Application
for an object.
- get_atspi_version()¶
- Raises:
- Returns:
a UTF-8 string indicating the AT-SPI version for the
Atspi.Accessible
object orNone
on exception.- Return type:
Gets the AT-SPI IPC specification version supported by the application pointed to by the
Atspi.Accessible
object. Only works on application root objects.
- get_attributes()¶
- Raises:
- Returns:
The name-value-pair attributes assigned to this object.
- Return type:
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_text_attributes
instead.
- get_attributes_as_array()¶
- Raises:
- Returns:
The name-value-pair attributes assigned to this object.
- Return type:
[
str
]
Gets a
GLib.Array
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.
- get_child_at_index(child_index)¶
- Parameters:
child_index (
int
) – a #long indicating which child is specified.- Raises:
- Returns:
a pointer to the
Atspi.Accessible
child object at index child_index orNone
on exception.- Return type:
Gets the
Atspi.Accessible
child of anAtspi.Accessible
object at a given index.
- get_child_count()¶
- Raises:
- Returns:
a #long indicating the number of
Atspi.Accessible
children contained by anAtspi.Accessible
object or -1 on exception.- Return type:
Gets the number of children contained by an
Atspi.Accessible
object.
- get_collection()¶
- Returns:
a pointer to an
Atspi.Collection
interface instance, orNone
if self does not implementAtspi.Collection
.- Return type:
Gets the
Atspi.Collection
interface for anAtspi.Accessible
.Deprecated since version 2.10: Use
Atspi.Accessible.get_collection_iface
instead.
- get_collection_iface()¶
- Returns:
a pointer to an
Atspi.Collection
interface instance, orNone
if self does not implementAtspi.Collection
.- Return type:
Gets the
Atspi.Collection
interface for anAtspi.Accessible
.
- get_component()¶
- Returns:
a pointer to an
Atspi.Component
interface instance, orNone
if self does not implementAtspi.Component
.- Return type:
Gets the
Atspi.Component
interface for anAtspi.Accessible
.Deprecated since version 2.10: Use
Atspi.Accessible.get_component_iface
instead.
- get_component_iface()¶
- Returns:
a pointer to an
Atspi.Component
interface instance, orNone
if self does not implementAtspi.Component
.- Return type:
Gets the
Atspi.Component
interface for anAtspi.Accessible
.
- get_description()¶
- Raises:
- Returns:
a UTF-8 string describing the
Atspi.Accessible
object orNone
on exception.- Return type:
Gets the description of an
Atspi.Accessible
object.
- get_document()¶
- Returns:
a pointer to an
Atspi.Document
interface instance, orNone
if self does not implementAtspi.Document
.- Return type:
Gets the
Atspi.Document
interface for anAtspi.Accessible
.Deprecated since version 2.10: Use
Atspi.Accessible.get_document_iface
instead.
- get_document_iface()¶
- Returns:
a pointer to an
Atspi.Document
interface instance, orNone
if self does not implementAtspi.Document
.- Return type:
Gets the
Atspi.Document
interface for anAtspi.Accessible
.
- get_editable_text()¶
- Returns:
a pointer to an
Atspi.EditableText
interface instance, orNone
if self does not implementAtspi.EditableText
.- Return type:
Gets the
Atspi.EditableText
interface for anAtspi.Accessible
.Deprecated since version 2.10: Use
Atspi.Accessible.get_editable_text_iface
instead.
- get_editable_text_iface()¶
- Returns:
a pointer to an
Atspi.EditableText
interface instance, orNone
if self does not implementAtspi.EditableText
.- Return type:
Gets the
Atspi.EditableText
interface for anAtspi.Accessible
.
- get_help_text()¶
- Raises:
- Returns:
a character string representing the help text for the
Atspi.Accessible
object orNone
on exception.- Return type:
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.
New in version 2.52.
- get_hyperlink()¶
- Returns:
the
Atspi.Hyperlink
object associated with the givenAtspi.Accessible
, orNone
if not supported.- Return type:
Gets the
Atspi.Hyperlink
interface for anAtspi.Accessible
.
- get_hypertext()¶
- Returns:
a pointer to an
Atspi.Hypertext
interface instance, orNone
if self does not implementAtspi.Hypertext
.- Return type:
Gets the
Atspi.Hypertext
interface for anAtspi.Accessible
.Deprecated since version 2.10: Use
Atspi.Accessible.get_hypertext_iface
instead.
- get_hypertext_iface()¶
- Returns:
a pointer to an
Atspi.Hypertext
interface instance, orNone
if self does not implementAtspi.Hypertext
.- Return type:
Gets the
Atspi.Hypertext
interface for anAtspi.Accessible
.
- get_id()¶
- Raises:
- Returns:
a positive
int
indicating the id for theAtspi.Accessible
object or -1 on exception.- Return type:
Gets the application id for a
Atspi.Accessible
object. Only works on application root objects.
- get_image()¶
- Returns:
a pointer to an
Atspi.Image
interface instance, orNone
if self does not implementAtspi.Image
.- Return type:
Gets the
Atspi.Image
interface for anAtspi.Accessible
.Deprecated since version 2.10: Use
Atspi.Accessible.get_image_iface
instead.
- get_image_iface()¶
- Returns:
a pointer to an
Atspi.Image
interface instance, orNone
if self does not implementAtspi.Image
.- Return type:
Gets the
Atspi.Image
interface for anAtspi.Accessible
.
- get_index_in_parent()¶
- Raises:
- Returns:
a
int
indicating the index of theAtspi.Accessible
object in its parent, or -1 if self has no containing parent or on exception.- Return type:
Gets the index of an
Atspi.Accessible
object within its parent’sAtspi.Accessible
children list.
- get_interfaces()¶
- Returns:
A
GLib.Array
of strings describing the interfaces supported by the object. Interfaces are denoted in short-hand (i.e. “Component”, “Text” etc.).- Return type:
[
str
]
A set of pointers to all interfaces supported by an
Atspi.Accessible
.
- get_localized_role_name()¶
- Raises:
- Returns:
a localized, UTF-8 string specifying the type of UI role played by an
Atspi.Accessible
object.- Return type:
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 ().
- get_name()¶
- Raises:
- Returns:
a UTF-8 string indicating the name of the
Atspi.Accessible
object orNone
on exception.- Return type:
Gets the name of an
Atspi.Accessible
object.
- get_object_locale()¶
- Raises:
- Return type:
- get_parent()¶
- Raises:
- Returns:
a pointer to the
Atspi.Accessible
object which contains the givenAtspi.Accessible
instance, orNone
if the self has no parent container.- Return type:
Gets an
Atspi.Accessible
object’s parent container.
- get_process_id()¶
- Raises:
- Returns:
The process ID or undetermined value if error is set.
- Return type:
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.
- get_relation_set()¶
- Raises:
- Returns:
a
GLib.Array
ofAtspi.Relation
pointers orNone
on exception.- Return type:
Gets the set of
Atspi.Relation
objects which describes thisAtspi.Accessible
object’s relationships with otherAtspi.Accessible
objects.
- get_role()¶
- Raises:
- Returns:
the
Atspi.Role
of anAtspi.Accessible
object.- Return type:
Gets the UI role played by an
Atspi.Accessible
object. This role’s name can be obtained viaAtspi.Accessible.get_role_name
().
- get_role_name()¶
- Raises:
- Returns:
a UTF-8 string specifying the type of UI role played by an
Atspi.Accessible
object.- Return type:
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
().
- get_selection()¶
- Returns:
a pointer to an
Atspi.Selection
interface instance, orNone
if self does not implementAtspi.Selection
.- Return type:
Gets the
Atspi.Selection
interface for anAtspi.Accessible
.Deprecated since version 2.10: Use
Atspi.Accessible.get_selection_iface
instead.
- get_selection_iface()¶
- Returns:
a pointer to an
Atspi.Selection
interface instance, orNone
if self does not implementAtspi.Selection
.- Return type:
Gets the
Atspi.Selection
interface for anAtspi.Accessible
.
- get_state_set()¶
- Returns:
a pointer to an
Atspi.StateSet
representing an object’s current state set.- Return type:
Gets the states currently held by an object.
- get_table()¶
- Returns:
a pointer to an
Atspi.Table
interface instance, orNone
if self does not implementAtspi.Table
.- Return type:
Gets the
Atspi.Table
interface for anAtspi.Accessible
.Deprecated since version 2.10: Use
Atspi.Accessible.get_table_iface
instead.
- get_table_cell()¶
- Returns:
a pointer to an
Atspi.TableCell
interface instance, orNone
if self does not implementAtspi.Table
.- Return type:
Gets the
Atspi.TableCell
interface for anAtspi.Accessible
.
- get_table_iface()¶
- Returns:
a pointer to an
Atspi.Table
interface instance, orNone
if self does not implementAtspi.Table
.- Return type:
Gets the
Atspi.Table
interface for anAtspi.Accessible
.
- get_text()¶
- Returns:
a pointer to an
Atspi.Text
interface instance, orNone
if self does not implementAtspi.Text
.- Return type:
Gets the
Atspi.Table
interface for anAtspi.Accessible
.Deprecated since version 2.10: Use
Atspi.Accessible.get_text_iface
instead.
- get_text_iface()¶
- Returns:
a pointer to an
Atspi.Text
interface instance, orNone
if self does not implementAtspi.Text
.- Return type:
Gets the
Atspi.Table
interface for anAtspi.Accessible
.
- get_toolkit_name()¶
- Raises:
- Returns:
a UTF-8 string indicating the toolkit name for the
Atspi.Accessible
object orNone
on exception.- Return type:
Gets the toolkit name for an
Atspi.Accessible
object. Only works on application root objects.
- get_toolkit_version()¶
- Raises:
- Returns:
a UTF-8 string indicating the toolkit version for the
Atspi.Accessible
object orNone
on exception.- Return type:
Gets the toolkit version for an
Atspi.Accessible
object. Only works on application root objects.
- get_value()¶
- Returns:
a pointer to an
Atspi.Value
interface instance, orNone
if self does not implementAtspi.Value
.- Return type:
Gets the
Atspi.Table
interface for anAtspi.Accessible
.Deprecated since version 2.10: Use
Atspi.Accessible.get_value_iface
instead.
- get_value_iface()¶
- Returns:
a pointer to an
Atspi.Value
interface instance, orNone
if self does not implementAtspi.Value
.- Return type:
Gets the
Atspi.Table
interface for anAtspi.Accessible
.
- set_cache_mask(mask)¶
- Parameters:
mask (
Atspi.Cache
) – AnAtspi.Cache
specifying a bit mask of the types of data to cache.
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.
Signal Details¶
- Atspi.Accessible.signals.mode_changed(accessible, arg1, why)¶
- Signal Name:
mode-changed
- Flags:
- Parameters:
accessible (
Atspi.Accessible
) – The object which received the signalarg1 (
int
) – a boolean specifying whether the mode is being toggled on or off.why (
str
) – an optional string explaining why the 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.signals.region_changed(accessible, arg1, arg2)¶
- Signal Name:
region-changed
- Flags:
- Parameters:
accessible (
Atspi.Accessible
) – The object which received the signalarg1 (
int
) – an integer specifying the current offset of the text being read, if the object is textual.arg2 (
int
) – an integer specifying the ending offset of the text being read, if the object is textual.
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.