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 /* spi_registry.c: Global functions wrapping the registry */
25 #include <cspi/spi-private.h>
28 * SPI_registerGlobalEventListener:
29 * @listener: the #AccessibleEventListener to be registered against an
31 * @eventType: a character string indicating the type of events for which
32 * notification is requested. Format is
33 * EventClass:major_type:minor_type:detail
34 * where all subfields other than EventClass are optional.
35 * EventClasses include "object", "window", "mouse",
36 * and toolkit events (e.g. "Gtk", "AWT").
37 * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
39 * Legal object event types:
41 * (property change events)
43 * object:property-change
44 * object:property-change:accessible-name
45 * object:property-change:accessible-description
46 * object:property-change:accessible-parent
47 * object:property-change:accessible-value
48 * object:property-change:accessible-role
49 * object:property-change:accessible-table-caption
50 * object:property-change:accessible-table-column-description
51 * object:property-change:accessible-table-column-header
52 * object:property-change:accessible-table-row-description
53 * object:property-change:accessible-table-row-header
54 * object:property-change:accessible-table-summary
56 * (other object events)
58 * object:state-changed
59 * object:children-changed
60 * object:visible-data-changed
61 * object:selection-changed
62 * object:text-selection-changed
64 * object:text-caret-moved
66 * object:row-reordered
68 * object:column-inserted
69 * object:column-reordered
70 * object:column-deleted
71 * object:model-changed
81 * window:desktop-create
82 * window:desktop-destroy
93 * NOTE: this string may be UTF-8, but should not contain byte value 56
94 * (ascii ':'), except as a delimiter, since non-UTF-8 string
95 * delimiting functions are used internally.
96 * In general, listening to
97 * toolkit-specific events is not recommended.
99 * Add an in-process callback function to an existing AccessibleEventListener.
101 * Returns: #TRUE if successful, otherwise #FALSE.
104 SPI_registerGlobalEventListener (AccessibleEventListener *listener,
105 const char *eventType)
114 Accessibility_Registry_registerGlobalEventListener (
116 cspi_event_listener_get_corba (listener),
117 eventType, cspi_ev ());
119 retval = !cspi_exception ();
125 * SPI_deregisterGlobalEventListenerAll:
126 * @listener: the #AccessibleEventListener to be registered against
129 * deregisters an AccessibleEventListener from the registry, for all
130 * event types it may be listening to. Use
131 * AccessibleEventListener_unref to release the
132 * listener reference.
134 * Returns: #TRUE if successful, otherwise #FALSE.
137 SPI_deregisterGlobalEventListenerAll (AccessibleEventListener *listener)
144 Accessibility_Registry_deregisterGlobalEventListenerAll (
146 cspi_event_listener_get_corba (listener),
149 return !cspi_exception ();
153 * SPI_deregisterGlobalEventListener:
154 * @listener: the #AccessibleEventListener registered against an event type.
155 * @eventType: a string specifying the event type for which this
156 * listener is to be deregistered.
158 * deregisters an AccessibleEventListener from the registry, for a specific
161 * Returns: #TRUE if successful, otherwise #FALSE.
164 SPI_deregisterGlobalEventListener (AccessibleEventListener *listener,
165 const char *eventType)
172 Accessibility_Registry_deregisterGlobalEventListener (
174 cspi_event_listener_get_corba (listener),
175 (CORBA_char *) eventType, cspi_ev ());
177 return !cspi_exception ();
181 * SPI_getDesktopCount:
183 * Get the number of virtual desktops.
184 * NOTE: currently multiple virtual desktops are not implemented, this
185 * function always returns '1'.
187 * Returns: an integer indicating the number of active virtual desktops.
190 SPI_getDesktopCount ()
194 retval = Accessibility_Registry_getDesktopCount (
195 cspi_registry (), cspi_ev ());
197 cspi_return_val_if_ev ("getDesktopCount", -1);
204 * @i: an integer indicating which of the accessible desktops is to be returned.
206 * Get the virtual desktop indicated by index @i.
207 * NOTE: currently multiple virtual desktops are not implemented, this
208 * function always returns '1'.
210 * Returns: a pointer to the 'i-th' virtual desktop's #Accessible representation.
213 SPI_getDesktop (int i)
215 return cspi_object_add (
216 Accessibility_Registry_getDesktop (
217 cspi_registry (), (CORBA_short) i, cspi_ev ()));
221 * SPI_getDesktopList:
222 * @desktop_list: a pointer to an array of #Accessible references.
224 * Get the list of virtual desktops. On return, @list will point
225 * to a newly-created, NULL terminated array of virtual desktop
227 * It is the responsibility of the caller to free this array when
228 * it is no longer needed.
230 * Not Yet Implemented : this implementation always returns a single
231 * #Accessible desktop.
233 * Returns: an integer indicating how many virtual desktops have been
234 * placed in the list pointed to by parameter @list.
237 SPI_getDesktopList (Accessible ***desktop_list)
241 Accessibility_DesktopSeq *desktops;
246 *desktop_list = NULL;
248 desktops = Accessibility_Registry_getDesktopList (cspi_registry (),
251 cspi_return_val_if_ev ("getting desktop list", 0);
253 list = g_new0 (Accessible *, desktops->_length + 1);
255 for (i = 0; i < desktops->_length; i++)
257 list [i] = cspi_object_add (
258 CORBA_Object_duplicate (desktops->_buffer [i], cspi_ev ()));
262 CORBA_free (desktops);
264 *desktop_list = list;
270 * SPI_freeDesktopList:
271 * @desktop_list: a pointer to an array of #Accessible objects
272 * as returned from @SPI_getDesktopList
274 * This routine frees the memory associated with the list.
277 SPI_freeDesktopList (Accessible **desktop_list)
281 for (p = desktop_list; p && *p; p++)
283 cspi_object_unref (*p);
285 g_free (desktop_list);
289 * SPI_KEYSET_ALL_KEYS:
290 * @SPI_KEYSET_ALL_KEYS: A special value for an AccessibleKeySet type, which tacitly
291 * includes all keycodes and keyvals for the specified modifier set.
295 * SPI_registerAccessibleKeystrokeListener:
296 * @listener: a pointer to the #AccessibleKeystrokeListener for which
297 * keystroke events are requested.
298 * @keys: a pointer to the #AccessibleKeySet indicating which
299 * keystroke events are requested, or #CSPI_KEYSET_ALL_KEYS.
300 * @modmask: an #AccessibleKeyMaskType mask indicating which
301 * key event modifiers must be set in combination with @keys,
302 * events will only be reported for key events for which all
303 * modifiers in @modmask are set. If you wish to listen for
304 * events with multiple modifier combinations you must call
305 * registerAccessibleKeystrokeListener() once for each combination.
306 * @eventmask: an #AccessibleKeyMaskType mask indicating which
307 * types of key events are requested (#SPI_KEY_PRESSED, etc.).
308 * @sync_type: a #AccessibleKeyListenerSyncType parameter indicating
309 * the behavior of the notification/listener transaction.
311 * Register a listener for keystroke events, either pre-emptively for
312 * all windows (CSPI_KEYLISTENER_ALL_WINDOWS), or
313 * non-preemptively (CSPI_KEYLISTENER_NOSYNC).
314 * ( Other sync_type values may be available in the future.)
316 * Returns: #TRUE if successful, otherwise #FALSE.
319 SPI_registerAccessibleKeystrokeListener (AccessibleKeystrokeListener *listener,
320 AccessibleKeySet *keys,
321 AccessibleKeyMaskType modmask,
322 AccessibleKeyEventMask eventmask,
323 AccessibleKeyListenerSyncType sync_type)
326 Accessibility_KeySet key_set;
327 Accessibility_KeyEventTypeSeq key_events;
328 Accessibility_ControllerEventMask controller_event_mask;
329 Accessibility_DeviceEventController device_event_controller;
330 Accessibility_EventListenerMode listener_mode;
337 device_event_controller =
338 Accessibility_Registry_getDeviceEventController (cspi_registry (), cspi_ev ());
340 cspi_return_val_if_ev ("getting event controller", FALSE);
342 /* copy the keyval filter values from the C api into the CORBA KeySet */
345 key_set._length = keys->len;
346 key_set._buffer = Accessibility_KeySet_allocbuf (keys->len);
347 for (i = 0; i < key_set._length; ++i)
349 /* we overload the keyset long w/keycodes, the - bit acts as a flag */
350 key_set._buffer[i] = (keys->keysyms[i]) ? keys->keysyms[i] :
352 /* fprintf (stderr, "key-set %d = %d\n", i, (int) key_set->_buffer[i]); */
358 key_set._buffer = NULL;
361 /* copy the event filter values from the C api into the CORBA KeyEventTypeSeq */
366 if (mask & eventmask)
372 while (mask & 0xFFFF);
374 key_events._buffer = Accessibility_KeyEventTypeSeq_allocbuf (i);
376 if (eventmask & SPI_KEY_PRESSED)
378 key_events._buffer[i++] = Accessibility_KEY_PRESSED;
380 if (eventmask & SPI_KEY_RELEASED)
382 key_events._buffer[i++] = Accessibility_KEY_RELEASED;
384 key_events._length = i;
386 controller_event_mask = (CORBA_unsigned_long) modmask;
388 listener_mode.synchronous =
389 (CORBA_boolean) ((sync_type & SPI_KEYLISTENER_SYNCHRONOUS)!=0);
390 listener_mode.preemptive =
391 (CORBA_boolean) ((sync_type & SPI_KEYLISTENER_CANCONSUME)!=0);
392 listener_mode.global =
393 (CORBA_boolean) ((sync_type & SPI_KEYLISTENER_ALL_WINDOWS)!=0);
395 Accessibility_DeviceEventController_registerKeystrokeListener (
396 device_event_controller,
397 cspi_event_listener_get_corba (listener),
399 controller_event_mask,
404 cspi_return_val_if_ev ("registering keystroke listener", FALSE);
406 cspi_release_unref (device_event_controller);
412 * SPI_deregisterAccessibleKeystrokeListener:
413 * @listener: a pointer to the #AccessibleKeystrokeListener for which
414 * keystroke events are requested.
415 * @modmask: the key modifier mask for which this listener is to be
416 * 'deregistered' (of type #AccessibleeyMaskType).
418 * Removes a keystroke event listener from the registry's listener queue,
419 * ceasing notification of events with modifiers matching @modmask.
421 * Returns: #TRUE if successful, otherwise #FALSE.
424 SPI_deregisterAccessibleKeystrokeListener (AccessibleKeystrokeListener *listener,
425 AccessibleKeyMaskType modmask)
427 Accessibility_ControllerEventMask controller_event_mask;
428 Accessibility_KeySet key_set;
429 Accessibility_KeyEventTypeSeq key_events;
430 Accessibility_DeviceEventController device_event_controller;
437 device_event_controller =
438 Accessibility_Registry_getDeviceEventController (cspi_registry (), cspi_ev ());
440 cspi_return_val_if_ev ("getting keystroke listener", FALSE);
442 controller_event_mask = (CORBA_unsigned_long) modmask;
444 key_events._buffer = NULL;
445 key_events._length = 0;
447 key_set._buffer = NULL;
450 Accessibility_DeviceEventController_deregisterKeystrokeListener (
451 device_event_controller,
452 cspi_event_listener_get_corba (listener),
454 controller_event_mask,
458 cspi_release_unref (device_event_controller);
464 * SPI_generateKeyboardEvent:
465 * @keyval: a long integer indicating the keycode or keysym of the key event
467 * @keystring: an (optional) UTF-8 string which, if @keyval is NULL,
468 * indicates a 'composed' keyboard input string which is
469 * being synthesized; this type of keyboard event synthesis does
470 * not emulate hardware keypresses but injects the string
471 * as though a composing input method (such as XIM) were used.
472 * @synth_type: a #AccessibleKeySynthType flag indicating whether @keyval
473 * is to be interpreted as a keysym rather than a keycode
474 * (CSPI_KEYSYM), or whether to synthesize
475 * SPI_KEY_PRESS, SPI_KEY_RELEASE, or both (SPI_KEY_PRESSRELEASE).
477 * Synthesize a keyboard event (as if a hardware keyboard event occurred in the
478 * current UI context).
480 * Returns: #TRUE if successful, otherwise #FALSE.
483 SPI_generateKeyboardEvent (long int keyval,
485 AccessibleKeySynthType synth_type)
487 /* TODO: check current modifier status and
488 * send keycode to alter, if necessary
491 /* TODO: implement keystring use case */
492 Accessibility_KeySynthType keysynth_type;
493 Accessibility_DeviceEventController device_event_controller =
494 Accessibility_Registry_getDeviceEventController (cspi_registry (), cspi_ev ());
496 cspi_return_val_if_ev ("getting event controller for key event gen", FALSE);
501 keysynth_type = Accessibility_KEY_PRESS;
503 case SPI_KEY_RELEASE:
504 keysynth_type = Accessibility_KEY_RELEASE;
506 case SPI_KEY_PRESSRELEASE:
507 keysynth_type = Accessibility_KEY_PRESSRELEASE;
510 keysynth_type = Accessibility_KEY_SYM;
513 keysynth_type = Accessibility_KEY_STRING;
519 Accessibility_DeviceEventController_generateKeyboardEvent (device_event_controller,
525 cspi_return_val_if_ev ("generating keyboard event", FALSE);
527 cspi_release_unref (device_event_controller);
533 * SPI_generateMouseEvent:
534 * @x: a #long indicating the screen x coordinate of the mouse event.
535 * @y: a #long indicating the screen y coordinate of the mouse event.
536 * @name: a string indicating which mouse event to be synthesized
537 * (e.g. "b1p", "b1c", "b2r", "rel", "abs").
539 * Synthesize a mouse event at a specific screen coordinate.
540 * Most AT clients should use the #AccessibleAction interface when
541 * tempted to generate mouse events, rather than this method.
542 * Event names: b1p = button 1 press; b2r = button 2 release;
543 * b3c = button 3 click; b2d = button 2 double-click;
544 * abs = absolute motion; rel = relative motion.
546 * Returns: #TRUE if successful, otherwise #FALSE.
549 SPI_generateMouseEvent (long x, long y, char *name)
551 Accessibility_DeviceEventController device_event_controller =
552 Accessibility_Registry_getDeviceEventController (cspi_registry (), cspi_ev ());
554 cspi_return_val_if_ev ("getting event controller for mouse event gen", FALSE);
556 Accessibility_DeviceEventController_generateMouseEvent (device_event_controller,
557 x, y, name, cspi_ev ());
558 cspi_return_val_if_ev ("generating mouse event", FALSE);
560 cspi_release_unref (device_event_controller);