summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtkhbbox.sgml
blob: 889f2cf039de253de0d638b36e393f389c6bcd2d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
<!-- ##### SECTION Title ##### -->
GtkHButtonBox

<!-- ##### SECTION Short_Description ##### -->
a container for arranging button horizontally.

<!-- ##### 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 #HButtonBox 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 #HButtonBox is created with gtk_hbutton_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_hbutton_box_set_spacing_default() and queried with
gtk_hbutton_box_get_spacing_default().
</para>
<para>
The arrangement and layout of the buttons can be changed using
gtk_hbutton_box_set_layout_default() and queried with
gtk_hbutton_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>#GtkVButtonBox</term>
<listitem><para>Pack buttons vertically</para></listitem>
</varlistentry>
</variablelist>
</para>

<!-- ##### STRUCT GtkHButtonBox ##### -->
<para>
<structfield>button_box</structfield> is the #GtkHButtonBox widget itself and
should not be modified directly.
</para>


<!-- ##### FUNCTION gtk_hbutton_box_new ##### -->
<para>
Creates a new horizontal button box.
</para>

@Returns: a new button box #GtkWidget.


<!-- ##### FUNCTION gtk_hbutton_box_get_spacing_default ##### -->
<para>
Retrieves the current default spacing for horizontal 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_hbutton_box_get_layout_default ##### -->
<para>
Retrieves the current layout used to arrange buttons in button box widgets.
</para>

@Returns: the current #GtkButtonBoxStyle.


<!-- ##### FUNCTION gtk_hbutton_box_set_spacing_default ##### -->
<para>
Changes the default spacing that is placed between widgets in an
horizontal button box.
</para>

@spacing: an integer value.


<!-- ##### FUNCTION gtk_hbutton_box_set_layout_default ##### -->
<para>
Sets a new layout mode that will be used by all button boxes.
</para>

@layout: a new #GtkButtonBoxStyle.