From 9d85d87f0561ce2af3c72d7b9bb787b958a97e30 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Thu, 13 Jan 2011 22:11:22 -0500 Subject: [PATCH] Move GtkMenuBar docs inline And remove some outdated content. --- docs/reference/gtk/tmpl/.gitignore | 1 + docs/reference/gtk/tmpl/gtkmenubar.sgml | 104 ------------------------ gtk/gtkenums.h | 10 +++ gtk/gtkmenubar.c | 18 ++++ 4 files changed, 29 insertions(+), 104 deletions(-) delete mode 100644 docs/reference/gtk/tmpl/gtkmenubar.sgml diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index 1249f4db13..ebc9d6b070 100644 --- a/docs/reference/gtk/tmpl/.gitignore +++ b/docs/reference/gtk/tmpl/.gitignore @@ -34,6 +34,7 @@ gtkitemfactory.sgml gtklayout.sgml gtklinkbutton.sgml gtkmain.sgml +gtkmenubar.sgml gtkmessagedialog.sgml gtknotebook.sgml gtkobject.sgml diff --git a/docs/reference/gtk/tmpl/gtkmenubar.sgml b/docs/reference/gtk/tmpl/gtkmenubar.sgml deleted file mode 100644 index 89504630b8..0000000000 --- a/docs/reference/gtk/tmpl/gtkmenubar.sgml +++ /dev/null @@ -1,104 +0,0 @@ - -GtkMenuBar - - -A subclass widget for GtkMenuShell which holds GtkMenuItem widgets - - - -The #GtkMenuBar is a subclass of #GtkMenuShell which contains one to many #GtkMenuItem. The result is a standard menu bar which can hold many menu items. #GtkMenuBar allows for a shadow type to be set for aesthetic purposes. The shadow types are defined in the #gtk_menu_bar_set_shadow_type function. - - - - -#GtkMenuShell, #GtkMenu, #GtkMenuItem - - - - - - - - - - -The #GtkMenuBar struct contains the following fields. (These fields should be considered read-only. They should never be set by an application.) - - - - - - - - - - - - - - - - - - - - - - - - - -Creates the new #GtkMenuBar - - -@void: -@Returns: the #GtkMenuBar - - - - -Determines how widgets should be packed insided menubars and -menuitems contained in menubars. - - -@GTK_PACK_DIRECTION_LTR: Widgets are packed left-to-right. -@GTK_PACK_DIRECTION_RTL: Widgets are packed right-to-left. -@GTK_PACK_DIRECTION_TTB: Widgets are packed top-to-bottom. -@GTK_PACK_DIRECTION_BTT: Widgets are packed bottom-to-top. - - - - - - -@menubar: -@pack_dir: - - - - - - - -@menubar: -@Returns: - - - - - - - -@menubar: -@child_pack_dir: - - - - - - - -@menubar: -@Returns: - - diff --git a/gtk/gtkenums.h b/gtk/gtkenums.h index d146359c97..76ea88578f 100644 --- a/gtk/gtkenums.h +++ b/gtk/gtkenums.h @@ -648,6 +648,16 @@ typedef enum GTK_IM_STATUS_NONE } GtkIMStatusStyle; +/** + * GtkPackDirection: + * @GTK_PACK_DIRECTION_LTR: Widgets are packed left-to-right + * @GTK_PACK_DIRECTION_RTL: Widgets are packed right-to-left + * @GTK_PACK_DIRECTION_TTB: Widgets are packed top-to-bottom + * @GTK_PACK_DIRECTION_BTT: Widgets are packed bottom-to-top + * + * Determines how widgets should be packed insided menubars + * and menuitems contained in menubars. + */ typedef enum { GTK_PACK_DIRECTION_LTR, diff --git a/gtk/gtkmenubar.c b/gtk/gtkmenubar.c index 42f2f25819..b35ec0ca89 100644 --- a/gtk/gtkmenubar.c +++ b/gtk/gtkmenubar.c @@ -24,6 +24,17 @@ * GTK+ at ftp://ftp.gtk.org/pub/gtk/. */ +/** + * SECTION:gtkmenubar + * @Title: GtkMenuBar + * @Short_description: A subclass of GtkMenuShell which holds GtkMenuItem widgets + * @See_also: #GtkMenuShell, #GtkMenu, #GtkMenuItem + * + * The #GtkMenuBar is a subclass of #GtkMenuShell which contains one or + * more #GtkMenuItems. The result is a standard menu bar which can hold + * many menu items. + */ + #include "config.h" #include "gtkmenubar.h" @@ -224,6 +235,13 @@ gtk_menu_bar_init (GtkMenuBar *menu_bar) gtk_style_context_add_class (context, GTK_STYLE_CLASS_MENUBAR); } +/** + * gtk_menu_bar_new: + * + * Creates a new #GtkMenuBar + * + * Returns: the new menu bar, as a #GtkWidget + */ GtkWidget* gtk_menu_bar_new (void) {