diff options
author | Alejandro Piñeiro <apinheiro@igalia.com> | 2014-05-12 15:00:06 +0200 |
---|---|---|
committer | Alejandro Piñeiro <apinheiro@igalia.com> | 2014-05-12 15:00:06 +0200 |
commit | 17a06d4871a3dc23b698bfa15586d02b98a71c32 (patch) | |
tree | 18f78b66d55a63672afa747a6e6dd2d770c0aaa4 /atk | |
parent | 7a46a450bfe9f8aae82b7c10e25ae13bd5cb3a9a (diff) | |
download | atk-17a06d4871a3dc23b698bfa15586d02b98a71c32.tar.gz |
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
Diffstat (limited to 'atk')
-rwxr-xr-x | atk/atkutil.c | 7 |
1 files changed, 7 insertions, 0 deletions
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 |