File: GtkVBox.html

package info (click to toggle)
gtk%2B3.0 3.22.11-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 182,828 kB
  • ctags: 82,378
  • sloc: ansic: 1,165,043; xml: 9,259; makefile: 6,914; sh: 5,179; python: 402; perl: 370; cpp: 34; sed: 16
file content (176 lines) | stat: -rw-r--r-- 10,429 bytes parent folder | download 
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
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkVBox: GTK+ 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="DeprecatedObjects.html" title="Deprecated">
<link rel="prev" href="GtkHBox.html" title="GtkHBox">
<link rel="next" href="GtkHButtonBox.html" title="GtkHButtonBox">
<meta name="generator" content="GTK-Doc V1.25.1 (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="#GtkVBox.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GtkVBox.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GtkVBox.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="DeprecatedObjects.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkHBox.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkHButtonBox.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkVBox"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkVBox.top_of_page"></a>GtkVBox</span></h2>
<p>GtkVBox — A vertical container box</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkVBox.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_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="GtkVBox.html#gtk-vbox-new" title="gtk_vbox_new ()">gtk_vbox_new</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkVBox.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkVBox.html#GtkVBox-struct" title="struct GtkVBox">GtkVBox</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkVBox.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</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> GtkVBox
</pre>
</div>
<div class="refsect1">
<a name="GtkVBox.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkVBox implements
 AtkImplementorIface,  <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a> and  <a class="link" href="gtk3-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkVBox.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtk/gtk.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GtkVBox.description"></a><h2>Description</h2>
<p>A <a class="link" href="GtkVBox.html" title="GtkVBox"><span class="type">GtkVBox</span></a> is a container that organizes child widgets into a single column.</p>
<p>Use the <a class="link" href="GtkBox.html" title="GtkBox"><span class="type">GtkBox</span></a> packing interface to determine the arrangement,
spacing, height, and alignment of <a class="link" href="GtkVBox.html" title="GtkVBox"><span class="type">GtkVBox</span></a> children.</p>
<p>All children are allocated the same width.</p>
<p>GtkVBox has been deprecated. You can use <a class="link" href="GtkBox.html" title="GtkBox"><span class="type">GtkBox</span></a> instead, which is a
very quick and easy change. If you have derived your own classes from
GtkVBox, you can simply change the inheritance to derive directly
from <a class="link" href="GtkBox.html" title="GtkBox"><span class="type">GtkBox</span></a>, and set the <a class="link" href="gtk3-Orientable.html#GtkOrientable--orientation" title="The “orientation” property"><span class="type">“orientation”</span></a> property to
<a class="link" href="gtk3-Standard-Enumerations.html#GTK-ORIENTATION-VERTICAL:CAPS"><code class="literal">GTK_ORIENTATION_VERTICAL</code></a> in your instance init function, with a
call like:</p>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="function"><a href="gtk3-Orientable.html#gtk-orientable-set-orientation">gtk_orientable_set_orientation</a></span> <span class="gtkdoc opt">(</span><span class="function">GTK_ORIENTABLE</span> <span class="gtkdoc opt">(</span>object<span class="gtkdoc opt">),</span>
                                GTK_ORIENTATION_VERTICAL<span class="gtkdoc opt">);</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p>
If you don’t need first-child or last-child styling and want your code
to be future-proof, the recommendation is to switch to <a class="link" href="GtkGrid.html" title="GtkGrid"><span class="type">GtkGrid</span></a> instead
of nested boxes. For more information about migrating to <a class="link" href="GtkGrid.html" title="GtkGrid"><span class="type">GtkGrid</span></a>,
see <a class="link" href="gtk-migrating-GtkGrid.html" title="Migrating from other containers to GtkGrid">Migrating from other containers to GtkGrid</a>.</p>
</div>
<div class="refsect1">
<a name="GtkVBox.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-vbox-new"></a><h3>gtk_vbox_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
gtk_vbox_new (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> homogeneous</code></em>,
              <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> spacing</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_vbox_new</code> has been deprecated since version 3.2 and should not be used in newly-written code.</p>
<p>You can use <a class="link" href="GtkBox.html#gtk-box-new" title="gtk_box_new ()"><code class="function">gtk_box_new()</code></a> with <a class="link" href="gtk3-Standard-Enumerations.html#GTK-ORIENTATION-VERTICAL:CAPS"><code class="literal">GTK_ORIENTATION_VERTICAL</code></a> instead,
  which is a quick and easy change. But the recommendation is to switch to
  <a class="link" href="GtkGrid.html" title="GtkGrid"><span class="type">GtkGrid</span></a>, since <a class="link" href="GtkBox.html" title="GtkBox"><span class="type">GtkBox</span></a> is going to go away eventually.
  See <a class="link" href="gtk-migrating-GtkGrid.html" title="Migrating from other containers to GtkGrid">Migrating from other containers to GtkGrid</a>.</p>
</div>
<p>Creates a new <a class="link" href="GtkVBox.html" title="GtkVBox"><span class="type">GtkVBox</span></a>.</p>
<div class="refsect3">
<a name="gtk-vbox-new.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>homogeneous</p></td>
<td class="parameter_description"><p><a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if all children are to be given equal space allotments.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>spacing</p></td>
<td class="parameter_description"><p>the number of pixels to place by default between children.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-vbox-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkVBox.html" title="GtkVBox"><span class="type">GtkVBox</span></a>.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GtkVBox.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkVBox-struct"></a><h3>struct GtkVBox</h3>
<pre class="programlisting">struct GtkVBox;</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkVBox.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GtkHBox.html" title="GtkHBox"><span class="type">GtkHBox</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>