1 /* ATK - Accessibility Toolkit
2 * Copyright 2001 Sun Microsystems Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 #include "atkmarshal.c"
24 static void atk_util_class_init (AtkUtilClass *klass);
26 static AtkObject *previous_focus_object = NULL;
28 typedef struct _AtkUtilListenerInfo AtkUtilListenerInfo;
29 struct _AtkUtilListenerInfo
35 static GHashTable *listener_list = NULL;
38 atk_util_get_type (void)
40 static GType type = 0;
44 static const GTypeInfo typeInfo =
46 sizeof (AtkUtilClass),
48 (GBaseFinalizeFunc) NULL,
49 (GClassInitFunc) atk_util_class_init,
50 (GClassFinalizeFunc) NULL,
54 (GInstanceInitFunc) NULL,
56 type = g_type_register_static (G_TYPE_OBJECT, "AtkUtil", &typeInfo, 0) ;
62 * This file supports the addition and removal of multiple focus handlers
63 * as long as they are all called in the same thread.
65 static AtkEventListenerInit focus_tracker_init = (AtkEventListenerInit) NULL;
67 static gboolean init_done = FALSE;
70 * Array of FocusTracker structs
72 static GArray *trackers = NULL;
73 static guint global_index = 0;
75 typedef struct _FocusTracker FocusTracker;
77 struct _FocusTracker {
79 AtkEventListener func;
83 * atk_focus_tracker_init:
84 * @init: Function to be called for focus tracker initialization
86 * Specifies the function to be called for focus tracker initialization.
87 * This function should be called by an implementation of the
88 * ATK interface if any specific work needs to be done to enable
92 atk_focus_tracker_init (AtkEventListenerInit init)
94 if (!focus_tracker_init)
95 focus_tracker_init = init;
99 * atk_add_focus_tracker:
100 * @focus_tracker: Function to be added to the list of functions to be called
101 * when an object receives focus.
103 * Adds the specified function to the list of functions to be called
104 * when an object receives focus.
106 * Returns: added focus tracker id, or 0 on failure.
109 atk_add_focus_tracker (AtkEventListener focus_tracker)
111 g_return_val_if_fail (focus_tracker, 0);
115 if (focus_tracker_init)
117 focus_tracker_init ();
119 trackers = g_array_sized_new (FALSE, TRUE, sizeof (FocusTracker), 0);
126 item.index = ++global_index;
127 item.func = focus_tracker;
128 trackers = g_array_append_val (trackers, item);
138 * atk_remove_focus_tracker:
139 * @tracker_id: the id of the focus tracker to remove
141 * Removes the specified focus tracker from the list of functions
142 * to be called when any object receives focus.
145 atk_remove_focus_tracker (guint tracker_id)
150 if (trackers == NULL)
156 for (i = 0; i < trackers->len; i++)
158 item = &g_array_index (trackers, FocusTracker, i);
159 if (item->index == tracker_id)
161 trackers = g_array_remove_index (trackers, i);
168 * atk_focus_tracker_notify:
169 * @object: an #AtkObject
171 * Cause the focus tracker functions which have been specified to be
172 * executed for the object.
175 atk_focus_tracker_notify (AtkObject *object)
180 if (trackers == NULL)
183 if (object == previous_focus_object)
187 if (previous_focus_object)
188 g_object_unref (previous_focus_object);
190 previous_focus_object = object;
193 g_object_ref (object);
195 for (i = 0; i < trackers->len; i++)
197 item = &g_array_index (trackers, FocusTracker, i);
198 g_return_if_fail (item != NULL);
207 add_listener (GSignalEmissionHook listener,
208 const gchar *object_type,
209 const gchar *signal_name,
210 const gchar *detail_string,
211 const gchar *hook_data)
216 static gint listener_idx = 1;
217 GQuark detail_quark = 0;
219 type = g_type_from_name (object_type);
222 signal_id = g_signal_lookup (signal_name, type);
223 detail_quark = g_quark_from_string (detail_string);
227 AtkUtilListenerInfo *listener_info;
231 listener_info = g_new (AtkUtilListenerInfo, 1);
232 listener_info->key = listener_idx;
233 listener_info->hook_id =
234 g_signal_add_emission_hook (signal_id, detail_quark, listener,
235 g_strdup (hook_data),
236 (GDestroyNotify) g_free);
237 listener_info->signal_id = signal_id;
239 g_hash_table_insert(listener_list, &(listener_info->key), listener_info);
244 g_debug ("Signal type %s not supported\n", signal_name);
249 g_warning("Invalid object type %s\n", object_type);
255 atk_util_real_add_global_event_listener (GSignalEmissionHook listener,
256 const gchar *event_type)
259 gchar **split_string;
262 split_string = g_strsplit (event_type, ":", 0);
263 length = g_strv_length (split_string);
265 if ((length == 3) || (length == 4))
266 rc = add_listener (listener, split_string[1], split_string[2],
267 split_string[3], event_type);
269 g_strfreev (split_string);
275 atk_util_real_remove_global_event_listener (guint remove_listener)
277 if (remove_listener > 0)
279 AtkUtilListenerInfo *listener_info;
280 gint tmp_idx = remove_listener;
282 listener_info = (AtkUtilListenerInfo *)
283 g_hash_table_lookup(listener_list, &tmp_idx);
285 if (listener_info != NULL)
287 /* Hook id of 0 and signal id of 0 are invalid */
288 if (listener_info->hook_id != 0 && listener_info->signal_id != 0)
290 /* Remove the emission hook */
291 g_signal_remove_emission_hook(listener_info->signal_id,
292 listener_info->hook_id);
294 /* Remove the element from the hash */
295 g_hash_table_remove(listener_list, &tmp_idx);
299 g_warning("Invalid listener hook_id %ld or signal_id %d\n",
300 listener_info->hook_id, listener_info->signal_id);
305 g_warning("No listener with the specified listener id %d",
311 g_warning("Invalid listener_id %d", remove_listener);
317 * atk_add_global_event_listener:
318 * @listener: the listener to notify
319 * @event_type: the type of event for which notification is requested
321 * Adds the specified function to the list of functions to be called
322 * when an ATK event of type event_type occurs.
324 * The format of event_type is the following:
325 * "ATK:<atk_type>:<atk_event>:<atk_event_detail>
327 * Where "ATK" works as the namespace, <atk_interface> is the name of
328 * the ATK type (interface or object), <atk_event> is the name of the
329 * signal defined on that interface and <atk_event_detail> is the
330 * gsignal detail of that signal. You can find more info about gsignal
332 * http://developer.gnome.org/gobject/stable/gobject-Signals.html
334 * The first three parameters are mandatory. The last one is optional.
337 * ATK:AtkObject:state-change
338 * ATK:AtkText:text-selection-changed
339 * ATK:AtkText:text-insert:system
341 * Toolkit implementor note: Atk provides a default implementation for
342 * this virtual method, and that implementation should be enough for
343 * most of the cases. You should have a really good reason to
344 * reimplement this method.
346 * Returns: added event listener id, or 0 on failure.
349 atk_add_global_event_listener (GSignalEmissionHook listener,
350 const gchar *event_type)
353 AtkUtilClass *klass = g_type_class_ref (ATK_TYPE_UTIL);
355 if (klass->add_global_event_listener)
357 retval = klass->add_global_event_listener (listener, event_type);
363 g_type_class_unref (klass);
369 * atk_remove_global_event_listener:
370 * @listener_id: the id of the event listener to remove
372 * @listener_id is the value returned by #atk_add_global_event_listener
373 * when you registered that event listener.
375 * Toolkit implementor note: Atk provides a default implementation for
376 * this virtual method, and that implementation should be enough for
377 * most of the cases. You should have a really good reason to
378 * reimplement this method.
380 * Removes the specified event listener
383 atk_remove_global_event_listener (guint listener_id)
385 AtkUtilClass *klass = g_type_class_peek (ATK_TYPE_UTIL);
387 if (klass && klass->remove_global_event_listener)
388 klass->remove_global_event_listener (listener_id);
392 * atk_add_key_event_listener:
393 * @listener: the listener to notify
394 * @data: a #gpointer that points to a block of data that should be sent to the registered listeners,
395 * along with the event notification, when it occurs.
397 * Adds the specified function to the list of functions to be called
398 * when a key event occurs. The @data element will be passed to the
399 * #AtkKeySnoopFunc (@listener) as the @func_data param, on notification.
401 * Returns: added event listener id, or 0 on failure.
404 atk_add_key_event_listener (AtkKeySnoopFunc listener, gpointer data)
407 AtkUtilClass *klass = g_type_class_peek (ATK_TYPE_UTIL);
408 if (klass && klass->add_key_event_listener)
410 retval = klass->add_key_event_listener (listener, data);
421 * atk_remove_key_event_listener:
422 * @listener_id: the id of the event listener to remove
424 * @listener_id is the value returned by #atk_add_key_event_listener
425 * when you registered that event listener.
427 * Removes the specified event listener.
430 atk_remove_key_event_listener (guint listener_id)
432 AtkUtilClass *klass = g_type_class_peek (ATK_TYPE_UTIL);
434 if (klass->remove_key_event_listener)
435 klass->remove_key_event_listener (listener_id);
441 * Gets the root accessible container for the current application.
443 * Returns: (transfer none): the root accessible container for the current
449 AtkUtilClass *klass = g_type_class_ref (ATK_TYPE_UTIL);
453 retval = klass->get_root ();
459 g_type_class_unref (klass);
465 * atk_get_focus_object:
467 * Gets the currently focused object.
471 * Returns: (transfer none): the currently focused object for the current
475 atk_get_focus_object (void)
477 return previous_focus_object;
481 * atk_get_toolkit_name:
483 * Gets name string for the GUI toolkit implementing ATK for this application.
485 * Returns: name string for the GUI toolkit implementing ATK for this application
488 atk_get_toolkit_name (void)
491 AtkUtilClass *klass = g_type_class_ref (ATK_TYPE_UTIL);
492 if (klass->get_toolkit_name)
494 retval = klass->get_toolkit_name ();
500 g_type_class_unref (klass);
506 * atk_get_toolkit_version:
508 * Gets version string for the GUI toolkit implementing ATK for this application.
510 * Returns: version string for the GUI toolkit implementing ATK for this application
513 atk_get_toolkit_version (void)
516 AtkUtilClass *klass = g_type_class_ref (ATK_TYPE_UTIL);
517 if (klass->get_toolkit_version)
519 retval = klass->get_toolkit_version ();
525 g_type_class_unref (klass);
533 * Gets the current version for ATK.
535 * Returns: version string for ATK
540 atk_get_version (void)
546 atk_util_class_init (AtkUtilClass *klass)
548 klass->add_global_event_listener = atk_util_real_add_global_event_listener;
549 klass->remove_global_event_listener = atk_util_real_remove_global_event_listener;
550 klass->get_root = NULL;
551 klass->get_toolkit_name = NULL;
552 klass->get_toolkit_version = NULL;
554 listener_list = g_hash_table_new_full (g_int_hash, g_int_equal, NULL,