<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
]>
<!--ENTITY index-Objects-Grouped SYSTEM "objects_grouped.sgml"-->
<refentry id="GtkVButtonBox">
<refmeta>
<refentrytitle role="top_of_page" id="GtkVButtonBox.top_of_page">GtkVButtonBox</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GtkVButtonBox</refname>
<refpurpose>A container for arranging buttons vertically</refpurpose>
</refnamediv>

<refsynopsisdiv id="GtkVButtonBox.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>

#include &lt;gtk/gtk.h&gt;

                    <link linkend="GtkVButtonBox-struct">GtkVButtonBox</link>;
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gtk-vbutton-box-new">gtk_vbutton_box_new</link>                 (void);
<link linkend="gint">gint</link>                <link linkend="gtk-vbutton-box-get-spacing-default">gtk_vbutton_box_get_spacing_default</link> (void);
<link linkend="void">void</link>                <link linkend="gtk-vbutton-box-set-spacing-default">gtk_vbutton_box_set_spacing_default</link> (<link linkend="gint">gint</link> spacing);
<link linkend="GtkButtonBoxStyle">GtkButtonBoxStyle</link>   <link linkend="gtk-vbutton-box-get-layout-default">gtk_vbutton_box_get_layout_default</link>  (void);
<link linkend="void">void</link>                <link linkend="gtk-vbutton-box-set-layout-default">gtk_vbutton_box_set_layout_default</link>  (<link linkend="GtkButtonBoxStyle">GtkButtonBoxStyle</link> layout);
</synopsis>
</refsynopsisdiv>

<refsect1 id="GtkVButtonBox.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkContainer">GtkContainer</link>
                           +----<link linkend="GtkBox">GtkBox</link>
                                 +----<link linkend="GtkButtonBox">GtkButtonBox</link>
                                       +----GtkVButtonBox
</synopsis>
</refsect1>



<refsect1 id="GtkVButtonBox.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GtkVButtonBox implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkBuildable">GtkBuildable</link> and  <link linkend="GtkOrientable">GtkOrientable</link>.</para>
</refsect1>





<refsect1 id="GtkVButtonBox.description" role="desc">
<title role="desc.title">Description</title>
<para>
A button box should be used to provide a consistent layout of buttons
throughout your application. The layout/spacing can be altered by the
programmer, or if desired, by the user to alter the 'feel' of a
program to a small degree.
</para>
<para>
A <link linkend="GtkVButtonBox"><type>GtkVButtonBox</type></link> is created with <link linkend="gtk-vbutton-box-new"><function>gtk_vbutton_box_new()</function></link>. Buttons are
packed into a button box the same way widgets are added to any other
container, using <link linkend="gtk-container-add"><function>gtk_container_add()</function></link>. You can also use
<link linkend="gtk-box-pack-start"><function>gtk_box_pack_start()</function></link> or <link linkend="gtk-box-pack-end"><function>gtk_box_pack_end()</function></link>, but for button boxes both
these functions work just like <link linkend="gtk-container-add"><function>gtk_container_add()</function></link>, ie., they pack the
button in a way that depends on the current layout style and on
whether the button has had <link linkend="gtk-button-box-set-child-secondary"><function>gtk_button_box_set_child_secondary()</function></link> called
on it.
</para>
<para>
The spacing between buttons can be set with <link linkend="gtk-box-set-spacing"><function>gtk_box_set_spacing()</function></link>. The
arrangement and layout of the buttons can be changed with
<link linkend="gtk-button-box-set-layout"><function>gtk_button_box_set_layout()</function></link>.
</para>
</refsect1>

<refsect1 id="GtkVButtonBox.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GtkVButtonBox-struct" role="struct">
<title>GtkVButtonBox</title>
<indexterm zone="GtkVButtonBox-struct"><primary sortas="VButtonBox">GtkVButtonBox</primary></indexterm><programlisting>typedef struct _GtkVButtonBox GtkVButtonBox;</programlisting>
<para>
GtkVButtonBox does not contain any public fields.
</para></refsect2>
<refsect2 id="gtk-vbutton-box-new" role="function">
<title>gtk_vbutton_box_new ()</title>
<indexterm zone="gtk-vbutton-box-new"><primary sortas="vbutton_box_new">gtk_vbutton_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gtk_vbutton_box_new                 (void);</programlisting>
<para>
Creates a new vertical button box.
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>a new button box <link linkend="GtkWidget"><type>GtkWidget</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-vbutton-box-get-spacing-default" role="function" condition="deprecated:">
<title>gtk_vbutton_box_get_spacing_default ()</title>
<indexterm zone="gtk-vbutton-box-get-spacing-default" role="deprecated"><primary sortas="vbutton_box_get_spacing_default">gtk_vbutton_box_get_spacing_default</primary></indexterm><programlisting><link linkend="gint">gint</link>                gtk_vbutton_box_get_spacing_default (void);</programlisting>
<warning><para><literal>gtk_vbutton_box_get_spacing_default</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Retrieves the current default spacing for vertical button boxes. This is the number of pixels
to be placed between the buttons when they are arranged.
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the default number of pixels between buttons.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-vbutton-box-set-spacing-default" role="function" condition="deprecated:">
<title>gtk_vbutton_box_set_spacing_default ()</title>
<indexterm zone="gtk-vbutton-box-set-spacing-default" role="deprecated"><primary sortas="vbutton_box_set_spacing_default">gtk_vbutton_box_set_spacing_default</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_vbutton_box_set_spacing_default (<link linkend="gint">gint</link> spacing);</programlisting>
<warning><para><literal>gtk_vbutton_box_set_spacing_default</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Changes the default spacing that is placed between widgets in an
vertical button box.
</para><variablelist role="params">
<varlistentry><term><parameter>spacing</parameter>&#160;:</term>
<listitem><simpara>an integer value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-vbutton-box-get-layout-default" role="function" condition="deprecated:">
<title>gtk_vbutton_box_get_layout_default ()</title>
<indexterm zone="gtk-vbutton-box-get-layout-default" role="deprecated"><primary sortas="vbutton_box_get_layout_default">gtk_vbutton_box_get_layout_default</primary></indexterm><programlisting><link linkend="GtkButtonBoxStyle">GtkButtonBoxStyle</link>   gtk_vbutton_box_get_layout_default  (void);</programlisting>
<warning><para><literal>gtk_vbutton_box_get_layout_default</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Retrieves the current layout used to arrange buttons in button box widgets.
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the current <link linkend="GtkButtonBoxStyle"><type>GtkButtonBoxStyle</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-vbutton-box-set-layout-default" role="function" condition="deprecated:">
<title>gtk_vbutton_box_set_layout_default ()</title>
<indexterm zone="gtk-vbutton-box-set-layout-default" role="deprecated"><primary sortas="vbutton_box_set_layout_default">gtk_vbutton_box_set_layout_default</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_vbutton_box_set_layout_default  (<link linkend="GtkButtonBoxStyle">GtkButtonBoxStyle</link> layout);</programlisting>
<warning><para><literal>gtk_vbutton_box_set_layout_default</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Sets a new layout mode that will be used by all button boxes.
</para><variablelist role="params">
<varlistentry><term><parameter>layout</parameter>&#160;:</term>
<listitem><simpara>a new <link linkend="GtkButtonBoxStyle"><type>GtkButtonBoxStyle</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>



<refsect1 id="GtkVButtonBox.see-also">
<title>See Also</title>
<para>
<variablelist>
<varlistentry>
<term><link linkend="GtkBox"><type>GtkBox</type></link></term>
<listitem><para>Used to pack widgets into button boxes.</para></listitem>
</varlistentry><varlistentry>
<term><link linkend="GtkButtonBox"><type>GtkButtonBox</type></link></term>
<listitem><para>Provides functions for controlling button boxes.</para></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GtkHButtonBox"><type>GtkHButtonBox</type></link></term>
<listitem><para>Pack buttons horizontally</para></listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>

</refentry>
