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.
23 #include "atkmarshal.c"
27 * @Short_description: A set of ATK utility functions for event and toolkit support.
30 * A set of ATK utility functions which are used to support event
31 * registration of various types, and obtaining the 'root' accessible
32 * of a process and information about the current ATK implementation
33 * and toolkit version.
36 static void atk_util_class_init (AtkUtilClass
*klass
);
38 static AtkObject
*previous_focus_object
= NULL
;
40 typedef struct _AtkUtilListenerInfo AtkUtilListenerInfo
;
41 struct _AtkUtilListenerInfo
47 static GHashTable
*listener_list
= NULL
;
50 atk_util_get_type (void)
52 static GType type
= 0;
56 static const GTypeInfo typeInfo
=
58 sizeof (AtkUtilClass
),
60 (GBaseFinalizeFunc
) NULL
,
61 (GClassInitFunc
) atk_util_class_init
,
62 (GClassFinalizeFunc
) NULL
,
66 (GInstanceInitFunc
) NULL
,
68 type
= g_type_register_static (G_TYPE_OBJECT
, "AtkUtil", &typeInfo
, 0) ;
74 * This file supports the addition and removal of multiple focus handlers
75 * as long as they are all called in the same thread.
77 static AtkEventListenerInit focus_tracker_init
= (AtkEventListenerInit
) NULL
;
79 static gboolean init_done
= FALSE
;
82 * Array of FocusTracker structs
84 static GArray
*trackers
= NULL
;
85 static guint global_index
= 0;
87 typedef struct _FocusTracker FocusTracker
;
89 struct _FocusTracker
{
91 AtkEventListener func
;
95 * atk_focus_tracker_init:
96 * @init: Function to be called for focus tracker initialization
98 * Specifies the function to be called for focus tracker initialization.
99 * This function should be called by an implementation of the
100 * ATK interface if any specific work needs to be done to enable
103 * Deprecated: This method is deprecated since ATK version
104 * 2.9.4. Focus tracking has been dropped as a feature to be
105 * implemented by ATK itself.
109 atk_focus_tracker_init (AtkEventListenerInit init
)
111 if (!focus_tracker_init
)
112 focus_tracker_init
= init
;
116 * atk_add_focus_tracker:
117 * @focus_tracker: Function to be added to the list of functions to be called
118 * when an object receives focus.
120 * Adds the specified function to the list of functions to be called
121 * when an object receives focus.
123 * Deprecated: This method is deprecated since ATK version
124 * 2.9.4. Focus tracking has been dropped as a feature to be
125 * implemented by ATK itself. If you need focus tracking on your
126 * implementation, subscribe to the state-changed:focused signal.
128 * Returns: added focus tracker id, or 0 on failure.
131 atk_add_focus_tracker (AtkEventListener focus_tracker
)
133 g_return_val_if_fail (focus_tracker
, 0);
137 if (focus_tracker_init
)
139 focus_tracker_init ();
141 trackers
= g_array_sized_new (FALSE
, TRUE
, sizeof (FocusTracker
), 0);
148 item
.index
= ++global_index
;
149 item
.func
= focus_tracker
;
150 trackers
= g_array_append_val (trackers
, item
);
160 * atk_remove_focus_tracker:
161 * @tracker_id: the id of the focus tracker to remove
163 * Deprecated: This method is deprecated since ATK version
164 * 2.9.4. Focus tracking has been dropped as a feature to be
165 * implemented by ATK itself. If you need focus tracking on your
166 * implementation, subscribe to the state-changed:focused signal.
168 * Removes the specified focus tracker from the list of functions
169 * to be called when any object receives focus.
172 atk_remove_focus_tracker (guint tracker_id
)
177 if (trackers
== NULL
)
183 for (i
= 0; i
< trackers
->len
; i
++)
185 item
= &g_array_index (trackers
, FocusTracker
, i
);
186 if (item
->index
== tracker_id
)
188 trackers
= g_array_remove_index (trackers
, i
);
195 * atk_focus_tracker_notify:
196 * @object: an #AtkObject
198 * Cause the focus tracker functions which have been specified to be
199 * executed for the object.
201 * Deprecated: This method is deprecated since ATK version
202 * 2.9.4. Focus tracking has been dropped as a feature to be
203 * implemented by ATK itself.
207 atk_focus_tracker_notify (AtkObject
*object
)
212 if (trackers
== NULL
)
215 if (object
== previous_focus_object
)
219 if (previous_focus_object
)
220 g_object_unref (previous_focus_object
);
222 previous_focus_object
= object
;
225 g_object_ref (object
);
227 for (i
= 0; i
< trackers
->len
; i
++)
229 item
= &g_array_index (trackers
, FocusTracker
, i
);
230 g_return_if_fail (item
!= NULL
);
239 add_listener (GSignalEmissionHook listener
,
240 const gchar
*object_type
,
241 const gchar
*signal_name
,
242 const gchar
*detail_string
,
243 const gchar
*hook_data
)
248 static gint listener_idx
= 1;
249 GQuark detail_quark
= 0;
251 type
= g_type_from_name (object_type
);
254 signal_id
= g_signal_lookup (signal_name
, type
);
255 detail_quark
= g_quark_from_string (detail_string
);
259 AtkUtilListenerInfo
*listener_info
;
263 listener_info
= g_new (AtkUtilListenerInfo
, 1);
264 listener_info
->key
= listener_idx
;
265 listener_info
->hook_id
=
266 g_signal_add_emission_hook (signal_id
, detail_quark
, listener
,
267 g_strdup (hook_data
),
268 (GDestroyNotify
) g_free
);
269 listener_info
->signal_id
= signal_id
;
271 g_hash_table_insert(listener_list
, &(listener_info
->key
), listener_info
);
276 g_debug ("Signal type %s not supported\n", signal_name
);
281 g_warning("Invalid object type %s\n", object_type
);
287 atk_util_real_add_global_event_listener (GSignalEmissionHook listener
,
288 const gchar
*event_type
)
291 gchar
**split_string
;
294 split_string
= g_strsplit (event_type
, ":", 0);
295 length
= g_strv_length (split_string
);
297 if ((length
== 3) || (length
== 4))
298 rc
= add_listener (listener
, split_string
[1], split_string
[2],
299 split_string
[3], event_type
);
301 g_strfreev (split_string
);
307 atk_util_real_remove_global_event_listener (guint remove_listener
)
309 if (remove_listener
> 0)
311 AtkUtilListenerInfo
*listener_info
;
312 gint tmp_idx
= remove_listener
;
314 listener_info
= (AtkUtilListenerInfo
*)
315 g_hash_table_lookup(listener_list
, &tmp_idx
);
317 if (listener_info
!= NULL
)
319 /* Hook id of 0 and signal id of 0 are invalid */
320 if (listener_info
->hook_id
!= 0 && listener_info
->signal_id
!= 0)
322 /* Remove the emission hook */
323 g_signal_remove_emission_hook(listener_info
->signal_id
,
324 listener_info
->hook_id
);
326 /* Remove the element from the hash */
327 g_hash_table_remove(listener_list
, &tmp_idx
);
331 g_warning("Invalid listener hook_id %ld or signal_id %d\n",
332 listener_info
->hook_id
, listener_info
->signal_id
);
337 g_warning("No listener with the specified listener id %d",
343 g_warning("Invalid listener_id %d", remove_listener
);
349 * atk_add_global_event_listener:
350 * @listener: the listener to notify
351 * @event_type: the type of event for which notification is requested
353 * Adds the specified function to the list of functions to be called
354 * when an ATK event of type event_type occurs.
356 * The format of event_type is the following:
357 * "ATK:<atk_type>:<atk_event>:<atk_event_detail>
359 * Where "ATK" works as the namespace, <atk_interface> is the name of
360 * the ATK type (interface or object), <atk_event> is the name of the
361 * signal defined on that interface and <atk_event_detail> is the
362 * gsignal detail of that signal. You can find more info about gsignal
364 * http://developer.gnome.org/gobject/stable/gobject-Signals.html
366 * The first three parameters are mandatory. The last one is optional.
369 * ATK:AtkObject:state-change
370 * ATK:AtkText:text-selection-changed
371 * ATK:AtkText:text-insert:system
373 * Toolkit implementor note: ATK provides a default implementation for
374 * this virtual method. ATK implementors are discouraged from
375 * reimplementing this method.
377 * Toolkit implementor note: this method is not intended to be used by
378 * ATK implementors but by ATK consumers.
380 * Returns: added event listener id, or 0 on failure.
383 atk_add_global_event_listener (GSignalEmissionHook listener
,
384 const gchar
*event_type
)
387 AtkUtilClass
*klass
= g_type_class_ref (ATK_TYPE_UTIL
);
389 if (klass
->add_global_event_listener
)
391 retval
= klass
->add_global_event_listener (listener
, event_type
);
397 g_type_class_unref (klass
);
403 * atk_remove_global_event_listener:
404 * @listener_id: the id of the event listener to remove
406 * @listener_id is the value returned by #atk_add_global_event_listener
407 * when you registered that event listener.
409 * Toolkit implementor note: ATK provides a default implementation for
410 * this virtual method. ATK implementors are discouraged from
411 * reimplementing this method.
413 * Toolkit implementor note: this method is not intended to be used by
414 * ATK implementors but by ATK consumers.
416 * Removes the specified event listener
419 atk_remove_global_event_listener (guint listener_id
)
421 AtkUtilClass
*klass
= g_type_class_peek (ATK_TYPE_UTIL
);
423 if (klass
&& klass
->remove_global_event_listener
)
424 klass
->remove_global_event_listener (listener_id
);
428 * atk_add_key_event_listener:
429 * @listener: the listener to notify
430 * @data: a #gpointer that points to a block of data that should be sent to the registered listeners,
431 * along with the event notification, when it occurs.
433 * Adds the specified function to the list of functions to be called
434 * when a key event occurs. The @data element will be passed to the
435 * #AtkKeySnoopFunc (@listener) as the @func_data param, on notification.
437 * Returns: added event listener id, or 0 on failure.
440 atk_add_key_event_listener (AtkKeySnoopFunc listener
, gpointer data
)
443 AtkUtilClass
*klass
= g_type_class_peek (ATK_TYPE_UTIL
);
444 if (klass
&& klass
->add_key_event_listener
)
446 retval
= klass
->add_key_event_listener (listener
, data
);
457 * atk_remove_key_event_listener:
458 * @listener_id: the id of the event listener to remove
460 * @listener_id is the value returned by #atk_add_key_event_listener
461 * when you registered that event listener.
463 * Removes the specified event listener.
466 atk_remove_key_event_listener (guint listener_id
)
468 AtkUtilClass
*klass
= g_type_class_peek (ATK_TYPE_UTIL
);
470 if (klass
->remove_key_event_listener
)
471 klass
->remove_key_event_listener (listener_id
);
477 * Gets the root accessible container for the current application.
479 * Returns: (transfer none): the root accessible container for the current
485 AtkUtilClass
*klass
= g_type_class_ref (ATK_TYPE_UTIL
);
489 retval
= klass
->get_root ();
495 g_type_class_unref (klass
);
501 * atk_get_focus_object:
503 * Gets the currently focused object.
507 * Returns: (transfer none): the currently focused object for the current
511 atk_get_focus_object (void)
513 return previous_focus_object
;
517 * atk_get_toolkit_name:
519 * Gets name string for the GUI toolkit implementing ATK for this application.
521 * Returns: name string for the GUI toolkit implementing ATK for this application
524 atk_get_toolkit_name (void)
527 AtkUtilClass
*klass
= g_type_class_ref (ATK_TYPE_UTIL
);
528 if (klass
->get_toolkit_name
)
530 retval
= klass
->get_toolkit_name ();
536 g_type_class_unref (klass
);
542 * atk_get_toolkit_version:
544 * Gets version string for the GUI toolkit implementing ATK for this application.
546 * Returns: version string for the GUI toolkit implementing ATK for this application
549 atk_get_toolkit_version (void)
552 AtkUtilClass
*klass
= g_type_class_ref (ATK_TYPE_UTIL
);
553 if (klass
->get_toolkit_version
)
555 retval
= klass
->get_toolkit_version ();
561 g_type_class_unref (klass
);
569 * Gets the current version for ATK.
571 * Returns: version string for ATK
576 atk_get_version (void)
582 atk_util_class_init (AtkUtilClass
*klass
)
584 klass
->add_global_event_listener
= atk_util_real_add_global_event_listener
;
585 klass
->remove_global_event_listener
= atk_util_real_remove_global_event_listener
;
586 klass
->get_root
= NULL
;
587 klass
->get_toolkit_name
= NULL
;
588 klass
->get_toolkit_version
= NULL
;
590 listener_list
= g_hash_table_new_full (g_int_hash
, g_int_equal
, NULL
,