Namespace
Atspi – 2.0
The Assistive Technology Service Provider Interface, version 2
Dependencies
GObject—2.0 | The base type system library |
Browse documentation |
Structs
DeviceEvent | |
Event | |
EventListenerMode | |
KeyDefinition | |
KeySet |
Structure containing identifying information about a set of keycode or keysyms. |
Point | |
Range | |
Rect | |
TextRange |
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. |
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 |
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 |
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, |
init |
Connects to the accessibility registry and initializes the SPI. |
is_initialized |
Indicates whether AT-SPI has been initialized. |
register_device_event_listener |
Registers a listener for device events, for instance button events. |
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 |
Sets the reference window that will be used when atspi_generate_mouse_event is called. Coordinates will be assumed to be relative to this window. This is needed because, due to Wayland’s security model, it is not currently possible to retrieve global coordinates. If NULL is passed, then AT-SPI will use the window that has focus at the time that atspi_generate_mouse_event is called. |
set_timeout |
Set the timeout used for method calls. If this is not set explicitly, a default of 0.8 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. |