The button box widget
=====================
Description
-----------
The button box widget is a container (Note:GtkContainer) derived
from the (Note:GtkBox) widget. It is an abstract base class used by
the horizontal button box (Note:GtkHButtonBox) and the vertical
button box (Note:GtkVButtonBox) widgets to provide a base of common
functionality.
The button box, like the box widget, (Note:GtkBox) provides an
abstraction for organizing position and size of widgets. In the case of
the button box it is targeted at the button widget,(Note:GtkButton).
Button widgets are laid out in the box horizontally or vertically. By
using a button box widget appropriately, a programmer can control how
the button widgets are positioned and how they will be allocated space
when a window gets resized.
Options
-------
- User Option: layout_style
* `GTK_BUTTONBOX_SPREAD'
* The layout style `GTK_BUTTONBOX_SPREAD' will spread the
buttons out evenly within the button box. When the parent
window is resized they will re-adjust to the new window
dimensions. The `gtk_button_box_set_spacing' function will
set the minimum space that the buttons will leave between
themselves.
* `GTK_BUTTONBOX_EDGE'
* * `GTK_BUTTONBOX_START'
* The layout style `GTK_BUTTONBOX_START' will place the buttons
at the start of the button box, taking into account the
spacing as set by the `gtk_button_box_set_spacing' function.
The buttons will not move when the parent window is re-sized.
* `GTK_BUTTONBOX_END'
* The layout style `GTK_BUTTONBOX_END' will place the buttons
at the end of the button box, taking into account the spacing
as set by the `gtk_button_box_set_spacing' function. Again
like the `GTK_BUTTONBOX_START' layout style the buttons will
not move when the parent window is re-sized.
- User Option: width
- User Option: height
- User Option: ipad_x
- User Option: ipad_y
Signals
-------
Functions
---------
- Function: guint gtk_button_box_get_type (void)
Returns the `GtkButtonBox' type identifier.
- Function: void gtk_button_box_set_child_size_default (gint WIDTH,
gintHEIGHT)
- Function: void gtk_button_box_set_child_ipadding_default (gint
IPAD_X, gint IPAD_Y)
- Function: void gtk_button_box_get_child_size_default (gint *WIDTH,
gint *HEIGHT)
- Function: void gtk_button_box_get_child_ipadding_default (gint
*IPAD_X, gint *IPAD_Y)
- Function: void gtk_button_box_set_child_size (GtkButtonBox *WIDGET,
gint WIDTH, gint HEIGHT)
- Function: void gtk_button_box_set_child_ipadding (GtkButtonBox
*WIDGET, gint IPAD_X, gint IPAD_Y)
- Function: void gtk_button_box_set_layout (GtkButtonBox *WIDGET, gint
LAYOUT_STYLE)
This will set the layout style of the buttons within this box.
Currently it can be set to one of `GTK_BUTTONBOX_SPREAD',
`GTK_BUTTONBOX_EDGE', `GTK_BUTTONBOX_START' or `GTK_BUTTONBOX_END'.
The following example:
gtk_button_box_set_layout (GTK_BUTTON_BOX (box),
GTK_BUTTONBOX_SPREAD);
Will set the BOX argument to the "SPREAD" layout style described
above.
- Function: gint gtk_button_box_get_spacing (GtkButtonBox *WIDGET)
Get the per widget value for spacing within the button box. This
value is the amount of space that will be between the individual
buttons contained by this box.
- Function: void gtk_button_box_get_child_size (GtkButtonBox *WIDGET,
gint *WIDTH, gint *HEIGHT)
- Function: void gtk_button_box_get_child_ipadding (GtkButtonBox
*WIDGET, gint *IPAD_X, gint *IPAD_Y)
Get the per widget value for the padding inside the buttons. This
value controls how large the buttons will be within the box.
- Function: gint gtk_button_box_get_layout (GtkButtonBox *WIDGET)
Get the LAYOUT_STYLE for the `GtkButtonBox' object passed to this
function in the WIDGET variable.
layout = gtk_button_box_get_layout(GTK_BUTTON_BOX (box));
- Function: GtkButtonBox* GTK_BUTTON_BOX (gpointer OBJ)
Cast a generic pointer to `GtkButtonBox*'. Note:Standard
Macros, for more info.
- Function: GtkButtonBoxClass* GTK_BUTTON_BOX_CLASS (gpointer CLASS)
Cast a generic pointer to `GtkButtonBoxClass*'. Note:Standard
Macros, for more info.
- Function: gint GTK_IS_BUTTON_BOX (gpointer OBJ)
Determine if a generic pointer refers to a `GtkButtonBox' object.
Note:Standard Macros, for more info.