From 32dd48c94efe4fe47147bbf066389dde688cd355 Mon Sep 17 00:00:00 2001 From: Mike Gorse Date: Fri, 16 May 2008 12:33:09 -0400 Subject: [PATCH] Re-added org.freedesktop.atspi.Registry.xml --- xml/org.freedesktop.atspi.Registry.xml | 182 +++++++++++++++++++++++++++++++++ 1 file changed, 182 insertions(+) create mode 100644 xml/org.freedesktop.atspi.Registry.xml diff --git a/xml/org.freedesktop.atspi.Registry.xml b/xml/org.freedesktop.atspi.Registry.xml new file mode 100644 index 0000000..408a9b0 --- /dev/null +++ b/xml/org.freedesktop.atspi.Registry.xml @@ -0,0 +1,182 @@ + + +AT-SPI - Assistive Technology Service Provider Interface +Copyright 2008 Novell, Inc. +Copyright 2001 Sun Microsystems Inc. + +

This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version.

+ +

This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details.

+ +

You should have received a copy of the GNU Library General Public + License along with this library; if not, write to the + Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA.

+ + + +

The Registry is a service through which applications providing + accessibility services (servers) can rendezvous with consumers of those + services (Assistive Technologies). The Registry is the first "port of call" for + accessible applications and for assistive technologies wishing to query and + 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.

+ +

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 + 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 + 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

+ + + + Register a new application with the accessibility broker. + + + + a reference to the requesting Application + + + + + +

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

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

+ +

Get the nth accessible desktop.

+ + + + + a reference to the requested Desktop. + + + + + +

Get a list of accessible desktops.

+ + + + a sequence containing references tothe Desktops. + + + + + +

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

+ + + + an object implementing DeviceEventController + + + + + -- 2.7.4