2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001 Sun Microsystems Inc.
7 * 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.
12 * 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.
17 * 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.
23 #include <Bonobo_Unknown.idl>
24 #include <Accessibility_Event.idl>
25 #include <Accessibility_Application.idl>
26 #include <Accessibility_Desktop.idl>
28 #ifndef _ACCESSIBILITY_REGISTRY_IDL_
29 #define _ACCESSIBILITY_REGISTRY_IDL_
31 module Accessibility {
33 typedef sequence<Desktop> DesktopSeq;
35 interface DeviceEventController;
37 interface Registry : EventListener {
40 * registerApplication:
41 * @application: a reference to the requesting @Application
43 * Register a new application with the accessibility broker.
46 oneway void registerApplication (in Application application);
49 * deregisterApplication:
50 * @application: a reference to the @Application
53 * De-register an application previously registered with the broker.
56 void deregisterApplication (in Application application);
59 * registerGlobalEventListener:
60 * @listener: a reference to the requesting @EventListener.
61 * @eventName: a string which indicates the type of events about
62 * which the client desires notification.
64 * Register a client's interest in (all) application events of
68 void registerGlobalEventListener (in EventListener listener,
72 * deregisterGlobalEventListener:
73 * @listener: the requesting @EventListener
74 * @eventName: a string indicating the type of events
76 * Request that a previously registered client stop receiving
77 * global notifications for events of a certain type.
81 void deregisterGlobalEventListenerAll (in EventListener listener);
83 * deregisterGlobalEventListener:
84 * @listener: the requesting @EventListener
85 * @eventName: a string indicating the type of events
87 * Request that a previously registered client stop receiving
88 * global notifications for events of a certain type.
92 void deregisterGlobalEventListener (in EventListener listener,
93 in string event_name);
95 * event types: "Window" "Desktop"
96 * "Window:Create" "Window:Destroy"
97 * "Window:Iconify" "Window:Restore"
98 * "Window:Fullscreen" "Window:Resize"
99 * "Desktop:Create" "Desktop:Destroy"
100 * "Desktop:Focus" "Desktop:Defocus"
104 * "GObject:notify:<propertyname>"
106 * ( not sure we should allow these last 2 forms,
107 * since they are toolkit-specific, but they're powerful )
114 * Get the current number of desktops.
115 * Returns: a short integer indicating the current number of
118 short getDesktopCount ();
122 * @n: the index of the requested @Desktop.
124 * Get the nth accessible desktop.
126 * Returns: a reference to the requested @Desktop.
128 Desktop getDesktop (in short n);
133 * Get a list of accessible desktops.
135 * Returns: a sequence containing references to
138 DesktopSeq getDesktopList ();
141 * getDeviceEventController:
143 * Returns: an object implementing DeviceEventController
145 DeviceEventController getDeviceEventController ();
150 * placeholders for future expansion.
152 void unImplemented ();
153 void unImplemented2 ();
185 struct EventListenerMode {
191 typedef unsigned long ControllerEventMask;
197 unsigned short modifiers;
198 unsigned long timestamp;
203 struct KeyDefinition {
210 typedef sequence< KeyDefinition > KeySet;
211 typedef sequence< KeyEventType > KeyEventTypeSeq;
213 interface DeviceEventListener : Bonobo::Unknown {
214 boolean notifyEvent (in DeviceEvent event);
217 interface DeviceEventController : Bonobo::Unknown {
220 * registerKeystrokeListener:
221 * @listener: a @DeviceEventListener which will intercept key events.
222 * @keys: a @KeySet indicating which keys to intercept, or KEYSET_ALL_KEYS.
223 * @mask: a @ControllerEventMask filtering the intercepted key events.
224 * @type: an @EventType mask that may created by ORing event types together.
225 * @is_synchronous: a @boolean indicating whether the listener should
226 * receive the events synchronously, potentially consuming them,
227 * or just be notified asynchronously of those events that have
231 * Register to intercept keyboard events, and either pass them on or
235 void registerKeystrokeListener (in DeviceEventListener listener,
237 in ControllerEventMask mask,
238 in KeyEventTypeSeq type,
239 in EventListenerMode mode);
242 * deregisterKeystrokeListener:
243 * @listener: a @DeviceEventListener which will intercept key events.
244 * @keys: a @KeySet indicating which keys to intercept, or KEYSET_ALL_KEYS.
245 * @mask: a @ControllerEventMask filtering the intercepted key events.
246 * @type: an @EventType mask that may created by ORing event types together.
250 * De-register a previously registered keyboard eventlistener.
253 void deregisterKeystrokeListener (in DeviceEventListener listener,
255 in ControllerEventMask mask,
256 in KeyEventTypeSeq type);
258 boolean notifyListenersSync (in DeviceEvent event);
260 oneway void notifyListenersAsync (in DeviceEvent event);
263 * generateKeyboardEvent:
264 * @keycode: a long integer indicating the keycode of
265 * the keypress to be synthesized.
266 * @keystring: an optional UTF-8 string indicating a complex
267 * keyboard input event.
268 * @type: a #KeySynthType indicating the type of event(s) to be
269 * synthesized: a key press, release, press-release pair,
270 * or a complex input string (for instance from an
271 * internationalized or complex text input method, or
272 * a composed character).
274 * Note that @keycode may be truncated before being
275 * processed, as keycode length may be platform-dependent
276 * and keycode ranges are generally much smaller than
278 * One or the other of @keycode or @keystring are generally NULL,
279 * (but not both), depending on the value of @type.
283 * Synthesize a keyboard event.
286 void generateKeyboardEvent (in long keycode,
288 in KeySynthType type);
291 * generateMouseEvent:
292 * @x: a long integer indicating the screen x coord for the mouse event.
293 * @y: a long integer indicating the screen y coord for the mouse event.
294 * @eventName: a string indicating the type of mouse event, e.g. "button1up"
297 * Synthesize a mouse event.
300 void generateMouseEvent (in long x, in long y, in string eventName);
305 * placeholders for future expansion.
307 void unImplemented ();
308 void unImplemented2 ();