4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="St Reference Manual">
8
8
<link rel="up" href="containers.html" title="Containers">
9
9
<link rel="prev" href="containers.html" title="Containers">
10
10
<link rel="next" href="StBoxLayout.html" title="StBoxLayout">
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
45
45
<a name="StBin.synopsis"></a><h2>Synopsis</h2>
46
46
<pre class="synopsis">struct <a class="link" href="StBin.html#StBin-struct" title="struct StBin">StBin</a>;
47
47
struct <a class="link" href="StBin.html#StBinClass" title="struct StBinClass">StBinClass</a>;
48
<span class="returnvalue">void</span> <a class="link" href="StBin.html#st-bin-get-alignment" title="st_bin_get_alignment ()">st_bin_get_alignment</a> (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>,
49
<em class="parameter"><code><span class="type">StAlign</span> *x_align</code></em>,
50
<em class="parameter"><code><span class="type">StAlign</span> *y_align</code></em>);
51
<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="returnvalue">ClutterActor</span></a> * <a class="link" href="StBin.html#st-bin-get-child" title="st_bin_get_child ()">st_bin_get_child</a> (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>);
52
<span class="returnvalue">void</span> <a class="link" href="StBin.html#st-bin-get-fill" title="st_bin_get_fill ()">st_bin_get_fill</a> (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>,
53
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *x_fill</code></em>,
54
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *y_fill</code></em>);
55
48
<a class="link" href="StWidget.html" title="StWidget"><span class="returnvalue">StWidget</span></a> * <a class="link" href="StBin.html#st-bin-new" title="st_bin_new ()">st_bin_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
49
<span class="returnvalue">void</span> <a class="link" href="StBin.html#st-bin-set-child" title="st_bin_set_child ()">st_bin_set_child</a> (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>,
50
<em class="parameter"><code><span class="type">ClutterActor</span> *child</code></em>);
51
<span class="returnvalue">ClutterActor</span> * <a class="link" href="StBin.html#st-bin-get-child" title="st_bin_get_child ()">st_bin_get_child</a> (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>);
56
52
<span class="returnvalue">void</span> <a class="link" href="StBin.html#st-bin-set-alignment" title="st_bin_set_alignment ()">st_bin_set_alignment</a> (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>,
57
53
<em class="parameter"><code><span class="type">StAlign</span> x_align</code></em>,
58
54
<em class="parameter"><code><span class="type">StAlign</span> y_align</code></em>);
59
<span class="returnvalue">void</span> <a class="link" href="StBin.html#st-bin-set-child" title="st_bin_set_child ()">st_bin_set_child</a> (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>,
60
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="type">ClutterActor</span></a> *child</code></em>);
55
<span class="returnvalue">void</span> <a class="link" href="StBin.html#st-bin-get-alignment" title="st_bin_get_alignment ()">st_bin_get_alignment</a> (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>,
56
<em class="parameter"><code><span class="type">StAlign</span> *x_align</code></em>,
57
<em class="parameter"><code><span class="type">StAlign</span> *y_align</code></em>);
61
58
<span class="returnvalue">void</span> <a class="link" href="StBin.html#st-bin-set-fill" title="st_bin_set_fill ()">st_bin_set_fill</a> (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>,
62
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> x_fill</code></em>,
63
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> y_fill</code></em>);
59
<em class="parameter"><code><span class="type">gboolean</span> x_fill</code></em>,
60
<em class="parameter"><code><span class="type">gboolean</span> y_fill</code></em>);
61
<span class="returnvalue">void</span> <a class="link" href="StBin.html#st-bin-get-fill" title="st_bin_get_fill ()">st_bin_get_fill</a> (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>,
62
<em class="parameter"><code><span class="type">gboolean</span> *x_fill</code></em>,
63
<em class="parameter"><code><span class="type">gboolean</span> *y_fill</code></em>);
66
66
<div class="refsect1">
67
67
<a name="StBin.object-hierarchy"></a><h2>Object Hierarchy</h2>
68
68
<pre class="synopsis">
69
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
70
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
71
+----<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html">ClutterActor</a>
70
+----GInitiallyUnowned
72
72
+----<a class="link" href="StWidget.html" title="StWidget">StWidget</a>
74
74
+----<a class="link" href="StButton.html" title="StButton">StButton</a>
79
79
<a name="StBin.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
82
<a href="/usr/share/gtk-doc/html/clutter/ClutterContainer.html">ClutterContainer</a>, <a href="/usr/share/gtk-doc/html/clutter/ClutterScriptable.html">ClutterScriptable</a>, <a href="/usr/share/gtk-doc/html/clutter/ClutterAnimatable.html">ClutterAnimatable</a> and AtkImplementorIface.</p>
82
ClutterContainer, ClutterScriptable, ClutterAnimatable and AtkImplementorIface.</p>
84
84
<div class="refsect1">
85
85
<a name="StBin.properties"></a><h2>Properties</h2>
86
86
<pre class="synopsis">
87
"<a class="link" href="StBin.html#StBin--child" title='The "child" property'>child</a>" <a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="type">ClutterActor</span></a>* : Read / Write
87
"<a class="link" href="StBin.html#StBin--child" title='The "child" property'>child</a>" <span class="type">ClutterActor</span>* : Read / Write
88
88
"<a class="link" href="StBin.html#StBin--x-align" title='The "x-align" property'>x-align</a>" <span class="type">StAlign</span> : Read / Write
89
"<a class="link" href="StBin.html#StBin--x-fill" title='The "x-fill" property'>x-fill</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
89
"<a class="link" href="StBin.html#StBin--x-fill" title='The "x-fill" property'>x-fill</a>" <span class="type">gboolean</span> : Read / Write
90
90
"<a class="link" href="StBin.html#StBin--y-align" title='The "y-align" property'>y-align</a>" <span class="type">StAlign</span> : Read / Write
91
"<a class="link" href="StBin.html#StBin--y-fill" title='The "y-fill" property'>y-fill</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
91
"<a class="link" href="StBin.html#StBin--y-fill" title='The "y-fill" property'>y-fill</a>" <span class="type">gboolean</span> : Read / Write
94
94
<div class="refsect1">
95
95
<a name="StBin.description"></a><h2>Description</h2>
97
97
<a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> is a simple container capable of having only one
98
<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="type">ClutterActor</span></a> as a child.
98
<span class="type">ClutterActor</span> as a child.
101
101
<a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> inherits from <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>, so it is fully themable.
124
124
<div class="refsect2">
125
<a name="st-bin-get-alignment"></a><h3>st_bin_get_alignment ()</h3>
126
<pre class="programlisting"><span class="returnvalue">void</span> st_bin_get_alignment (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>,
127
<em class="parameter"><code><span class="type">StAlign</span> *x_align</code></em>,
128
<em class="parameter"><code><span class="type">StAlign</span> *y_align</code></em>);</pre>
130
Retrieves the horizontal and vertical alignment of the child
131
inside a <a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a>, as set by <a class="link" href="StBin.html#st-bin-set-alignment" title="st_bin_set_alignment ()"><code class="function">st_bin_set_alignment()</code></a>.
133
<div class="variablelist"><table border="0" class="variablelist">
135
<col align="left" valign="top">
140
<td><p><span class="term"><em class="parameter"><code>bin</code></em> :</span></p></td>
141
<td>a <a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a>
145
<td><p><span class="term"><em class="parameter"><code>x_align</code></em> :</span></p></td>
146
<td>return location for the horizontal alignment, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
150
<td><p><span class="term"><em class="parameter"><code>y_align</code></em> :</span></p></td>
151
<td>return location for the vertical alignment, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
158
<div class="refsect2">
159
<a name="st-bin-get-child"></a><h3>st_bin_get_child ()</h3>
160
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="returnvalue">ClutterActor</span></a> * st_bin_get_child (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>);</pre>
162
Retrieves a pointer to the child of <em class="parameter"><code>bin</code></em>.
164
<div class="variablelist"><table border="0" class="variablelist">
166
<col align="left" valign="top">
171
<td><p><span class="term"><em class="parameter"><code>bin</code></em> :</span></p></td>
172
<td>a <a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a>
176
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
177
<td>a <a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="type">ClutterActor</span></a>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
184
<div class="refsect2">
185
<a name="st-bin-get-fill"></a><h3>st_bin_get_fill ()</h3>
186
<pre class="programlisting"><span class="returnvalue">void</span> st_bin_get_fill (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>,
187
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *x_fill</code></em>,
188
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *y_fill</code></em>);</pre>
190
Retrieves the horizontal and vertical fill settings
192
<div class="variablelist"><table border="0" class="variablelist">
194
<col align="left" valign="top">
199
<td><p><span class="term"><em class="parameter"><code>bin</code></em> :</span></p></td>
200
<td>a <a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a>
204
<td><p><span class="term"><em class="parameter"><code>x_fill</code></em> :</span></p></td>
205
<td>return location for the horizontal fill, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
209
<td><p><span class="term"><em class="parameter"><code>y_fill</code></em> :</span></p></td>
210
<td>return location for the vertical fill, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
217
<div class="refsect2">
218
125
<a name="st-bin-new"></a><h3>st_bin_new ()</h3>
219
126
<pre class="programlisting"><a class="link" href="StWidget.html" title="StWidget"><span class="returnvalue">StWidget</span></a> * st_bin_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
235
142
<div class="refsect2">
143
<a name="st-bin-set-child"></a><h3>st_bin_set_child ()</h3>
144
<pre class="programlisting"><span class="returnvalue">void</span> st_bin_set_child (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>,
145
<em class="parameter"><code><span class="type">ClutterActor</span> *child</code></em>);</pre>
147
Sets <em class="parameter"><code>child</code></em> as the child of <em class="parameter"><code>bin</code></em>.
150
If <em class="parameter"><code>bin</code></em> already has a child, the previous child is removed.
152
<div class="variablelist"><table border="0" class="variablelist">
154
<col align="left" valign="top">
159
<td><p><span class="term"><em class="parameter"><code>bin</code></em> :</span></p></td>
160
<td>a <a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a>
164
<td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
165
<td>a <span class="type">ClutterActor</span>, or <a href="/home/florian/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
172
<div class="refsect2">
173
<a name="st-bin-get-child"></a><h3>st_bin_get_child ()</h3>
174
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> * st_bin_get_child (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>);</pre>
176
Retrieves a pointer to the child of <em class="parameter"><code>bin</code></em>.
178
<div class="variablelist"><table border="0" class="variablelist">
180
<col align="left" valign="top">
185
<td><p><span class="term"><em class="parameter"><code>bin</code></em> :</span></p></td>
186
<td>a <a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a>
190
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
191
<td>a <span class="type">ClutterActor</span>, or <a href="/home/florian/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
198
<div class="refsect2">
236
199
<a name="st-bin-set-alignment"></a><h3>st_bin_set_alignment ()</h3>
237
200
<pre class="programlisting"><span class="returnvalue">void</span> st_bin_set_alignment (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>,
238
201
<em class="parameter"><code><span class="type">StAlign</span> x_align</code></em>,
267
230
<div class="refsect2">
268
<a name="st-bin-set-child"></a><h3>st_bin_set_child ()</h3>
269
<pre class="programlisting"><span class="returnvalue">void</span> st_bin_set_child (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>,
270
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="type">ClutterActor</span></a> *child</code></em>);</pre>
272
Sets <em class="parameter"><code>child</code></em> as the child of <em class="parameter"><code>bin</code></em>.
275
If <em class="parameter"><code>bin</code></em> already has a child, the previous child is removed.
231
<a name="st-bin-get-alignment"></a><h3>st_bin_get_alignment ()</h3>
232
<pre class="programlisting"><span class="returnvalue">void</span> st_bin_get_alignment (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>,
233
<em class="parameter"><code><span class="type">StAlign</span> *x_align</code></em>,
234
<em class="parameter"><code><span class="type">StAlign</span> *y_align</code></em>);</pre>
236
Retrieves the horizontal and vertical alignment of the child
237
inside a <a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a>, as set by <a class="link" href="StBin.html#st-bin-set-alignment" title="st_bin_set_alignment ()"><code class="function">st_bin_set_alignment()</code></a>.
277
239
<div class="variablelist"><table border="0" class="variablelist">
289
<td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
290
<td>a <a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="type">ClutterActor</span></a>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
251
<td><p><span class="term"><em class="parameter"><code>x_align</code></em> :</span></p></td>
252
<td>return location for the horizontal alignment, or <a href="/home/florian/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
256
<td><p><span class="term"><em class="parameter"><code>y_align</code></em> :</span></p></td>
257
<td>return location for the vertical alignment, or <a href="/home/florian/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
297
264
<div class="refsect2">
298
265
<a name="st-bin-set-fill"></a><h3>st_bin_set_fill ()</h3>
299
266
<pre class="programlisting"><span class="returnvalue">void</span> st_bin_set_fill (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>,
300
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> x_fill</code></em>,
301
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> y_fill</code></em>);</pre>
267
<em class="parameter"><code><span class="type">gboolean</span> x_fill</code></em>,
268
<em class="parameter"><code><span class="type">gboolean</span> y_fill</code></em>);</pre>
303
270
Sets whether the child of <em class="parameter"><code>bin</code></em> should fill out the horizontal
304
271
and/or vertical allocation of the parent
318
285
<td><p><span class="term"><em class="parameter"><code>x_fill</code></em> :</span></p></td>
320
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the child should fill horizontally the <em class="parameter"><code>bin</code></em>
287
<code class="literal">TRUE</code> if the child should fill horizontally the <em class="parameter"><code>bin</code></em>
324
291
<td><p><span class="term"><em class="parameter"><code>y_fill</code></em> :</span></p></td>
326
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the child should fill vertically the <em class="parameter"><code>bin</code></em>
293
<code class="literal">TRUE</code> if the child should fill vertically the <em class="parameter"><code>bin</code></em>
300
<div class="refsect2">
301
<a name="st-bin-get-fill"></a><h3>st_bin_get_fill ()</h3>
302
<pre class="programlisting"><span class="returnvalue">void</span> st_bin_get_fill (<em class="parameter"><code><a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a> *bin</code></em>,
303
<em class="parameter"><code><span class="type">gboolean</span> *x_fill</code></em>,
304
<em class="parameter"><code><span class="type">gboolean</span> *y_fill</code></em>);</pre>
306
Retrieves the horizontal and vertical fill settings
308
<div class="variablelist"><table border="0" class="variablelist">
310
<col align="left" valign="top">
315
<td><p><span class="term"><em class="parameter"><code>bin</code></em> :</span></p></td>
316
<td>a <a class="link" href="StBin.html" title="StBin"><span class="type">StBin</span></a>
320
<td><p><span class="term"><em class="parameter"><code>x_fill</code></em> :</span></p></td>
321
<td>return location for the horizontal fill, or <a href="/home/florian/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
325
<td><p><span class="term"><em class="parameter"><code>y_fill</code></em> :</span></p></td>
326
<td>return location for the vertical fill, or <a href="/home/florian/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>