Gjsify LogoGjsify Logo

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

ControllerEventMask: number
DeviceEventMask: number
KeyEventMask: number
KeyMaskType: number
KeystrokeListener: void

Variables

COMPONENTLAYER_COUNT: number

One higher than the highest valid value of #AtspiComponentLayer.

COORD_TYPE_COUNT: number

One higher than the highest valid value of #AtspiCoordType.

DBUS_INTERFACE_ACCESSIBLE: string
DBUS_INTERFACE_ACTION: string
DBUS_INTERFACE_APPLICATION: string
DBUS_INTERFACE_CACHE: string
DBUS_INTERFACE_COLLECTION: string
DBUS_INTERFACE_COMPONENT: string
DBUS_INTERFACE_DEC: string
DBUS_INTERFACE_DEVICE_EVENT_LISTENER: string
DBUS_INTERFACE_DOCUMENT: string
DBUS_INTERFACE_EDITABLE_TEXT: string
DBUS_INTERFACE_EVENT_KEYBOARD: string
DBUS_INTERFACE_EVENT_MOUSE: string
DBUS_INTERFACE_EVENT_OBJECT: string
DBUS_INTERFACE_EVENT_SCREEN_READER: string
DBUS_INTERFACE_HYPERLINK: string
DBUS_INTERFACE_HYPERTEXT: string
DBUS_INTERFACE_IMAGE: string
DBUS_INTERFACE_REGISTRY: string
DBUS_INTERFACE_SELECTION: string
DBUS_INTERFACE_SOCKET: string
DBUS_INTERFACE_TABLE: string
DBUS_INTERFACE_TABLE_CELL: string
DBUS_INTERFACE_TEXT: string
DBUS_INTERFACE_VALUE: string
DBUS_NAME_REGISTRY: string
DBUS_PATH_DEC: string
DBUS_PATH_NULL: string
DBUS_PATH_REGISTRY: string
DBUS_PATH_ROOT: string
DBUS_PATH_SCREEN_READER: string
EVENTTYPE_COUNT: number

One higher than the highest valid value of #AtspiEventType.

KEYEVENTTYPE_COUNT: number

One higher than the highest valid value of #AtspiKeyEventType.

KEYSYNTHTYPE_COUNT: number

One higher than the highest valid value of #AtspiKeySynthType.

LOCALE_TYPE_COUNT: number

One higher than the highest valid value of #AtspiLocaleType.

MATCHTYPES_COUNT: number
MODIFIERTYPE_COUNT: number

One higher than the highest valid value of #AtspiModifierType.

RELATIONTYPE_COUNT: number

One higher than the highest valid value of #AtspiRelationType.

ROLE_COUNT: number

One higher than the highest valid value of #AtspiRole.

SCROLLTYPE_COUNT: number

One higher than the highest valid value of #AtspiScrollType.

SORTORDER_COUNT: number

One higher than the highest valid value of #AtspiCollectionSortOrder.

STATETYPE_COUNT: number

One higher than the highest valid value of #AtspiStateType.

TEXT_BOUNDARY_TYPE_COUNT: number

One higher than the highest valid value of #AtspiTextBoundaryType.

TEXT_CLIP_TYPE_COUNT: number

One higher than the highest valid value of #AtspiTextClipType.

TREETRAVERSALTYPE_COUNT: number

One higher than the highest valid value of #AtspiCollection_TreeTraversalType.

Functions

  • deregisterDeviceEventListener(listener: DeviceListener, filter: object): boolean
  • Removes a device event listener from the registry's listener queue, ceasing notification of events of the specified type.

    Parameters

    • listener: DeviceListener

      a pointer to the #AtspiDeviceListener for which device events are requested.

    • filter: object

      Unused parameter.

    Returns boolean

  • Removes a keystroke event listener from the registry's listener queue, ceasing notification of events with modifiers matching modmask.

    Parameters

    • listener: DeviceListener

      a pointer to the #AtspiDeviceListener for which keystroke events are requested.

    • keySet: KeyDefinition[]

      a pointer to the #AtspiKeyDefinition array indicating which keystroke events are requested, or %NULL to indicate that all keycodes and keyvals for the specified modifier set are to be included.

    • modmask: number

      the key modifier mask for which this listener is to be 'deregistered' (of type #AtspiKeyMaskType).

    • eventTypes: number

      an #AtspiKeyMaskType mask indicating which types of key events were requested (%ATSPI_KEY_PRESSED, etc.).

    Returns boolean

  • eventMain(): void
  • Starts/enters the main event loop for the AT-SPI services.

    NOTE: This method does not return control; it is exited via a call to #atspi_event_quit from within an event handler.

    Returns void

  • eventQuit(): void
  • Quits the last main event loop for the AT-SPI services, See: #atspi_event_main

    Returns void

  • exit(): number
  • Disconnects from #AtspiRegistry instances and releases any floating resources. Call only once at exit.

    Returns number

  • generateKeyboardEvent(keyval: number, keystring: string, synthType: KeySynthType): boolean
  • Synthesizes a keyboard event (as if a hardware keyboard event occurred in the current UI context).

    Parameters

    • keyval: number

      a #gint indicating the keycode or keysym or modifier mask of the key event being synthesized.

    • keystring: string

      an (optional) UTF-8 string which, if synth_type is %ATSPI_KEY_STRING, indicates a 'composed' keyboard input string being synthesized; this type of keyboard event synthesis does not emulate hardware keypresses but injects the string as though a composing input method (such as XIM) were used.

    • synthType: KeySynthType

      an #AtspiKeySynthType flag indicating whether keyval is to be interpreted as a keysym rather than a keycode (%ATSPI_KEY_SYM) or a string (%ATSPI_KEY_STRING) or a modifier mask (%ATSPI_KEY_LOCKMODIFIERS and %ATSPI_KEY_UNLOCKMODIFIERS), or whether to synthesize %ATSPI_KEY_PRESS, %ATSPI_KEY_RELEASE, or both (%ATSPI_KEY_PRESSRELEASE).

    Returns boolean

  • generateMouseEvent(x: number, y: number, name: string): boolean
  • Synthesizes a mouse event at a specific screen coordinate. Most AT clients should use the #AccessibleAction interface when tempted to generate mouse events, rather than this method. Event names: b1p = button 1 press; b2r = button 2 release; b3c = button 3 click; b2d = button 2 double-click; abs = absolute motion; rel = relative motion.

    Parameters

    • x: number

      a #glong indicating the screen x coordinate of the mouse event.

    • y: number

      a #glong indicating the screen y coordinate of the mouse event.

    • name: string

      a string indicating which mouse event to be synthesized (e.g. "b1p", "b1c", "b2r", "rel", "abs").

    Returns boolean

  • Gets the virtual desktop indicated by index i. NOTE: currently multiple virtual desktops are not implemented; as a consequence, any i value different from 0 will not return a virtual desktop - instead it will return NULL.

    Parameters

    • i: number

      a #gint indicating which of the accessible desktops is to be returned.

    Returns Atspi.Accessible

  • getDesktopCount(): number
  • Gets the number of virtual desktops. NOTE: multiple virtual desktops are not implemented yet; as a consequence, this function always returns 1.

    Returns number

  • Gets the list of virtual desktops. On return, list will point to a newly-created, NULL terminated array of virtual desktop pointers. It is the responsibility of the caller to free this array when it is no longer needed. NOTE: currently multiple virtual desktops are not implemented; this implementation always returns a #Garray with a single #AtspiAccessible desktop.

    Returns Atspi.Accessible[]

  • init(): number
  • Connects to the accessibility registry and initializes the SPI.

    Returns number

  • isInitialized(): boolean
  • registerDeviceEventListener(listener: DeviceListener, eventTypes: number, filter: object): boolean
  • Registers a listener for device events, for instance button events.

    Parameters

    • listener: DeviceListener

      a pointer to the #AtspiDeviceListener which requests the events.

    • eventTypes: number

      an #AtspiDeviceEventMask mask indicating which types of key events are requested (%ATSPI_KEY_PRESSED, etc.).

    • filter: object

      Unused parameter.

    Returns boolean

  • 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). If ALL_WINDOWS or CANCONSUME are used, the event is consumed upon receipt if one of listener's callbacks returns %TRUE (other sync_type values may be available in the future).

    Parameters

    • listener: DeviceListener

      a pointer to the #AtspiDeviceListener for which keystroke events are requested.

    • keySet: KeyDefinition[]

      a pointer to the #AtspiKeyDefinition array indicating which keystroke events are requested, or NULL to indicate that all keycodes and keyvals for the specified modifier set are to be included.

    • modmask: number

      an #AtspiKeyMaskType mask indicating which key event modifiers must be set in combination with keys, events will only be reported for key events for which all modifiers in modmask are set. If you wish to listen for events with multiple modifier combinations, you must call #atspi_register_keystroke_listener once for each combination.

    • eventTypes: number

      an #AtspiKeyMaskType mask indicating which types of key events are requested (%ATSPI_KEY_PRESSED etc.).

    • syncType: KeyListenerSyncType

      an #AtspiKeyListenerSyncType parameter indicating the behavior of the notification/listener transaction.

    Returns boolean

  • Gets a localizable string that indicates the name of an #AtspiRole. DEPRECATED.

    Parameters

    • role: Atspi.Role

      an #AtspiRole object to query.

    Returns string

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    • accessible: Atspi.Accessible

      the #AtspiAccessible corresponding to the window to select. should be a top-level window with a role of ATSPI_ROLE_APPLICATION.

    Returns void

  • setTimeout(val: number, startupTime: number): void
  • 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.

    By default, the normal timeout is set to 800 ms, and the application startup timeout is set to 15 seconds.

    Parameters

    • val: number

      The timeout value, in milliseconds, or -1 to disable the timeout.

    • startupTime: number

      The amount of time, in milliseconds, to allow to pass before enforcing timeouts on an application. Can be used to prevent timeout exceptions if an application is likely to block for an extended period of time on initialization. -1 can be passed to disable this behavior.

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method