gtk2/docs/reference/gtk/tmpl/gtkvbbox.sgml
Damon Chaplin 3a202479a8 fixed minor error - using <em>.
1999-11-16  Damon Chaplin  <damon@karuna.freeserve.co.uk>

	* gtk/tmpl/gtkmenubar.sgml: fixed minor error - using <em>.

	* gtk/tmpl/gtknotebook.sgml:
	* gtk/tmpl/gtklist.sgml: new sections from
	Nicolas George <george@clipper.ens.fr>, with help from
	"Bob Springett"	<bobspringett@claranet.fr>.

	* gtk/tmpl/gtkobject.sgml:
	* gtk/tmpl/gtkarg.sgml: new sections from
	David Benson <daveb@idealab.com>.

	* gtk/tmpl/gtkvbox.sgml:
	* gtk/tmpl/gtkhbox.sgml: fixed line endings.

	* gtk/tmpl/gtkvbbox.sgml: update from Lee Mallabone
	<lee0@callnetuk.com>

	* gdk/tmpl/drawing.sgml: fixed error in gdk_draw_arc() @angle2 param
	- it is relative to @angle1 rather than from the 3 o'clock position.

	* gtk/tmpl/gtkfontseldlg.sgml: changed enums to use @ fields.

	* gtk/tmpl/gtkcolorsel.sgml:
	* gtk/tmpl/gtkcolorseldlg.sgml:
	* gtk/tmpl/gtkprogress.sgml:
	* gtk/tmpl/gtkprogressbar.sgml: new sections from Tom Martone
	<tom@martoneconsulting.com>

	* gtk/tmpl/gtkclist.sgml: partially written documentation from
	Paul Schifferer <isengard@geocities.com> who won't be able to finish it
1999-11-16 00:33:10 +00:00

97 lines
2.6 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
GtkVButtonBox
<!-- ##### SECTION Short_Description ##### -->
a container for arranging buttons vertically.
<!-- ##### SECTION Long_Description ##### -->
<para>
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 #VButtonBox widgets.
</para>
<para>
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.
</para>
<para>
A #VButtonBox 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().
</para>
<para>
The default spacing between buttons can be set with
gtk_vbutton_box_set_spacing_default() and queried with
gtk_vbutton_box_get_spacing_default().
</para>
<para>
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().
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkBox</term>
<listitem><para>Used to pack widgets into button boxes.</para></listitem>
</varlistentry><varlistentry>
<term>#GtkButtonBox</term>
<listitem><para>Provides functions for controlling button boxes.</para></listitem>
</varlistentry>
<varlistentry>
<term>#GtkHButtonBox</term>
<listitem><para>Pack buttons horizontally.</para></listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### STRUCT GtkVButtonBox ##### -->
<para>
</para>
@button_box: the #GtkButtonBox that this class is derived from.
<!-- ##### FUNCTION gtk_vbutton_box_new ##### -->
<para>
Creates a new vertical button box.
</para>
@Returns: a new button box #GtkWidget.
<!-- ##### FUNCTION gtk_vbutton_box_get_spacing_default ##### -->
<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>
@Returns: the default number of pixels between buttons.
<!-- ##### FUNCTION gtk_vbutton_box_set_spacing_default ##### -->
<para>
Changes the default spacing that is placed between widgets in an
vertical button box.
</para>
@spacing: an integer value.
<!-- ##### FUNCTION gtk_vbutton_box_get_layout_default ##### -->
<para>
Retrieves the current layout used to arrange buttons in button box widgets.
</para>
@Returns: the current #GtkButtonBoxStyle.
<!-- ##### FUNCTION gtk_vbutton_box_set_layout_default ##### -->
<para>
Sets a new layout mode that will be used by all button boxes.
</para>
@layout: a new #GtkButtonBoxStyle.