[gtk+] Move documentation from templates to inline comments: GtkAccelGroup
- From: Javier Jardón <jjardon src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gtk+] Move documentation from templates to inline comments: GtkAccelGroup
- Date: Thu, 15 Oct 2009 01:12:23 +0000 (UTC)
commit ff76366652e455d19f9766966a186ff5f396bea2
Author: Javier Jardón <jjardon gnome org>
Date: Wed Oct 14 04:09:48 2009 +0200
Move documentation from templates to inline comments: GtkAccelGroup
https://bugzilla.gnome.org/show_bug.cgi?id=597865
docs/reference/gtk/tmpl/gtkaccelgroup.sgml | 327 ----------------------------
gtk/gtkaccelgroup.c | 25 ++
gtk/gtkaccelgroup.h | 26 +++
3 files changed, 51 insertions(+), 327 deletions(-)
---
diff --git a/gtk/gtkaccelgroup.c b/gtk/gtkaccelgroup.c
index b26fd63..03ade12 100644
--- a/gtk/gtkaccelgroup.c
+++ b/gtk/gtkaccelgroup.c
@@ -37,6 +37,31 @@
#include "gtkmarshalers.h"
#include "gtkalias.h"
+/**
+ * SECTION:gtkaccelgroup
+ * @Short_description: Groups of global keyboard accelerators for an entire GtkWindow
+ * @Title: Accelerator Groups
+ * @See_also:gtk_window_add_accel_group(), gtk_accel_map_change_entry(),
+ * gtk_item_factory_new(), gtk_label_new_with_mnemonic()
+ *
+ * A #GtkAccelGroup represents a group of keyboard accelerators,
+ * typically attached to a toplevel #GtkWindow (with
+ * gtk_window_add_accel_group()). Usually you won't need to create a
+ * #GtkAccelGroup directly; instead, when using #GtkItemFactory, GTK+
+ * automatically sets up the accelerators for your menus in the item
+ * factory's #GtkAccelGroup.
+ *
+ *
+ * Note that <firstterm>accelerators</firstterm> are different from
+ * <firstterm>mnemonics</firstterm>. Accelerators are shortcuts for
+ * activating a menu item; they appear alongside the menu item they're a
+ * shortcut for. For example "Ctrl+Q" might appear alongside the "Quit"
+ * menu item. Mnemonics are shortcuts for GUI elements such as text
+ * entries or buttons; they appear as underlined characters. See
+ * gtk_label_new_with_mnemonic(). Menu items can have both accelerators
+ * and mnemonics, of course.
+ */
+
/* --- prototypes --- */
static void gtk_accel_group_finalize (GObject *object);
diff --git a/gtk/gtkaccelgroup.h b/gtk/gtkaccelgroup.h
index 80780db..b1e8744 100644
--- a/gtk/gtkaccelgroup.h
+++ b/gtk/gtkaccelgroup.h
@@ -66,10 +66,23 @@ typedef gboolean (*GtkAccelGroupActivate) (GtkAccelGroup *accel_group,
guint keyval,
GdkModifierType modifier);
+/**
+ * GtkAccelGroupFindFunc:
+ * @key:
+ * @closure:
+ * @data:
+ *
+ * Since: 2.2
+ */
typedef gboolean (*GtkAccelGroupFindFunc) (GtkAccelKey *key,
GClosure *closure,
gpointer data);
+/**
+ * GtkAccelGroup:
+ *
+ * An object representing and maintaining a group of accelerators.
+ */
struct _GtkAccelGroup
{
GObject parent;
@@ -180,7 +193,20 @@ struct _GtkAccelGroupEntry
#ifndef GTK_DISABLE_DEPRECATED
+/**
+ * gtk_accel_group_ref:
+ *
+ * Deprecated equivalent of g_object_ref().
+ *
+ * Returns: the accel group that was passed in
+ */
#define gtk_accel_group_ref g_object_ref
+
+/**
+ * gtk_accel_group_unref:
+ *
+ * Deprecated equivalent of g_object_unref().
+ */
#define gtk_accel_group_unref g_object_unref
#endif /* GTK_DISABLE_DEPRECATED */
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]