gtk2/docs/reference/gtk/tmpl/gtkbbox.sgml
Damon Chaplin fc3cd85675 new section from Lee Mallabone.
1999-08-28  Damon Chaplin  <damon@karuna.freeserve.co.uk>

	* gtk/tmpl/gtkbbox.sgml: new section from Lee Mallabone.

	* gdk/gdk-sections.txt: rearranged rgb, regions, and drawing sections.

	* gdk/tmpl/rgb.sgml: new section from Raph Levien, with a few changes
	by me, including a little example app.

	* gdk/tmpl/regions.sgml:
	* gdk/tmpl/event_structs.sgml:
	* gdk/tmpl/drawing.sgml: my first attempt.
	* gdk/tmpl/cursors.sgml: tiny changes.
1999-08-28 20:47:33 +00:00

196 lines
5.8 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
GtkButtonBox
<!-- ##### SECTION Short_Description ##### -->
Base class for #GtkHButtonBox and #GtkVButtonBox
<!-- ##### SECTION Long_Description ##### -->
<para>
The primary purpose of this class is to keep track of the various properties
of #GtkHButtonBox and #GtkVButtonBox widgets.
</para>
<para>
gtk_button_box_get_child_size_default() retrieves the default minimum width and height
for widgets in any button box. gtk_button_box_set_child_size_default()
changes the default minimum child widget size.
</para>
<para>
gtk_button_box_get_child_size() retrieves the minimum width and height
for widgets in a given button box. gtk_button_box_set_child_size()
allows those properties to be changed.
</para>
<para>
gtk_button_box_get_child_ipadding_default() gets the default number of pixels of
horizontal and vertical padding that are applied to each button in every button box.
gtk_button_box_set_child_ipadding_default() allows these defaults to be
changed.
</para>
<para>
The internal padding of buttons can be retrieved and changed per button box using
gtk_button_box_get_child_ipadding() and gtk_button_box_set_child_ipadding()
respectively.
</para>
<para>
gtk_button_box_get_spacing() and gtk_button_box_set_spacing() retrieve and
change default number of pixels between buttons, respectively.
</para>
<para>
gtk_button_box_get_layout() and gtk_button_box_set_layout() retrieve and alter the method
used to spread the buttons in a button box across the container, respectively.
</para>
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkVButtonBox</term>
<listitem><para>Vertical sub-class of #GtkButtonBox.</para></listitem>
</varlistentry>
<varlistentry>
<term>#GtkHButtonBox</term>
<listitem><para>Horizontal sub-class of #GtkButtonBox.</para></listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### STRUCT GtkButtonBox ##### -->
<para>
This is a read-only struct; no members should be modified directly.
</para>
<!-- ##### MACRO GTK_BUTTONBOX_DEFAULT ##### -->
<para>
Used internally only.
</para>
<!-- ##### FUNCTION gtk_button_box_get_child_size_default ##### -->
<para>
Retrieves the default minimum width and height for all button boxes, and
places the values in @min_width and @min_height, respectively.
</para>
@min_width: the default minimum width of a child widget.
@min_height: the default minimum height of a child widget.
<!-- ##### FUNCTION gtk_button_box_get_child_ipadding_default ##### -->
<para>
The internal padding of a button is the amount of space between the outside
of the button and the widget it contains. This function gets the default
amount of horizontal and vertical padding, placing the results in @ipad_x
and @ipad_y, respectively.
</para>
@ipad_x: the default horizontal internal button padding.
@ipad_y: the default vertical internal button padding.
<!-- ##### FUNCTION gtk_button_box_set_child_size_default ##### -->
<para>
Sets the default size of child buttons.
</para>
@min_width: minimum default width for child buttons.
@min_height: minimum default height for child buttons.
<!-- ##### FUNCTION gtk_button_box_set_child_ipadding_default ##### -->
<para>
Sets the default number of pixels that pad each button in every button box.
</para>
@ipad_x: new default horizontal padding.
@ipad_y: new default vertical padding.
<!-- ##### FUNCTION gtk_button_box_get_spacing ##### -->
<para>
Retrieves how much space a button box is placing between each child button.
</para>
@widget: a #GtkButtonBox.
@Returns: the current spacing applied to the buttons in @widget.
<!-- ##### FUNCTION gtk_button_box_get_layout ##### -->
<para>
Retrieves the method being used to arrange the buttons in a button box.
</para>
@widget: a #GtkButtonBox.
@Returns: the method used to layout buttons in @widget.
<!-- ##### FUNCTION gtk_button_box_get_child_size ##### -->
<para>
Retrieves the current width and height of all child widgets in a button box.
@min_width and @min_height are filled with those values, respectively.
</para>
@widget: a #GtkButtonBox.
@min_width: the width of the buttons contained by @widget.
@min_height: the height of the buttons contained by @widget.
<!-- ##### FUNCTION gtk_button_box_get_child_ipadding ##### -->
<para>
Gets the default number of pixels that pad the buttons in a given button box.
</para>
@widget: a #GtkButtonBox.
@ipad_x: the horizontal padding used by buttons in @widget.
@ipad_y: the vertical padding used by buttons in @widget.
<!-- ##### FUNCTION gtk_button_box_set_spacing ##### -->
<para>
Sets the amount of spacing between buttons in a given button box.
</para>
@widget: a #GtkButtonBox.
@spacing: the number of pixels of spacing.
<!-- ##### FUNCTION gtk_button_box_set_layout ##### -->
<para>
Changes the way buttons are arranged in their container.
</para>
@widget: a #GtkButtonBox.
@layout_style: the new layout style.
<!-- ##### FUNCTION gtk_button_box_set_child_size ##### -->
<para>
Sets a new default size for the children of a given button box.
</para>
@widget: a #GtkButtonBox.
@min_width: a default width for buttons in @widget.
@min_height: a default height for buttons in @widget.
<!-- ##### FUNCTION gtk_button_box_set_child_ipadding ##### -->
<para>
Changes the amount of internal padding used by all buttons in a given button
box.
</para>
@widget: a #GtkButtonBox.
@ipad_x: the horizontal padding that should be used by each button in @widget.
@ipad_y: the vertical padding that should be used by each button in @widget.
<!-- ##### FUNCTION gtk_button_box_child_requisition ##### -->
<para>
This is an internally used function and should never be called from an
application.
</para>