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.
Content:
Namespaces:
- Atspi
Interfaces:
Classes:
Structs:
Enums:
Constants:
Delegates:
- public delegate bool DeviceListenerCB (DeviceEvent stroke)
A callback function prototype via which clients receive device event
notifications.
- public delegate bool DeviceListenerSimpleCB (DeviceEvent stroke)
- 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.
Methods:
- 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.