GtkApplicationMenuButton: add docs

This commit is contained in:
Matthias Clasen 2011-12-01 08:33:08 -05:00 committed by Ryan Lortie
parent bd30a1c556
commit b893247eeb

View File

@ -29,6 +29,26 @@
#include <string.h> #include <string.h>
/**
* SECTION:gtkapplicationmenubutton
* @title: GtkApplicationMenuButton
* @short_description: A button that shows the application menu
*
* A GtkApplicationMenuButton can be added to a #GtkApplicationWindow
* as an alternative way to present the application menu, if it is
* not shown by the desktop environment. GtkApplicationMenuButton
* automatically hides itself, and only appears when necessary. It
* is derived from #GtkButton, and you should use regular #GtkButton
* API to add a suitable icon or label. Note that #GtkApplicationWindow
* already provides a way to present the application menu, so a
* #GtkApplicationMenuButton is only needed if the default
* appearance (as part of a menubar) is not suitable.
*
* To configure the contents of the application menu, use
* g_application_set_menu() and g_application_set_action_group() on
* the #GtkApplication associated with the #GtkApplicationWindow.
*/
struct _GtkApplicationMenuButton struct _GtkApplicationMenuButton
{ {
GtkButton parent_instance; GtkButton parent_instance;
@ -202,6 +222,15 @@ gtk_application_menu_button_class_init (GtkApplicationMenuButtonClass *class)
object_class->finalize = gtk_application_menu_button_finalize; object_class->finalize = gtk_application_menu_button_finalize;
} }
/**
* gtk_application_menu_button_new:
*
* Creates a new #GtkApplicationMenuButton.
*
* Returns: a newly created #GtkApplicationMenuButton
*
* Since: 3.4
*/
GtkWidget * GtkWidget *
gtk_application_menu_button_new (void) gtk_application_menu_button_new (void)
{ {