1 <node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
3 <tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
4 <tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
5 <tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
6 <tp:license xmlns="http://www.w3.org/1999/xhtml">
7 <p>This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Library General Public
9 License as published by the Free Software Foundation; either
10 version 2 of the License, or (at your option) any later version.</p>
12 <p>This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Library General Public License for more details.</p>
17 <p>You should have received a copy of the GNU Library General Public
18 License along with this library; if not, write to the
19 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA.</p>
22 <interface name="org.freedesktop.atspi.Registry">
23 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
24 <p>The Registry is a service through which applications providing
25 accessibility services (servers) can rendezvous with consumers of those
26 services (Assistive Technologies). The Registry is the first "port of call" for
27 accessible applications and for assistive technologies wishing to query and
28 interact with those applications. </p>
30 <p>The Registry service provides four basic functions to Assistive Technology (AT) clients:
31 \li it provides a list of the applications who have registered with the AT-SPI
32 framework, thereby announcing their participation in the AT-SPI framework;
33 \li it allows AT clients to register for notification of changes in application
34 state (at-spi Events);
35 \li it dispatches/relays said events from participating applications to
36 the registered listeners;
37 \li it gives access to system device events via the associated DeviceEventController
40 <p>From the point of view of accessible applications (i.e. AT-SPI service producers),
41 the Registry is primarily a registration and event delivery service. Applications
42 normally only call the registerApplication and deregisterApplication Registry methods,
43 and its inherited EventListener::notifyEvent method. </p>
45 <p>@note Although all application events are dispatched via the Registry, other AT client
46 calls are serviced directly by the applications, rather than being relayed via the
47 Registry. The AT client obtains references to these application objects
48 via the enumeration of Desktop instances whose children are Application instances
49 (Registry::getDesktopList) and via examination of the 'source' member of the Event
52 <p>The Registry normally lives in its own process space; communication via Registry and
53 both application services and AT clients takes place via IPC. A process space diagram
54 illustrating the relationship between applications, Registry, and AT is shown below.
55 @image html "http://developer.gnome.org/projects/gap/tech-docs/SPIBlockDiagram.png" </p>
57 <p>@see Desktop, Application, Event, EventListener</p>
59 <method name="registerApplication">
61 Register a new application with the accessibility broker.
64 <method name="deregisterApplication">
65 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
66 <p>De-register an application previously registered with the broker.
67 deregisterApplication:</p>
69 <arg direction="in" name="app" type="o" tp:type="Application">
71 a reference to the Application to be deregistered.
75 <method name="registerGlobalEventListener">
76 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
77 <p>Register a client's interest in (all) application events of
80 <arg direction="in" name="listener" type="o" tp:type="EventListener">
82 a reference to the requesting ::EventListener.
85 <arg direction="in" name="eventName" type="s">
87 a string which indicates the type of events about which the client desires notification.
91 <method name="deregisterGlobalEventListenerAll">
93 deregisterGlobalEventListenerAll:
95 <arg direction="in" name="listener" type="o" tp:type="EventListener">
97 the requesting EventListenerRequest that a previously registered client stop receivingglobal notifications for all events for which it was registered.
101 <method name="deregisterGlobalEventListener">
103 deregisterGlobalEventListener:
105 <arg direction="in" name="listener" type="o" tp:type="EventListener">
107 the requesting EventListener
110 <arg direction="in" name="eventName" type="s">
112 a string indicating the type of eventsRequest that a previously registered client stop receivingglobal notifications for events of a certain type.
116 <method name="getDesktopCount">
117 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
118 <p>event types: "Window" "Desktop"
119 "Window:Create" "Window:Destroy"
120 "Window:Iconify" "Window:Restore"
121 "Window:Fullscreen" "Window:Resize"
122 "Desktop:Create" "Desktop:Destroy"
123 "Desktop:Focus" "Desktop:Defocus"
124 "Desktop:Reorder"
126 "GtkWidget:show"
127 "GObject:notify:<propertyname>" </p>
129 <p>( not sure we should allow these last 2 forms,
130 since they are toolkit-specific, but they're powerful ) </p>
132 <p>getDesktopCount: </p>
134 <p>Get the current number of desktops.</p>
136 <arg direction="out" type="n" tp:type="short">
138 a short integer indicating the current number of Desktops.
142 <method name="getDesktop">
143 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
145 @n: the index of the requested Desktop. </p>
147 <p>Get the nth accessible desktop. </p>
149 <arg direction="in" name="n" type="n" tp:type="short"/>
150 <arg direction="out" type="o" tp:type="Desktop">
152 a reference to the requested Desktop.
156 <method name="getDesktopList">
157 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
158 <p>Get a list of accessible desktops. </p>
160 <arg direction="out" type="as" tp:type="DesktopSeq">
162 a sequence containing references tothe Desktops.
166 <method name="getDeviceEventController">
167 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
168 <p>Obtain an object which can be used to request device event notifications. </p>
170 <arg direction="out" type="o" tp:type="DeviceEventController">
172 an object implementing DeviceEventController