3 * AT-SPI - Assistive Technology Service Provider Interface
4 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
6 * Copyright 2001, 2002 Sun Microsystems Inc.,
7 * Copyright 2001, 2002 Ximian, Inc.
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Library General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Library General Public License for more details.
19 * You should have received a copy of the GNU Library General Public
20 * License along with this library; if not, write to the
21 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 * Boston, MA 02111-1307, USA.
25 /* atspi_registry.c: Global functions wrapping the registry */
27 #include "atspi-private.h"
31 AtspiDeviceListener *listener;
33 AtspiKeyMaskType modmask;
34 AtspiKeyEventMask event_types;
36 } DeviceListenerEntry;
38 static GList *device_listeners;
41 * atspi_get_desktop_count:
43 * Gets the number of virtual desktops.
44 * NOTE: multiple virtual desktops are not implemented yet; as a
45 * consequence, this function always returns 1.
47 * Returns: a #gint indicating the number of active virtual desktops.
50 atspi_get_desktop_count ()
57 * @i: a #gint indicating which of the accessible desktops is to be returned.
59 * Gets the virtual desktop indicated by index @i.
60 * NOTE: currently multiple virtual desktops are not implemented;
61 * as a consequence, any @i value different from 0 will not return a
62 * virtual desktop - instead it will return NULL.
64 * Returns: (transfer full): a pointer to the @i-th virtual desktop's
65 * #AtspiAccessible representation.
68 atspi_get_desktop (gint i)
70 if (i != 0) return NULL;
71 return _atspi_ref_accessible (atspi_bus_registry, atspi_path_root);
75 * atspi_get_desktop_list:
77 * Gets the list of virtual desktops. On return, @list will point
78 * to a newly-created, NULL terminated array of virtual desktop
80 * It is the responsibility of the caller to free this array when
81 * it is no longer needed.
82 * NOTE: currently multiple virtual desktops are not implemented;
83 * this implementation always returns a #Garray with a single
84 * #AtspiAccessible desktop.
86 * Returns: (element-type AtspiAccessible*) (transfer full): a #GArray of
90 atspi_get_desktop_list ()
92 GArray *array = g_array_new (TRUE, TRUE, sizeof (AtspiAccessible *));
93 AtspiAccessible *desktop;
95 desktop = _atspi_ref_accessible (atspi_bus_registry, atspi_path_root);
97 g_array_index (array, AtspiAccessible *, 0) = desktop;
102 notify_keystroke_listener (DeviceListenerEntry *e)
104 gchar *path = _atspi_device_listener_get_path (e->listener);
105 dbus_uint32_t d_modmask = e->modmask;
106 dbus_uint32_t d_event_types = e->event_types;
107 AtspiEventListenerMode listener_mode;
108 gboolean retval = FALSE;
111 listener_mode.synchronous =
112 (dbus_bool_t) ((e->sync_type & ATSPI_KEYLISTENER_SYNCHRONOUS)!=0);
113 listener_mode.preemptive =
114 (dbus_bool_t) ((e->sync_type & ATSPI_KEYLISTENER_CANCONSUME)!=0);
115 listener_mode.global =
116 (dbus_bool_t) ((e->sync_type & ATSPI_KEYLISTENER_ALL_WINDOWS)!=0);
118 dbus_error_init (&d_error);
119 dbind_method_call_reentrant (_atspi_bus(), atspi_bus_registry,
120 atspi_path_dec, atspi_interface_dec,
121 "RegisterKeystrokeListener", &d_error,
122 "oa(iisi)uu(bbb)=>b", path, e->key_set,
123 d_modmask, d_event_types, &listener_mode,
125 if (dbus_error_is_set (&d_error))
127 g_warning ("RegisterKeystrokeListener failed: %s", d_error.message);
128 dbus_error_free (&d_error);
137 device_listener_entry_free (DeviceListenerEntry *e)
139 g_array_free (e->key_set, TRUE);
144 unregister_listener (gpointer data, GObject *object)
147 AtspiDeviceListener *listener = ATSPI_DEVICE_LISTENER (object);
149 for (l = device_listeners; l;)
151 DeviceListenerEntry *e = l->data;
152 if (e->listener == listener)
154 GList *next = l->next;
155 device_listener_entry_free (e);
156 device_listeners = g_list_delete_link (device_listeners, l);
165 * atspi_register_keystroke_listener:
166 * @listener: a pointer to the #AtspiDeviceListener for which
167 * keystroke events are requested.
168 * @key_set: (element-type AtspiKeyDefinition) (allow-none): a pointer to the
169 * #AtspiKeyDefinition array indicating which keystroke events are
171 * to indicate that all keycodes and keyvals for the specified
172 * modifier set are to be included.
173 * @modmask: an #AtspiKeyMaskType mask indicating which
174 * key event modifiers must be set in combination with @keys,
175 * events will only be reported for key events for which all
176 * modifiers in @modmask are set. If you wish to listen for
177 * events with multiple modifier combinations, you must call
178 * #atspi_register_keystroke_listener once for each
180 * @event_types: an #AtspiKeyMaskType mask indicating which
181 * types of key events are requested (%ATSPI_KEY_PRESSED etc.).
182 * @sync_type: an #AtspiKeyListenerSyncType parameter indicating
183 * the behavior of the notification/listener transaction.
184 * @error: (allow-none): a pointer to a %NULL #GError pointer, or %NULL
186 * Registers a listener for keystroke events, either pre-emptively for
187 * all windows (%ATSPI_KEYLISTENER_ALL_WINDOWS),
188 * non-preemptively (%ATSPI_KEYLISTENER_NOSYNC), or
189 * pre-emptively at the toolkit level (%ATSPI_KEYLISTENER_CANCONSUME).
190 * If ALL_WINDOWS or CANCONSUME are used, the event is consumed
191 * upon receipt if one of @listener's callbacks returns %TRUE
192 * (other sync_type values may be available in the future).
194 * Returns: %TRUE if successful, otherwise %FALSE.
197 atspi_register_keystroke_listener (AtspiDeviceListener *listener,
199 AtspiKeyMaskType modmask,
200 AtspiKeyEventMask event_types,
201 AtspiKeyListenerSyncType sync_type,
204 DeviceListenerEntry *e;
206 g_return_val_if_fail (listener != NULL, FALSE);
208 e = g_new0 (DeviceListenerEntry, 1);
209 e->listener = listener;
210 e->modmask = modmask;
211 e->event_types = event_types;
212 e->sync_type = sync_type;
216 e->key_set = g_array_sized_new (FALSE, TRUE, sizeof (AtspiKeyDefinition),
218 e->key_set->len = key_set->len;
219 for (i = 0; i < key_set->len; i++)
221 AtspiKeyDefinition *kd = ((AtspiKeyDefinition *) key_set->data) + i;
222 AtspiKeyDefinition *d_kd = ((AtspiKeyDefinition *) e->key_set->data) + i;
223 d_kd->keycode = kd->keycode;
224 d_kd->keysym = kd->keysym;
227 d_kd->keystring = kd->keystring;
231 d_kd->keystring = "";
237 e->key_set = g_array_sized_new (FALSE, TRUE, sizeof (AtspiKeyDefinition), 0);
240 g_object_weak_ref (G_OBJECT (listener), unregister_listener, NULL);
241 device_listeners = g_list_prepend (device_listeners, e);
242 return notify_keystroke_listener (e);
246 * atspi_deregister_keystroke_listener:
247 * @listener: a pointer to the #AtspiDeviceListener for which
248 * keystroke events are requested.
249 * @key_set: (element-type AtspiKeyDefinition) (allow-none): a pointer to the
250 * #AtspiKeyDefinition array indicating which keystroke events are
251 * requested, or %NULL
252 * to indicate that all keycodes and keyvals for the specified
253 * modifier set are to be included.
254 * @modmask: the key modifier mask for which this listener is to be
255 * 'deregistered' (of type #AtspiKeyMaskType).
256 * @event_types: an #AtspiKeyMaskType mask indicating which
257 * types of key events were requested (%ATSPI_KEY_PRESSED, etc.).
258 * @error: (allow-none): a pointer to a %NULL #GError pointer, or %NULL
260 * Removes a keystroke event listener from the registry's listener queue,
261 * ceasing notification of events with modifiers matching @modmask.
263 * Returns: %TRUE if successful, otherwise %FALSE.
266 atspi_deregister_keystroke_listener (AtspiDeviceListener *listener,
268 AtspiKeyMaskType modmask,
269 AtspiKeyEventMask event_types,
273 gchar *path = _atspi_device_listener_get_path (listener);
275 dbus_uint32_t d_modmask = modmask;
276 dbus_uint32_t d_event_types = event_types;
280 dbus_error_init (&d_error);
286 /* copy the keyval filter values from the C api into the DBind KeySet */
289 d_key_set = g_array_sized_new (FALSE, TRUE, sizeof (AtspiKeyDefinition), key_set->len);
290 d_key_set->len = key_set->len;
291 for (i = 0; i < key_set->len; ++i)
293 AtspiKeyDefinition *kd = ((AtspiKeyDefinition *) key_set->data) + i;
294 AtspiKeyDefinition *d_kd = ((AtspiKeyDefinition *) d_key_set->data) + i;
295 d_kd->keycode = kd->keycode;
296 d_kd->keysym = kd->keysym;
299 d_kd->keystring = kd->keystring;
303 d_kd->keystring = "";
309 d_key_set = g_array_sized_new (FALSE, TRUE, sizeof (AtspiKeyDefinition), 0);
312 dbind_method_call_reentrant (_atspi_bus(), atspi_bus_registry,
313 atspi_path_dec, atspi_interface_dec,
314 "DeregisterKeystrokeListener", &d_error,
315 "oa(iisi)uu", path, d_key_set, d_modmask,
317 if (dbus_error_is_set (&d_error))
319 g_warning ("DeregisterKeystrokeListener failed: %s", d_error.message);
320 dbus_error_free (&d_error);
323 unregister_listener (listener, NULL);
324 for (l = device_listeners; l;)
326 /* TODO: This code is all wrong / doesn't match what is in
327 * deviceeventcontroller.c. It would be nice to deprecate these methods
328 * in favor of methods that return an ID for the registration that can
329 * be passed to a deregister function, for instance. */
330 DeviceListenerEntry *e = l->data;
331 if (e->modmask == modmask && e->event_types == event_types)
333 GList *next = l->next;
334 device_listener_entry_free (e);
335 device_listeners = g_list_delete_link (device_listeners, l);
341 g_array_free (d_key_set, TRUE);
347 * atspi_register_device_event_listener:
348 * @listener: a pointer to the #AtspiDeviceListener which requests
350 * @event_types: an #AtspiDeviceEventMask mask indicating which
351 * types of key events are requested (%ATSPI_KEY_PRESSED, etc.).
352 * @filter: (allow-none): Unused parameter.
353 * @error: (allow-none): a pointer to a %NULL #GError pointer, or %NULL
355 * Registers a listener for device events, for instance button events.
357 * Returns: %TRUE if successful, otherwise %FALSE.
360 atspi_register_device_event_listener (AtspiDeviceListener *listener,
361 AtspiDeviceEventMask event_types,
362 void *filter, GError **error)
364 gboolean retval = FALSE;
365 dbus_uint32_t d_event_types = event_types;
366 gchar *path = _atspi_device_listener_get_path (listener);
369 dbus_error_init (&d_error);
375 dbind_method_call_reentrant (_atspi_bus(), atspi_bus_registry, atspi_path_dec, atspi_interface_dec, "RegisterDeviceEventListener", &d_error, "ou=>b", path, d_event_types, &retval);
376 if (dbus_error_is_set (&d_error))
378 g_warning ("RegisterDeviceEventListener failed: %s", d_error.message);
379 dbus_error_free (&d_error);
387 * atspi_deregister_device_event_listener:
388 * @listener: a pointer to the #AtspiDeviceListener for which
389 * device events are requested.
390 * @filter: (allow-none): Unused parameter.
391 * @error: (allow-none): a pointer to a %NULL #GError pointer, or %NULL
393 * Removes a device event listener from the registry's listener queue,
394 * ceasing notification of events of the specified type.
396 * Returns: %TRUE if successful, otherwise %FALSE.
399 atspi_deregister_device_event_listener (AtspiDeviceListener *listener,
400 void *filter, GError **error)
402 dbus_uint32_t event_types = 0;
403 gchar *path = _atspi_device_listener_get_path (listener);
406 dbus_error_init (&d_error);
413 event_types |= (1 << ATSPI_BUTTON_PRESSED_EVENT);
414 event_types |= (1 << ATSPI_BUTTON_RELEASED_EVENT);
416 dbind_method_call_reentrant (_atspi_bus(), atspi_bus_registry, atspi_path_dec, atspi_interface_dec, "DeregisterDeviceEventListener", &d_error, "ou", path, event_types);
417 if (dbus_error_is_set (&d_error))
419 g_warning ("DeregisterDeviceEventListener failed: %s", d_error.message);
420 dbus_error_free (&d_error);
428 * atspi_generate_keyboard_event:
429 * @keyval: a #gint indicating the keycode or keysym of the key event
431 * @keystring: (allow-none): an (optional) UTF-8 string which, if
432 * @synth_type is %ATSPI_KEY_STRING, indicates a 'composed'
433 * keyboard input string being synthesized; this type of
434 * keyboard event synthesis does not emulate hardware
435 * keypresses but injects the string as though a composing
436 * input method (such as XIM) were used.
437 * @synth_type: an #AtspiKeySynthType flag indicating whether @keyval
438 * is to be interpreted as a keysym rather than a keycode
439 * (%ATSPI_KEY_SYM) or a string (%ATSPI_KEY_STRING), or
440 * whether to synthesize %ATSPI_KEY_PRESS,
441 * %ATSPI_KEY_RELEASE, or both (%ATSPI_KEY_PRESSRELEASE).
442 * @error: (allow-none): a pointer to a %NULL #GError pointer, or %NULL
444 * Synthesizes a keyboard event (as if a hardware keyboard event occurred in the
445 * current UI context).
447 * Returns: %TRUE if successful, otherwise %FALSE.
450 atspi_generate_keyboard_event (glong keyval,
451 const gchar *keystring,
452 AtspiKeySynthType synth_type, GError **error)
454 dbus_uint32_t d_synth_type = synth_type;
455 dbus_int32_t d_keyval = keyval;
458 dbus_error_init (&d_error);
461 dbind_method_call_reentrant (_atspi_bus(), atspi_bus_registry, atspi_path_dec, atspi_interface_dec, "GenerateKeyboardEvent", &d_error, "isu", d_keyval, keystring, d_synth_type);
462 if (dbus_error_is_set (&d_error))
464 g_warning ("GenerateKeyboardEvent failed: %s", d_error.message);
465 dbus_error_free (&d_error);
472 * atspi_generate_mouse_event:
473 * @x: a #glong indicating the screen x coordinate of the mouse event.
474 * @y: a #glong indicating the screen y coordinate of the mouse event.
475 * @name: a string indicating which mouse event to be synthesized
476 * (e.g. "b1p", "b1c", "b2r", "rel", "abs").
477 * @error: (allow-none): a pointer to a %NULL #GError pointer, or %NULL
479 * Synthesizes a mouse event at a specific screen coordinate.
480 * Most AT clients should use the #AccessibleAction interface when
481 * tempted to generate mouse events, rather than this method.
482 * Event names: b1p = button 1 press; b2r = button 2 release;
483 * b3c = button 3 click; b2d = button 2 double-click;
484 * abs = absolute motion; rel = relative motion.
486 * Returns: %TRUE if successful, otherwise %FALSE.
489 atspi_generate_mouse_event (glong x, glong y, const gchar *name, GError **error)
491 dbus_int32_t d_x = x, d_y = y;
494 dbus_error_init (&d_error);
495 dbind_method_call_reentrant (_atspi_bus(), atspi_bus_registry,
496 atspi_path_dec, atspi_interface_dec,
497 "GenerateMouseEvent", &d_error, "iis",
499 if (dbus_error_is_set (&d_error))
501 g_warning ("GenerateMouseEvent failed: %s", d_error.message);
502 dbus_error_free (&d_error);
509 atspi_key_definition_copy (AtspiKeyDefinition *src)
511 AtspiKeyDefinition *dst;
513 dst = g_new0 (AtspiKeyDefinition, 1);
514 dst->keycode = src->keycode;
515 dst->keysym = src->keysym;
517 dst->keystring = g_strdup (src->keystring);
518 dst->unused = src->unused;
523 atspi_key_definition_free (AtspiKeyDefinition *kd)
526 g_free (kd->keystring);
531 _atspi_reregister_device_listeners ()
534 DeviceListenerEntry *e;
536 for (l = device_listeners; l; l = l->next)
539 notify_keystroke_listener (e);
542 G_DEFINE_BOXED_TYPE (AtspiKeyDefinition, atspi_key_definition, atspi_key_definition_copy, atspi_key_definition_free)