Commit 8ca73e32 authored by Matthias Clasen's avatar Matthias Clasen

Add docs for GtkStackSwitcher

parent 06f5b1e5
......@@ -234,6 +234,8 @@
<xi:include href="xml/gtkpaned.xml" />
<xi:include href="xml/gtklayout.xml" />
<xi:include href="xml/gtknotebook.xml" />
<xi:include href="xml/gtkstack.xml" />
<xi:include href="xml/gtkstackswitcher.xml" />
<xi:include href="xml/gtkexpander.xml" />
<xi:include href="xml/gtkoverlay.xml" />
<xi:include href="xml/gtkheaderbar.xml" />
......
......@@ -7584,3 +7584,12 @@ GtkStackTransitionType
gtk_stack_set_transition_type
gtk_stack_get_transition_type
</SECTION>
<SECTION>
<FILE>gtkstackswitcher</FILE>
<TITLE>GtkStackSwitcher</TITLE>
GtkStackSwitcher
gtk_stack_switcher_new
gtk_stack_switcher_set_stack
gtk_stack_switcher_get_stack
</SECTION>
......@@ -22,6 +22,25 @@
#include "gtkprivate.h"
#include "gtkintl.h"
/**
* SECTION:gtkstackswitcher
* @Short_decription: A controller for GtkStack
* @Title: GtkStackSwitcher
* @See_also: #GtkStack
*
* The GtkStackSwitcher widget acts as a controller for a
* #GtkStack; it shows a row of buttons to switch between
* the various pages of the associated stack widget.
*
* All the content for the buttons comes from the child properties
* of the #GtkStack.
*
* It is possible to associate multiple #GtkStackSwitcher widgets
* with the same stack widget.
*
* The GtkStackSwitcher widget was added in 3.10.
*/
struct _GtkStackSwitcherPrivate
{
GtkStack *stack;
......@@ -281,6 +300,8 @@ connect_stack_signals (GtkStackSwitcher *switcher)
* @stack: (allow-none): a #GtkStack
*
* Sets the stack to control.
*
* Since: 3.10
*/
void
gtk_stack_switcher_set_stack (GtkStackSwitcher *switcher,
......@@ -320,11 +341,13 @@ gtk_stack_switcher_set_stack (GtkStackSwitcher *switcher,
* gtk_stack_switcher_get_stack:
* @switcher: a #GtkStackSwitcher
*
* Retrieves the stack. See
* gtk_stack_switcher_set_stack().
* Retrieves the stack.
* See gtk_stack_switcher_set_stack().
*
* Return value: (transfer none): the stack, or %NULL if
* none has been set explicitly.
*
* Since: 3.10
*/
GtkStack *
gtk_stack_switcher_get_stack (GtkStackSwitcher *switcher)
......@@ -406,6 +429,15 @@ gtk_stack_switcher_class_init (GtkStackSwitcherClass *class)
g_type_class_add_private (object_class, sizeof (GtkStackSwitcherPrivate));
}
/**
* gtk_stack_switcher_new:
*
* Create a new #GtkStackSwitcher.
*
* Return value: a new #GtkStackSwitcher.
*
* Since: 3.10
*/
GtkWidget *
gtk_stack_switcher_new (void)
{
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment