X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fat-spi2-atk.git;a=blobdiff_plain;f=xml%2Forg.freedesktop.atspi.Registry.xml;h=9abced17032ceb62987d28156ace86e22125d1cc;hp=d8baa97bf8719e60a327bdc7cfa378fa8734dc30;hb=36a4131a9cc9fc8d474058d2a9448bc9eac91f17;hpb=c21124faa3a36efbd3300f08861f974de9d866aa diff --git a/xml/org.freedesktop.atspi.Registry.xml b/xml/org.freedesktop.atspi.Registry.xml index d8baa97..9abced1 100644 --- a/xml/org.freedesktop.atspi.Registry.xml +++ b/xml/org.freedesktop.atspi.Registry.xml @@ -1,10 +1,5 @@ - - - - -

The Registry is a service through which applications providing @@ -14,150 +9,77 @@ interact with those applications.

The Registry service provides four basic functions to Assistive Technology (AT) clients: - \li it provides a list of the applications who have registered with the AT-SPI - framework, thereby announcing their participation in the AT-SPI framework; - \li it allows AT clients to register for notification of changes in application - state (at-spi Events); - \li it dispatches/relays said events from participating applications to - the registered listeners; - \li it gives access to system device events via the associated DeviceEventController - interface.

+
    +
  1. It provides a list of the applications who have registered with the + AT-SPI framework, thereby announcing their participation in the AT-SPI framework.
    2. +
  2. It gives access to system device events via the associated DeviceEventController interface.
    3. +
+

From the point of view of accessible applications (i.e. AT-SPI service producers), the Registry is primarily a registration and event delivery service. Applications normally only call the registerApplication and deregisterApplication Registry methods, and its inherited EventListener::notifyEvent method.

-

@note Although all application events are dispatched via the Registry, other AT client +

Although all application events are dispatched via the Registry, other AT client calls are serviced directly by the applications, rather than being relayed via the Registry. The AT client obtains references to these application objects via the enumeration of Desktop instances whose children are Application instances - (Registry::getDesktopList) and via examination of the 'source' member of the Event + (Registry.getDesktopList) and via examination of the 'source' member of the Event structure.

The Registry normally lives in its own process space; communication via Registry and both application services and AT clients takes place via IPC. A process space diagram - illustrating the relationship between applications, Registry, and AT is shown below. - @image html "http://developer.gnome.org/projects/gap/tech-docs/SPIBlockDiagram.png"

- -

@see Desktop, Application, Event, EventListener

+ illustrating the relationship between applications, Registry, and AT is shown at: + http://developer.gnome.org/projects/gap/tech-docs/SPIBlockDiagram.png

- - - Register a new application with the accessibility broker. - - - - -

De-register an application previously registered with the broker. - deregisterApplication:

- - - - a reference to the Application to be deregistered. - - - - - -

Register a client's interest in (all) application events of - a certain type.

- - - - a reference to the requesting ::EventListener. - - - - - a string which indicates the type of events about which the client desires notification. - - - - - - deregisterGlobalEventListenerAll: - - - - the requesting EventListenerRequest that a previously registered client stop receivingglobal notifications for all events for which it was registered. - - - - - - deregisterGlobalEventListener: - - - - the requesting EventListener - - - - - a string indicating the type of eventsRequest that a previously registered client stop receivingglobal notifications for events of a certain type. - - - - - -

event types: "Window" "Desktop" - "Window:Create" "Window:Destroy" - "Window:Iconify" "Window:Restore" - "Window:Fullscreen" "Window:Resize" - "Desktop:Create" "Desktop:Destroy" - "Desktop:Focus" "Desktop:Defocus" - "Desktop:Reorder" - "Focus" - "GtkWidget:show" - "GObject:notify:<propertyname>"

- -

( not sure we should allow these last 2 forms, - since they are toolkit-specific, but they're powerful )

-

getDesktopCount:

- -

Get the current number of desktops.

- - + - a short integer indicating the current number of Desktops. + Gets all the currently registered applications. + + + A list of strings containing the D-Bus bus names of the applications. + - - -

getDesktop: - @n: the index of the requested Desktop.

-

Get the nth accessible desktop.

- - - + - a reference to the requested Desktop. - + Updates an AT about recently added or removed applications. + + + + Unique bus name of the application that has been removed or added. + The integer is an enumeration: + 0 : The application has been removed. + 1 : The application has been added. + - - - -

Get a list of accessible desktops.

- - + + + - a sequence containing references tothe Desktops. - - + Register a new application with the accessibility registry. + + + + D-Bus Bus name of the application that wishes to be made accessible. + + - - -

Obtain an object which can be used to request device event notifications.

- - - - an object implementing DeviceEventController - - + + + + De-register an application from accessibility registry. + + + + D-Bus Bus name of the application that wishes to be made accessible. + + +