[gtk+/wip/action-helper] gtkwidget: add documentation for new action group functions



commit 6b4df1b98057615ef2332a58f55ecfc76d6b334f
Author: Lars Uebernickel <lars uebernickel canonical com>
Date:   Fri Aug 10 16:58:42 2012 +0200

    gtkwidget: add documentation for new action group functions

 gtk/gtkwidget.c |   27 +++++++++++++++++++++++++++
 1 files changed, 27 insertions(+), 0 deletions(-)
---
diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c
index 2355c44..ff023aa 100644
--- a/gtk/gtkwidget.c
+++ b/gtk/gtkwidget.c
@@ -14108,6 +14108,18 @@ _gtk_widget_get_action_muxer (GtkWidget *widget)
   return widget->priv->muxer;
 }
 
+/**
+ * gtk_widget_insert_action_group:
+ * @widget: a #GtkWidget
+ * @name: the prefix for actions in @group
+ * @group: a #GActionGroup
+ *
+ * Inserts @group into @widget. Children of @widget that implement
+ * #GtkActionable can then be associated with actions in @group by
+ * setting their 'action-name' to @prefix.<action-name>.
+ *
+ * Since: 3.6
+ */
 void
 gtk_widget_insert_action_group (GtkWidget    *widget,
                                 const gchar  *name,
@@ -14123,6 +14135,21 @@ gtk_widget_insert_action_group (GtkWidget    *widget,
   g_action_muxer_insert (muxer, name, group);
 }
 
+/**
+ * gtk_widget_get_action_context:
+ * @widget: a #GtkWidget
+ *
+ * Gets a #GActionGroup that contains actions from all parent containers
+ * of @widget.
+ *
+ * Typically, it will contain the actions associated with @widget's
+ * toplevel #GtkApplicationWindow (prefixed "win.") and #GtkApplication
+ * (prefixed "app.").
+ *
+ * Returns: (transfer-none): a #GActionGroup
+ *
+ * Since: 3.6
+ */
 GActionGroup *
 gtk_widget_get_action_context (GtkWidget *widget)
 {



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]