From: Alejandro Piñeiro <apinheiro@igalia.com>
Date: Mon, 12 May 2014 13:00:06 +0000 (+0200)
Subject: doc: adding further explanation on atk_add_global_event_listener
X-Git-Tag: ATK_2_13_2~10
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=17a06d4871a3dc23b698bfa15586d02b98a71c32;p=platform%2Fupstream%2Fatk.git

doc: adding further explanation on atk_add_global_event_listener

Clarifying that the atk types should be already registered
before calling this method.

https://bugzilla.gnome.org/show_bug.cgi?id=729922
---

diff --git a/atk/atkutil.c b/atk/atkutil.c
index e9726e7..bc4c0a6 100755
--- a/atk/atkutil.c
+++ b/atk/atkutil.c
@@ -377,6 +377,13 @@ atk_util_real_remove_global_event_listener (guint remove_listener)
  * 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.
  **/
 guint