atspi-2
Description:
AT-SPI2 is a D-Bus based accessibility framework. It defines a D-Bus protocol for providing and accessing application accessibility information. The project includes a library for bridging the D-Bus protocol to the ATK API, allowing Gtk based applications to be made accessible.
- Home: https://wiki.linuxfoundation.org/accessibility/atk/at-spi/at-spi_on_d-bus
- C-Documentation: https://developer-old.gnome.org/libatspi/unstable/
- Devhelp-Package download
Content:
Namespaces:
- Atspi
- Action
- Collection
- Component
- Document
- EditableText
- Hypertext
- Image
- Selection
- Table
- TableCell
- Text
- Value
- Accessible
- Application
- Device
- DeviceLegacy
- DeviceListener
- DeviceX11
- Event
- EventListener
- Hyperlink
- KeyDefinition
- MatchRule
- Object
- Point
- Range
- Rect
- Relation
- StateSet
- TextRange
- ControllerEventMask
- DeviceEvent
- DeviceEventMask
- EventListenerMode
- KeyEventMask
- KeyMaskType
- KeySet - Structure containing identifying information about a set of keycode or keysyms.
- Cache
- CollectionMatchType - Enumeration used by MatchRule to specify how to interpret Accessible objects.
- CollectionSortOrder - Enumeration used by
interface Collection to specify the way
AtspiAccesible
objects should be sorted. - CollectionTreeTraversalType -
Enumeration used by interface Collection to specify restrictions on
AtspiAccesible
objects to be traversed. - ComponentLayer - The ComponentLayer of an Component instance indicates its relative stacking order with respect to the onscreen visual representation of the UI.
- CoordType - Enumeration used by Component, Image, and Text interfaces to specify whether coordinates are relative to the window or the screen.
- EventType - Enumeration used to specify the event types of interest to an EventListener, or to identify the type of an event for which notification has been sent.
- KeyEventType - Deprecated.
- KeyListenerSyncType - Specifies the type of a key listener event.
- KeySynthType - Enumeration used when synthesizing keyboard input via generate_keyboard_event.
- LocaleType - Used by interfaces Text and Document, this enumeration corresponds to the POSIX 'setlocale' enum values.
- ModifierType
- RelationType - RelationType specifies a relationship between objects (possibly one-to-many or many-to-one) outside of the normal parent/child hierarchical relationship.
- Role - Enumeration used by interface Accessible to specify the role of an Accessible object.
- ScrollType - Enumeration used by interface Accessible to specify where an Accessible object should be placed on the screen when using scroll_to.
- StateType - Enumeration used by various interfaces
indicating every possible state an
AtspiAccesible
object can assume. - TextBoundaryType - Specifies the boundary conditions determining a run of text as returned from get_text_at_offset, get_text_after_offset, and get_text_before_offset.
- TextClipType - Enumeration used by interface Text to indicate how to treat characters intersecting bounding boxes.
- TextGranularity - Text granularity types used for specifying the granularity of the region of text we are interested in.
- public const int COMPONENTLAYER_COUNT
One higher than the highest valid value of ComponentLayer.
- public const int COORD_TYPE_COUNT
One higher than the highest valid value of CoordType.
- public const string DBUS_INTERFACE_ACCESSIBLE
- public const string DBUS_INTERFACE_ACTION
- public const string DBUS_INTERFACE_APPLICATION
- public const string DBUS_INTERFACE_CACHE
- public const string DBUS_INTERFACE_COLLECTION
- public const string DBUS_INTERFACE_COMPONENT
- public const string DBUS_INTERFACE_DEC
- public const string DBUS_INTERFACE_DEVICE_EVENT_LISTENER
- public const string DBUS_INTERFACE_DOCUMENT
- public const string DBUS_INTERFACE_EDITABLE_TEXT
- public const string DBUS_INTERFACE_EVENT_KEYBOARD
- public const string DBUS_INTERFACE_EVENT_MOUSE
- public const string DBUS_INTERFACE_EVENT_OBJECT
- public const string DBUS_INTERFACE_EVENT_SCREEN_READER
- public const string DBUS_INTERFACE_HYPERLINK
- public const string DBUS_INTERFACE_HYPERTEXT
- public const string DBUS_INTERFACE_IMAGE
- public const string DBUS_INTERFACE_REGISTRY
- public const string DBUS_INTERFACE_SELECTION
- public const string DBUS_INTERFACE_SOCKET
- public const string DBUS_INTERFACE_TABLE
- public const string DBUS_INTERFACE_TABLE_CELL
- public const string DBUS_INTERFACE_TEXT
- public const string DBUS_INTERFACE_VALUE
- public const string DBUS_NAME_REGISTRY
- public const string DBUS_PATH_DEC
- public const string DBUS_PATH_NULL
- public const string DBUS_PATH_REGISTRY
- public const string DBUS_PATH_ROOT
- public const string DBUS_PATH_SCREEN_READER
- public const int EVENTTYPE_COUNT
One higher than the highest valid value of EventType.
- public const int KEYEVENTTYPE_COUNT
One higher than the highest valid value of KeyEventType.
- public const int KEYSYNTHTYPE_COUNT
One higher than the highest valid value of KeySynthType.
- public const int LOCALE_TYPE_COUNT
One higher than the highest valid value of LocaleType.
- public const int MATCHTYPES_COUNT
- public const int MODIFIERTYPE_COUNT
One higher than the highest valid value of ModifierType.
- public const int RELATIONTYPE_COUNT
One higher than the highest valid value of RelationType.
- public const int ROLE_COUNT
One higher than the highest valid value of Role.
- public const int SCROLLTYPE_COUNT
One higher than the highest valid value of ScrollType.
- public const int SORTORDER_COUNT
One higher than the highest valid value of CollectionSortOrder.
- public const int STATETYPE_COUNT
One higher than the highest valid value of StateType.
- public const int TEXT_BOUNDARY_TYPE_COUNT
One higher than the highest valid value of TextBoundaryType.
- public const int TEXT_CLIP_TYPE_COUNT
One higher than the highest valid value of TextClipType.
- public const int TREETRAVERSALTYPE_COUNT
One higher than the highest valid value of
AtspiCollection_TreeTraversalType
. - public delegate bool DeviceListenerCB (DeviceEvent stroke)
A callback function prototype via which clients receive device event notifications.
- public delegate bool DeviceListenerSimpleCB (DeviceEvent stroke)
Similar to DeviceListenerCB, but with no user data.
- public delegate void EventListenerCB (owned Event event)
A function prototype for callbacks via which clients are notified of AT-SPI events.
- public delegate void EventListenerSimpleCB (owned Event event)
Like
AtspiEventlistenerCB
, but with no user_data. - public delegate void KeyCallback (Device device, bool pressed, uint keycode, uint keysym, uint modifiers, string keystring)
A callback that will be invoked when a key is pressed.
- public bool deregister_device_event_listener (DeviceListener listener, void* filter) throws Error
Removes a device event listener from the registry's listener queue, ceasing notification of events of the specified type.
- public bool deregister_keystroke_listener (DeviceListener listener, Array<KeyDefinition>? key_set, KeyMaskType modmask, KeyEventMask event_types) throws Error
Removes a keystroke event listener from the registry's listener queue, ceasing notification of events with modifiers matching
modmask
. - public void event_main ()
Starts/enters the main event loop for the AT-SPI services.
- public void event_quit ()
Quits the last main event loop for the AT-SPI services, See: event_main
- public int exit ()
Disconnects from
AtspiRegistry
instances and releases any floating resources. - public bool generate_keyboard_event (long keyval, string? keystring, KeySynthType synth_type) throws Error
Synthesizes a keyboard event (as if a hardware keyboard event occurred in the current UI context).
- public bool generate_mouse_event (long x, long y, string name) throws Error
Synthesizes a mouse event at a specific screen coordinate.
- public Accessible get_desktop (int i)
Gets the virtual desktop indicated by index
i
. - public int get_desktop_count ()
Gets the number of virtual desktops.
- public Array<Accessible> get_desktop_list ()
Gets the list of virtual desktops.
- public int init ()
Connects to the accessibility registry and initializes the SPI.
- public bool is_initialized ()
Indicates whether AT-SPI has been initialized.
- public bool register_device_event_listener (DeviceListener listener, DeviceEventMask event_types, void* filter) throws Error
Registers a listener for device events, for instance button events.
- public bool register_keystroke_listener (DeviceListener listener, Array<KeyDefinition>? key_set, KeyMaskType modmask, KeyEventMask event_types, KeyListenerSyncType sync_type) throws Error
Registers a listener for keystroke events, either pre-emptively for all windows (atspi_keylistener_all_windows), non-preemptively ( atspi_keylistener_nosync), or pre-emptively at the toolkit level (atspi_keylistener_canconsume ).
- public string role_get_name (Role role)
- public void set_main_context (MainContext cnx)
Sets the main loop context that AT-SPI should assume is in use when setting an idle callback.
- public void set_reference_window (Accessible accessible)
Sets the reference window that will be used when atspi_generate_mouse_event is called.
- public void set_timeout (int val, int startup_time)
Set the timeout used for method calls.