summaryrefslogtreecommitdiff
path: root/gtk
diff options
context:
space:
mode:
authorMatthias Clasen <matthiasc@src.gnome.org>2008-06-13 17:40:17 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2008-06-13 17:40:17 +0000
commitb8edde55e2d4941b2790f592befab97f40e9201e (patch)
treeae53912f3066104d3af42564decdbac6378b3aa4 /gtk
parentd0b1330d9284d8c60c48ef3f16ff2f22e253a75e (diff)
downloadgtk+-b8edde55e2d4941b2790f592befab97f40e9201e.tar.gz
Add some docs
svn path=/trunk/; revision=20381
Diffstat (limited to 'gtk')
-rw-r--r--gtk/gtkaccelgroup.c20
1 files changed, 18 insertions, 2 deletions
diff --git a/gtk/gtkaccelgroup.c b/gtk/gtkaccelgroup.c
index 30b2aa6051..55de4bb296 100644
--- a/gtk/gtkaccelgroup.c
+++ b/gtk/gtkaccelgroup.c
@@ -727,6 +727,22 @@ gtk_accel_group_from_accel_closure (GClosure *closure)
return NULL;
}
+/**
+ * gtk_accel_group_activate:
+ * @accel_group: a #GtkAccelGroup
+ * @accel_quark: the quark for the accelerator name
+ * @acceleratable: the #GObject, usually a #GtkWindow, on which
+ * to activate the accelerator.
+ * @accel_key: accelerator keyval from a key event
+ * @accel_mods: keyboard state mask from a key event
+ * @returns: %TRUE if the accelerator was handled, %FALSE otherwise
+ *
+ * Finds the first accelerator in @accel_group
+ * that matches @accel_key and @accel_mods, and
+ * activates it.
+ *
+ * Returns: %TRUE if an accelerator was activated and handled this keypress
+ */
gboolean
gtk_accel_group_activate (GtkAccelGroup *accel_group,
GQuark accel_quark,
@@ -757,8 +773,8 @@ gtk_accel_group_activate (GtkAccelGroup *accel_group,
* Finds the first accelerator in any #GtkAccelGroup attached
* to @object that matches @accel_key and @accel_mods, and
* activates that accelerator.
- * If an accelerator was activated and handled this keypress, %TRUE
- * is returned.
+ *
+ * Returns: %TRUE if an accelerator was activated and handled this keypress
*/
gboolean
gtk_accel_groups_activate (GObject *object,