org.a11y.atspi.Registry

Description

Interface implemented by the AT-SPI registry daemon.

The registry daemon listens on org.a11y.atspi.Registry and exposes an object at /org/a11y/atspi/registry that implements this interface.

Properties

org.a11y.atspi.Registry:version

version readable u

Methods

org.a11y.atspi.Registry.RegisterEvent

RegisterEvent (
  IN event s,
  IN properties as,
  IN app_bus_name s
)

event_type: a character string indicating the type of events for which notification is requested. Format is EventClass:major_type:minor_type:detail where all subfields other than EventClass are optional. EventClasses include “object”, “window”, “mouse”, and toolkit events (e.g. “Gtk”, “AWT”). Examples: “focus:”, “Gtk:GtkWidget:button_press_event”.

properties: A list of properties that applications should pass when sending the event specified in event_type. This is intended to allow an AT to proactively request the information that it is interested in and minimize the need to make additional queries in response to the event. This is currently unimplemented; the specification would need to be fleshed out here.

app_bus_name: The application that this request pertains to. This allows an app to indicate that it is interested in a particular event only for a certain application. If this string is empty, then this registration applies to all applications.

This method is to be called by an AT to indicate that it is interested in receiving a particular event from applications. Applications can optionally call GetRegisteredEvents and listen for EventListenerRewgistered and EventListenerDeregistered signals and, in this way, only send events that an AT is interested in receiving.

event

properties

app_bus_name

org.a11y.atspi.Registry.DeregisterEvent

DeregisterEvent (
  IN event s,
  IN app_bus_name s
)

event_type: A character string indicating the event to be deregistered. See RegisterEvent for a description of the format of this string.

app_bus_name: The application that this request pertains to. If the event listener was registered only for a certain application, then the value passed should matched the app_bus_name passed for the corresponding RegisterEvent call.

Indicates that an AT is no longer interested in listening to a particular event.

event

app_bus_name

org.a11y.atspi.Registry.GetRegisteredEvents

GetRegisteredEvents (
  OUT events a(ss)
)

events: A dictionary listing the registered events. For each entry, the first string gives the bus name of the AT holding the registration. The second string gives the event. See RegisterEvent for a description of the format of this string.

events

Signals

org.a11y.atspi.Registry::EventListenerRegistered

EventListenerRegistered (
  bus s,
  event s,
  properties as
)

bus: The bus name of the AT registering the event.

event: The event being registered. See RegisterEvent for a description of the format of this string.

properties: An array of properties that the AT is interested in receiving along with the event. Currently unimplemented; the specification for this would need to be fleshed out.

Indicates that an AT has requested to listen for an event. Applications can optionally listen to this signal to maintain a list of events that ATs are interested in receiving and only send events when needed.

bus

event

properties

org.a11y.atspi.Registry::EventListenerDeregistered

EventListenerDeregistered (
  bus s,
  event s
)

bus: The bus name of the AT registering the event.

event: The event being deregistered. See RegisterEvent for a description of the format of this string.

Indicates that an AT is no longer interested in listening for an event. Applications can optionally listen to this signal to maintain a list of events that ATs are interested in receiving and only send events when needed.

bus

event