Namespace
Atspi – 2.0
The Assistive Technology Service Provider Interface, version 2
Dependencies
GObject—2.0 | The base type system library |
Browse documentation |
Classes
Accessible |
The base interface which is implemented by all accessible objects. |
Application |
An interface identifying the root object associated with a running application. |
Device | |
DeviceLegacy | |
DeviceListener | |
DeviceX11 | |
EventListener |
A generic interface implemented by objects for the receipt of event notifications. |
Hyperlink |
Instances of atspi-hyperlink are the means by which end users and clients interact with linked content. |
MatchRule |
An interface that allows the definition of match rules for accessible objects. |
Object | |
Relation |
An interface via which non-hierarchical relationships are indicated. |
StateSet |
The atspi-stateset objects implement wrappers around a bitmap of accessible states. |
Interfaces
Action | |
Collection |
An interface designed to allow accessibles which satisfy a set of criteria to be returned. |
Component |
An interface implemented by objects which have onscreen visual representations. |
Document | |
EditableText | |
Hypertext |
An interface used for objects which implement linking between multiple resource locations. |
Image | |
Selection |
An interface which indicates that an object exposes a ‘selection’ model, allowing the selection of one or more of its children. |
Table |
An interface used by containers whose data is arranged in a tabular form. |
TableCell | |
Text |
An interface implemented by objects which place textual information onscreen. |
Value |
An interface supporting a one-dimensional scalar to be modified, or which reflects its value. |
Structs
DeviceEvent | |
Event | |
EventListenerMode | |
KeyDefinition | |
KeySet |
Structure containing identifying information about a set of keycode or keysyms. |
Point | |
Range | |
Rect | |
TextRange | |
TextSelection |
This structure represents a single text selection within a document. This selection is defined by two points in the content, where each one is defined by an AtkObject supporting the AtkText interface and a character offset relative to it. since: 2.52 |
Enumerations
CollectionMatchType |
Enumeration used by |
CollectionSortOrder |
Enumeration used by interface |
CollectionTreeTraversalType |
Enumeration used by interface |
ComponentLayer |
The |
CoordType |
Enumeration used by |
EventType |
Enumeration used to specify the event types of interest to an
|
KeyEventType |
Deprecated. Should not be used. |
KeySynthType |
Enumeration used when synthesizing keyboard input via atspi_generate_keyboard_event. |
Live |
Enumeration used to indicate a type of live region and how assertive it should be in terms of speaking notifications. Currently, this is only used for “announcement” events, but it may be used for additional purposes in the future. |
LocaleType |
Used by interfaces |
ModifierType | |
RelationType |
|
Role |
Enumeration used by interface |
ScrollType |
Enumeration used by interface |
StateType |
Enumeration used by various interfaces indicating every possible state
an |
TextBoundaryType |
Specifies the boundary conditions determining a run of text as returned from atspi_text_get_text_at_offset, #atspi_text_get_text_after_offset, andatspi_text_get_text_before_offset. |
TextClipType |
Enumeration used by interface |
TextGranularity |
Text granularity types used for specifying the granularity of the region of text we are interested in. |
Bitfields
Cache | |
KeyListenerSyncType |
Specifies the type of a key listener event. The values above can and should be bitwise-‘OR’-ed together, observing the compatibility limitations specified in the description of each value. For instance, #ATSPI_KEYLISTENER_ALL_WINDOWS | #ATSPI_KEYLISTENER_CANCONSUME is a commonly used combination which gives the AT complete control over the delivery of matching events. However, such filters should be used sparingly as they may have a negative impact on system performance. |
Callbacks
DeviceListenerCB |
A callback function prototype via which clients receive device event notifications. |
DeviceListenerSimpleCB |
Similar to |
EventListenerCB |
A function prototype for callbacks via which clients are notified of AT-SPI events. |
EventListenerSimpleCB |
Like |
GenerateMouseEventCB | |
KeyCallback |
A callback that will be invoked when a key is pressed. |
Functions
dbus_connection_setup_with_g_main |
Sets the watch and timeout functions of a |
dbus_server_setup_with_g_main |
Sets the watch and timeout functions of a |
deregister_device_event_listener |
Removes a device event listener from the registry’s listener queue, ceasing notification of events of the specified type. |
deregister_keystroke_listener |
Removes a keystroke event listener from the registry’s listener queue,
ceasing notification of events with modifiers matching |
exit |
Disconnects from |
generate_keyboard_event |
Synthesizes a keyboard event (as if a hardware keyboard event occurred in the current UI context). |
generate_mouse_event |
Synthesizes a mouse event at a specific screen coordinate.
Most AT clients should use the |
generate_mouse_event_async |
Like atspi_generate_mouse_event, but asynchronous. |
get_a11y_bus | |
get_desktop |
Gets the virtual desktop indicated by index |
get_desktop_count |
Gets the number of virtual desktops. NOTE: multiple virtual desktops are not implemented yet; as a consequence, this function always returns 1. |
get_desktop_list |
Gets the list of virtual desktops. On return, |
get_version |
Returns the version of the AT-SPI library being used at runtime. since: 2.50 |
init |
Connects to the accessibility registry and initializes the SPI. |
is_initialized |
Indicates whether AT-SPI has been initialized. |
register_device_event_listener |
This function does nothing and should not be called. |
register_keystroke_listener |
Registers a listener for keystroke events, either pre-emptively for
all windows ( |
set_main_context |
Sets the main loop context that AT-SPI should assume is in use when setting an idle callback. This function should be called by application-side implementors (ie, at-spi2-atk) when it is desirable to re-enter the main loop. |
set_reference_window |
Deprecated. This function no longer does anything and should not be used. |
set_timeout |
Set the timeout used for method calls. If this is not set explicitly, a default of 800 ms is used. Note that at-spi2-registryd currently uses a timeout of 3 seconds when sending a keyboard event notification. This means that, if an AT makes a call in response to the keyboard notification and the application being called does not respond before the timeout is reached, at-spi2-registryd will time out on the keyboard event notification and pass the key onto the application (ie, reply to indicate that the key was not consumed), so this may make it undesirable to set a timeout larger than 3 seconds. |
Constants
COMPONENTLAYER_COUNT |
One higher than the highest valid value of |
COORD_TYPE_COUNT |
One higher than the highest valid value of |
DBUS_INTERFACE_ACCESSIBLE | |
DBUS_INTERFACE_ACTION | |
DBUS_INTERFACE_APPLICATION | |
DBUS_INTERFACE_CACHE | |
DBUS_INTERFACE_COLLECTION | |
DBUS_INTERFACE_COMPONENT | |
DBUS_INTERFACE_DEC | |
DBUS_INTERFACE_DEVICE_EVENT_LISTENER | |
DBUS_INTERFACE_DOCUMENT | |
DBUS_INTERFACE_EDITABLE_TEXT | |
DBUS_INTERFACE_EVENT_KEYBOARD | |
DBUS_INTERFACE_EVENT_MOUSE | |
DBUS_INTERFACE_EVENT_OBJECT | |
DBUS_INTERFACE_EVENT_SCREEN_READER | |
DBUS_INTERFACE_HYPERLINK | |
DBUS_INTERFACE_HYPERTEXT | |
DBUS_INTERFACE_IMAGE | |
DBUS_INTERFACE_REGISTRY | |
DBUS_INTERFACE_SELECTION | |
DBUS_INTERFACE_SOCKET | |
DBUS_INTERFACE_TABLE | |
DBUS_INTERFACE_TABLE_CELL | |
DBUS_INTERFACE_TEXT | |
DBUS_INTERFACE_VALUE | |
DBUS_NAME_REGISTRY | |
DBUS_PATH_DEC | |
DBUS_PATH_NULL | |
DBUS_PATH_REGISTRY | |
DBUS_PATH_ROOT | |
DBUS_PATH_SCREEN_READER | |
EVENTTYPE_COUNT |
One higher than the highest valid value of |
KEYEVENTTYPE_COUNT |
One higher than the highest valid value of |
KEYSYNTHTYPE_COUNT |
One higher than the highest valid value of |
LOCALE_TYPE_COUNT |
One higher than the highest valid value of |
MATCHTYPES_COUNT | |
MODIFIERTYPE_COUNT |
One higher than the highest valid value of |
RELATIONTYPE_COUNT |
One higher than the highest valid value of |
ROLE_COUNT |
One higher than the highest valid value of |
SCROLLTYPE_COUNT |
One higher than the highest valid value of |
SORTORDER_COUNT |
One higher than the highest valid value of |
STATETYPE_COUNT |
One higher than the highest valid value of |
TEXT_BOUNDARY_TYPE_COUNT |
One higher than the highest valid value of |
TEXT_CLIP_TYPE_COUNT |
One higher than the highest valid value of |
TREETRAVERSALTYPE_COUNT |
One higher than the highest valid value of AtspiCollection_TreeTraversalType. |