[atk] docs: Improving atk_add_global_event_listener documentation
- From: Alejandro PiÃeiro Iglesias <apinheiro src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [atk] docs: Improving atk_add_global_event_listener documentation
- Date: Mon, 5 Sep 2011 14:35:46 +0000 (UTC)
commit 88da8649920f7c35e1e4dfe104b3a73371bf3729
Author: Alejandro PiÃeiro <apinheiro igalia com>
Date: Mon Sep 5 16:34:27 2011 +0200
docs: Improving atk_add_global_event_listener documentation
Related to bug https://bugzilla.gnome.org/show_bug.cgi?id=649577
atk/atkutil.c | 13 ++++++++++++-
1 files changed, 12 insertions(+), 1 deletions(-)
---
diff --git a/atk/atkutil.c b/atk/atkutil.c
index 5286432..ae28566 100755
--- a/atk/atkutil.c
+++ b/atk/atkutil.c
@@ -210,7 +210,18 @@ atk_focus_tracker_notify (AtkObject *object)
* @event_type: the type of event for which notification is requested
*
* Adds the specified function to the list of functions to be called
- * when an event of type event_type occurs.
+ * when an ATK event of type event_type occurs.
+ *
+ * The format of event_type is the following:
+ * "ATK:<atk_type>:<atk_event>
+ *
+ * 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.
+ *
+ * For example:
+ * ATK:AtkObject:state-change
+ * ATK:AtkText:text-selection-changed
*
* Returns: added event listener id, or 0 on failure.
**/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]