* Boston, MA 02111-1307, USA.
*/
-#include "atkutil.h"
-#include "atkmarshal.c"
#include "config.h"
+#include "atkutil.h"
+#include "atkmarshal.h"
+
+/**
+ * SECTION:atkutil
+ * @Short_description: A set of ATK utility functions for event and toolkit support.
+ * @Title:AtkUtil
+ *
+ * A set of ATK utility functions which are used to support event
+ * registration of various types, and obtaining the 'root' accessible
+ * of a process and information about the current ATK implementation
+ * and toolkit version.
+ */
+
static void atk_util_class_init (AtkUtilClass *klass);
static AtkObject *previous_focus_object = NULL;
* This function should be called by an implementation of the
* ATK interface if any specific work needs to be done to enable
* focus tracking.
+ *
+ * Deprecated: 2.9.4: Focus tracking has been dropped as a feature
+ * to be implemented by ATK itself.
+ *
**/
void
atk_focus_tracker_init (AtkEventListenerInit init)
* Adds the specified function to the list of functions to be called
* when an object receives focus.
*
+ * Deprecated: 2.9.4: Focus tracking has been dropped as a feature
+ * to be implemented by ATK itself. If you need focus tracking on your
+ * implementation, subscribe to the #AtkObject::state-change "focused" signal.
+ *
* Returns: added focus tracker id, or 0 on failure.
**/
guint
* atk_remove_focus_tracker:
* @tracker_id: the id of the focus tracker to remove
*
+ * Deprecated: 2.9.4: Focus tracking has been dropped as a feature
+ * to be implemented by ATK itself. If you need focus tracking on your
+ * implementation, subscribe to the #AtkObject::state-change "focused" signal.
+ *
* Removes the specified focus tracker from the list of functions
* to be called when any object receives focus.
**/
*
* Cause the focus tracker functions which have been specified to be
* executed for the object.
+ *
+ * Deprecated: 2.9.4: Focus tracking has been dropped as a feature
+ * to be implemented by ATK itself. As #AtkObject::focus-event was
+ * deprecated in favor of a #AtkObject::state-change signal, in order
+ * to notify a focus change on your implementation, you can use
+ * atk_object_notify_state_change() instead.
**/
void
atk_focus_tracker_notify (AtkObject *object)
add_listener (GSignalEmissionHook listener,
const gchar *object_type,
const gchar *signal_name,
+ const gchar *detail_string,
const gchar *hook_data)
{
GType type;
guint signal_id;
gint rc = 0;
static gint listener_idx = 1;
+ GQuark detail_quark = 0;
type = g_type_from_name (object_type);
if (type)
{
signal_id = g_signal_lookup (signal_name, type);
+ detail_quark = g_quark_from_string (detail_string);
+
if (signal_id > 0)
{
AtkUtilListenerInfo *listener_info;
listener_info = g_new (AtkUtilListenerInfo, 1);
listener_info->key = listener_idx;
listener_info->hook_id =
- g_signal_add_emission_hook (signal_id, 0, listener,
+ g_signal_add_emission_hook (signal_id, detail_quark, listener,
g_strdup (hook_data),
(GDestroyNotify) g_free);
listener_info->signal_id = signal_id;
{
guint rc = 0;
gchar **split_string;
+ guint length;
- split_string = g_strsplit (event_type, ":", 3);
+ split_string = g_strsplit (event_type, ":", 0);
+ length = g_strv_length (split_string);
- if (g_strv_length (split_string) == 3)
- rc = add_listener (listener, split_string[1], split_string[2], event_type);
+ if ((length == 3) || (length == 4))
+ rc = add_listener (listener, split_string[1], split_string[2],
+ split_string[3], event_type);
g_strfreev (split_string);
* when an ATK event of type event_type occurs.
*
* The format of event_type is the following:
- * "ATK:<atk_type>:<atk_event>
+ * "ATK:<atk_type>:<atk_event>:<atk_event_detail>
*
- * Where "ATK" works as the namespace, <atk_interface> is the name of
- * the ATK type (interface or object) and <atk_event> is the name of
- * the signal defined on that interface.
+ * Where "ATK" works as the namespace, <atk_interface> is the name of
+ * the ATK type (interface or object), <atk_event> is the name of the
+ * signal defined on that interface and <atk_event_detail> is the
+ * gsignal detail of that signal. You can find more info about gsignal
+ * details here:
+ * http://developer.gnome.org/gobject/stable/gobject-Signals.html
+ *
+ * The first three parameters are mandatory. The last one is optional.
*
* For example:
* ATK:AtkObject:state-change
* ATK:AtkText:text-selection-changed
+ * ATK:AtkText:text-insert:system
+ *
+ * Toolkit implementor note: ATK provides a default implementation for
+ * this virtual method. ATK implementors are discouraged from
+ * reimplementing this method.
*
- * Toolkit implementor note: Atk provides a default implementation for
- * this virtual method, and that implementation should be enough for
- * most of the cases. You should have a really good reason to
- * reimplement this method.
+ * Toolkit implementor note: this method is not intended to be used by
+ * ATK implementors but by ATK consumers.
+ *
+ * ATK consumers note: as this method adds a listener for a given ATK
+ * type, that type should be already registered on the GType system
+ * before calling this method. A simple way to do that is creating an
+ * instance of #AtkNoOpObject. This class implements all ATK
+ * interfaces, so creating the instance will register all ATK types as
+ * a collateral effect.
*
* Returns: added event listener id, or 0 on failure.
**/
* @listener_id is the value returned by #atk_add_global_event_listener
* when you registered that event listener.
*
- * Toolkit implementor note: Atk provides a default implementation for
- * this virtual method, and that implementation should be enough for
- * most of the cases. You should have a really good reason to
- * reimplement this method.
+ * Toolkit implementor note: ATK provides a default implementation for
+ * this virtual method. ATK implementors are discouraged from
+ * reimplementing this method.
+ *
+ * Toolkit implementor note: this method is not intended to be used by
+ * ATK implementors but by ATK consumers.
*
* Removes the specified event listener
**/
projects / platform / upstream / atk.git / blobdiff