Add example to docs for using GActionEntry
authorRyan Lortie <desrt@desrt.ca>
Wed, 29 Jun 2011 12:55:59 +0000 (13:55 +0100)
committerJavier Jardon <jjardon@gnome.org>
Wed, 29 Jun 2011 15:20:52 +0000 (16:20 +0100)
gio/gsimpleactiongroup.c

index 14c9714d2a1e57ed2f2602ea4217f3e20c9ade76..b35982debc23d25bbeac2a24beb666200ea3cc4d 100644 (file)
@@ -402,6 +402,8 @@ g_simple_action_group_remove (GSimpleActionGroup *simple,
  * in order to leave some of the later values as %NULL.  All values
  * after @name are optional.  Additional optional fields may be added in
  * the future.
+ *
+ * See g_simple_action_group_add_entries() for an example.
  **/
 
 /**
@@ -417,6 +419,42 @@ g_simple_action_group_remove (GSimpleActionGroup *simple,
  *
  * Each action is constructed as per one #GActionEntry.
  *
+ * <example>
+ * <title>Using g_simple_action_group_add_entries()</title>
+ * <programlisting>
+ * static void
+ * activate_quit (GSimpleAction *simple,
+ *                GVariant      *parameter,
+ *                gpointer       user_data)
+ * {
+ *   exit (0);
+ * }
+ *
+ * static void
+ * activate_print_string (GSimpleAction *simple,
+ *                        GVariant      *parameter,
+ *                        gpointer       user_data)
+ * {
+ *   g_print ("%s\n", g_variant_get_string (parameter, NULL));
+ * }
+ *
+ * static GActionGroup *
+ * create_action_group (void)
+ * {
+ *   const GActionEntry entries[] = {
+ *     { "quit",         activate_quit              },
+ *     { "print-string", activate_print_string, "s" }
+ *   };
+ *   GSimpleActionGroup *group;
+ *
+ *   group = g_simple_action_group_new ();
+ *   g_simple_action_group_add_entries (group, entries, G_N_ELEMENTS (entries), NULL);
+ *
+ *   return G_ACTION_GROUP (group);
+ * }
+ * </programlisting>
+ * </example>
+ *
  * Since: 2.30
  **/
 void