GTK+ Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# GtkVButtonBox

## Name

GtkVButtonBox -- a container for arranging buttons vertically.

## Synopsis

    #include <gtk/gtk.h>

    struct      GtkVButtonBox;
    GtkWidget*  gtk_vbutton_box_new             (void);
    gint        gtk_vbutton_box_get_spacing_default
                                                (void);
    void        gtk_vbutton_box_set_spacing_default
                                                (gint spacing);
    GtkButtonBoxStyle gtk_vbutton_box_get_layout_default
                                                (void);
    void        gtk_vbutton_box_set_layout_default
                                                (GtkButtonBoxStyle layout);

## Object Hierarchy

      GObject
       +----GtkObject
             +----GtkWidget
                   +----GtkContainer
                         +----GtkBox
                               +----GtkButtonBox
                                     +----GtkVButtonBox

## Description

A button box should be used to provide a consistent layout of buttons throughout your application. There is one default layout and a default spacing value that are persistant across all GtkVButtonBox widgets.

The layout/spacing can then be altered by the programmer, or if desired, by the user to alter the 'feel' of a program to a small degree.

A GtkVButtonBox is created with gtk_vbutton_box_new(). Buttons are packed into a button box the same way as any other box, using gtk_box_pack_start() or gtk_box_pack_end().

The default spacing between buttons can be set with gtk_vbutton_box_set_spacing_default() and queried with gtk_vbutton_box_get_spacing_default().

The arrangement and layout of the buttons can be changed using gtk_vbutton_box_set_layout_default() and queried with gtk_vbutton_box_get_layout_default().

## Details

### struct GtkVButtonBox

    struct GtkVButtonBox;

### gtk_vbutton_box_new ()

    GtkWidget*  gtk_vbutton_box_new             (void);

Creates a new vertical button box.

Returns : | a new button box GtkWidget.

### gtk_vbutton_box_get_spacing_default ()

    gint        gtk_vbutton_box_get_spacing_default
                                                (void);

Warning
`gtk_vbutton_box_get_spacing_default` is deprecated and should not be used in newly-written code.

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.

Returns : | the default number of pixels between buttons.

### gtk_vbutton_box_set_spacing_default ()

    void        gtk_vbutton_box_set_spacing_default
                                                (gint spacing);

Warning
`gtk_vbutton_box_set_spacing_default` is deprecated and should not be used in newly-written code.

Changes the default spacing that is placed between widgets in an vertical button box.

`spacing` : | an integer value.

### gtk_vbutton_box_get_layout_default ()

    GtkButtonBoxStyle gtk_vbutton_box_get_layout_default
                                                (void);

Warning
`gtk_vbutton_box_get_layout_default` is deprecated and should not be used in newly-written code.

Retrieves the current layout used to arrange buttons in button box widgets.

Returns : | the current GtkButtonBoxStyle.

### gtk_vbutton_box_set_layout_default ()

    void        gtk_vbutton_box_set_layout_default
                                                (GtkButtonBoxStyle layout);

Warning
`gtk_vbutton_box_set_layout_default` is deprecated and should not be used in newly-written code.

Sets a new layout mode that will be used by all button boxes.

`layout` : | a new GtkButtonBoxStyle.

## See Also

GtkBox

  Used to pack widgets into button boxes.

GtkButtonBox

  Provides functions for controlling button boxes.

GtkHButtonBox

  Pack buttons horizontally.

<<< Previous Page | Home | Up | Next Page >>>
GtkHButtonBox | GtkFixed