File: GtkVButtonBox.html

package info (click to toggle)
gtk%2B2.0 2.24.33-7
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie, trixie-proposed-updates, trixie-updates
  • size: 124,860 kB
  • sloc: ansic: 574,091; makefile: 5,171; sh: 4,618; xml: 1,193; python: 1,117; perl: 749; awk: 49; cpp: 34
file content (253 lines) | stat: -rw-r--r-- 14,773 bytes parent folder | download | duplicates (3)
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkVButtonBox: GTK+ 2 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
<link rel="up" href="LayoutContainers.html" title="Layout Containers">
<link rel="prev" href="GtkHButtonBox.html" title="GtkHButtonBox">
<link rel="next" href="GtkFixed.html" title="GtkFixed">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GtkVButtonBox.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GtkVButtonBox.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GtkVButtonBox.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="LayoutContainers.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkHButtonBox.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkFixed.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkVButtonBox"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkVButtonBox.top_of_page"></a>GtkVButtonBox</span></h2>
<p>GtkVButtonBox — A container for arranging buttons vertically</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkVButtonBox.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkVButtonBox.html#gtk-vbutton-box-new" title="gtk_vbutton_box_new ()">gtk_vbutton_box_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="GtkVButtonBox.html#gtk-vbutton-box-get-spacing-default" title="gtk_vbutton_box_get_spacing_default ()">gtk_vbutton_box_get_spacing_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkVButtonBox.html#gtk-vbutton-box-set-spacing-default" title="gtk_vbutton_box_set_spacing_default ()">gtk_vbutton_box_set_spacing_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gtk2-Standard-Enumerations.html#GtkButtonBoxStyle" title="enum GtkButtonBoxStyle"><span class="returnvalue">GtkButtonBoxStyle</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkVButtonBox.html#gtk-vbutton-box-get-layout-default" title="gtk_vbutton_box_get_layout_default ()">gtk_vbutton_box_get_layout_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkVButtonBox.html#gtk-vbutton-box-set-layout-default" title="gtk_vbutton_box_set_layout_default ()">gtk_vbutton_box_set_layout_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkVButtonBox.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkVButtonBox.html#GtkVButtonBox-struct" title="struct GtkVButtonBox">GtkVButtonBox</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkVButtonBox.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GInitiallyUnowned
        <span class="lineart">╰──</span> <a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
            <span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
                <span class="lineart">╰──</span> <a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
                    <span class="lineart">╰──</span> <a class="link" href="GtkBox.html" title="GtkBox">GtkBox</a>
                        <span class="lineart">╰──</span> <a class="link" href="GtkButtonBox.html" title="GtkButtonBox">GtkButtonBox</a>
                            <span class="lineart">╰──</span> GtkVButtonBox
</pre>
</div>
<div class="refsect1">
<a name="GtkVButtonBox.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkVButtonBox implements
 AtkImplementorIface,  <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a> and  <a class="link" href="gtk2-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkVButtonBox.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtk/gtk.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GtkVButtonBox.description"></a><h2>Description</h2>
<p>A button box should be used to provide a consistent layout of buttons
throughout your application. The layout/spacing can be altered by the
programmer, or if desired, by the user to alter the 'feel' of a
program to a small degree.</p>
<p>A <a class="link" href="GtkVButtonBox.html" title="GtkVButtonBox"><span class="type">GtkVButtonBox</span></a> is created with <a class="link" href="GtkVButtonBox.html#gtk-vbutton-box-new" title="gtk_vbutton_box_new ()"><code class="function">gtk_vbutton_box_new()</code></a>. Buttons are
packed into a button box the same way widgets are added to any other
container, using <a class="link" href="GtkContainer.html#gtk-container-add" title="gtk_container_add ()"><code class="function">gtk_container_add()</code></a>. You can also use
<a class="link" href="GtkBox.html#gtk-box-pack-start" title="gtk_box_pack_start ()"><code class="function">gtk_box_pack_start()</code></a> or <a class="link" href="GtkBox.html#gtk-box-pack-end" title="gtk_box_pack_end ()"><code class="function">gtk_box_pack_end()</code></a>, but for button boxes both
these functions work just like <a class="link" href="GtkContainer.html#gtk-container-add" title="gtk_container_add ()"><code class="function">gtk_container_add()</code></a>, ie., they pack the
button in a way that depends on the current layout style and on
whether the button has had <a class="link" href="GtkButtonBox.html#gtk-button-box-set-child-secondary" title="gtk_button_box_set_child_secondary ()"><code class="function">gtk_button_box_set_child_secondary()</code></a> called
on it.</p>
<p>The spacing between buttons can be set with <a class="link" href="GtkBox.html#gtk-box-set-spacing" title="gtk_box_set_spacing ()"><code class="function">gtk_box_set_spacing()</code></a>. The
arrangement and layout of the buttons can be changed with
<a class="link" href="GtkButtonBox.html#gtk-button-box-set-layout" title="gtk_button_box_set_layout ()"><code class="function">gtk_button_box_set_layout()</code></a>.</p>
</div>
<div class="refsect1">
<a name="GtkVButtonBox.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-vbutton-box-new"></a><h3>gtk_vbutton_box_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
gtk_vbutton_box_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new vertical button box.</p>
<div class="refsect3">
<a name="gtk-vbutton-box-new.returns"></a><h4>Returns</h4>
<p> a new button box <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-vbutton-box-get-spacing-default"></a><h3>gtk_vbutton_box_get_spacing_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
gtk_vbutton_box_get_spacing_default (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_vbutton_box_get_spacing_default</code> has been deprecated since version 2.0 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="GtkBox.html#gtk-box-get-spacing" title="gtk_box_get_spacing ()"><code class="function">gtk_box_get_spacing()</code></a> instead.</p>
</div>
<p>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.</p>
<div class="refsect3">
<a name="gtk-vbutton-box-get-spacing-default.returns"></a><h4>Returns</h4>
<p> the default number of pixels between buttons.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-vbutton-box-set-spacing-default"></a><h3>gtk_vbutton_box_set_spacing_default ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_vbutton_box_set_spacing_default (<em class="parameter"><code><span class="type">gint</span> spacing</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_vbutton_box_set_spacing_default</code> has been deprecated since version 2.0 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="GtkBox.html#gtk-box-set-spacing" title="gtk_box_set_spacing ()"><code class="function">gtk_box_set_spacing()</code></a> instead.</p>
</div>
<p>Changes the default spacing that is placed between widgets in an
vertical button box.</p>
<div class="refsect3">
<a name="gtk-vbutton-box-set-spacing-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>spacing</p></td>
<td class="parameter_description"><p>an integer value.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-vbutton-box-get-layout-default"></a><h3>gtk_vbutton_box_get_layout_default ()</h3>
<pre class="programlisting"><a class="link" href="gtk2-Standard-Enumerations.html#GtkButtonBoxStyle" title="enum GtkButtonBoxStyle"><span class="returnvalue">GtkButtonBoxStyle</span></a>
gtk_vbutton_box_get_layout_default (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_vbutton_box_get_layout_default</code> has been deprecated since version 2.0 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="GtkButtonBox.html#gtk-button-box-get-layout" title="gtk_button_box_get_layout ()"><code class="function">gtk_button_box_get_layout()</code></a> instead.</p>
</div>
<p>Retrieves the current layout used to arrange buttons in button box widgets.</p>
<div class="refsect3">
<a name="gtk-vbutton-box-get-layout-default.returns"></a><h4>Returns</h4>
<p> the current <a class="link" href="gtk2-Standard-Enumerations.html#GtkButtonBoxStyle" title="enum GtkButtonBoxStyle"><span class="type">GtkButtonBoxStyle</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-vbutton-box-set-layout-default"></a><h3>gtk_vbutton_box_set_layout_default ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_vbutton_box_set_layout_default (<em class="parameter"><code><a class="link" href="gtk2-Standard-Enumerations.html#GtkButtonBoxStyle" title="enum GtkButtonBoxStyle"><span class="type">GtkButtonBoxStyle</span></a> layout</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_vbutton_box_set_layout_default</code> has been deprecated since version 2.0 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="GtkButtonBox.html#gtk-button-box-set-layout" title="gtk_button_box_set_layout ()"><code class="function">gtk_button_box_set_layout()</code></a> instead.</p>
</div>
<p>Sets a new layout mode that will be used by all button boxes.</p>
<div class="refsect3">
<a name="gtk-vbutton-box-set-layout-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a new <a class="link" href="gtk2-Standard-Enumerations.html#GtkButtonBoxStyle" title="enum GtkButtonBoxStyle"><span class="type">GtkButtonBoxStyle</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GtkVButtonBox.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkVButtonBox-struct"></a><h3>struct GtkVButtonBox</h3>
<pre class="programlisting">struct GtkVButtonBox;</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkVButtonBox.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GtkBox.html" title="GtkBox"><span class="type">GtkBox</span></a>, <a class="link" href="GtkButtonBox.html" title="GtkButtonBox"><span class="type">GtkButtonBox</span></a>, <a class="link" href="GtkHButtonBox.html" title="GtkHButtonBox"><span class="type">GtkHButtonBox</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>