~ubuntu-branches/ubuntu/quantal/gnome-shell/quantal-updates

« back to all changes in this revision

Viewing changes to docs/reference/st/html/StBoxLayout.html

  • Committer: Package Import Robot
  • Author(s): Tim Lunn
  • Date: 2013-02-26 23:50:34 UTC
  • mfrom: (1.1.48)
  • Revision ID: package-import@ubuntu.com-20130226235034-44tf447o9ney780a
Tags: 3.6.3.1-0ubuntu0.1
* New upstream release. (LP: #1128804)
  - Fixes disappearing messagetray (LP: #1067265)
  - recorder: Set frame duration to fix broken video headers
  - Block cancellation of unlock dialog during drags
  - Honor lock-delay GSettings key
* debian/patches/git_remove_messagetray_barrier.patch:
  - Remove barrier at the bottom of the screen (causes problems
    when moving the cursor between multiple screens) (LP: #1132308)

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="containers.html" title="Containers">
9
9
<link rel="prev" href="StBin.html" title="StBin">
10
10
<link rel="next" href="StScrollView.html" title="StScrollView">
11
 
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
45
45
<a name="StBoxLayout.synopsis"></a><h2>Synopsis</h2>
46
46
<pre class="synopsis">struct              <a class="link" href="StBoxLayout.html#StBoxLayout-struct" title="struct StBoxLayout">StBoxLayout</a>;
47
47
struct              <a class="link" href="StBoxLayout.html#StBoxLayoutClass" title="struct StBoxLayoutClass">StBoxLayoutClass</a>;
 
48
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="StBoxLayout.html#st-box-layout-get-pack-start" title="st_box_layout_get_pack_start ()">st_box_layout_get_pack_start</a>        (<em class="parameter"><code><a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a> *box</code></em>);
 
49
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="StBoxLayout.html#st-box-layout-get-vertical" title="st_box_layout_get_vertical ()">st_box_layout_get_vertical</a>          (<em class="parameter"><code><a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a> *box</code></em>);
48
50
<a class="link" href="StWidget.html" title="StWidget"><span class="returnvalue">StWidget</span></a> *          <a class="link" href="StBoxLayout.html#st-box-layout-new" title="st_box_layout_new ()">st_box_layout_new</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
 
51
<span class="returnvalue">void</span>                <a class="link" href="StBoxLayout.html#st-box-layout-set-pack-start" title="st_box_layout_set_pack_start ()">st_box_layout_set_pack_start</a>        (<em class="parameter"><code><a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a> *box</code></em>,
 
52
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> pack_start</code></em>);
49
53
<span class="returnvalue">void</span>                <a class="link" href="StBoxLayout.html#st-box-layout-set-vertical" title="st_box_layout_set_vertical ()">st_box_layout_set_vertical</a>          (<em class="parameter"><code><a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a> *box</code></em>,
50
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> vertical</code></em>);
51
 
<span class="returnvalue">gboolean</span>            <a class="link" href="StBoxLayout.html#st-box-layout-get-vertical" title="st_box_layout_get_vertical ()">st_box_layout_get_vertical</a>          (<em class="parameter"><code><a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a> *box</code></em>);
52
 
<span class="returnvalue">void</span>                <a class="link" href="StBoxLayout.html#st-box-layout-set-pack-start" title="st_box_layout_set_pack_start ()">st_box_layout_set_pack_start</a>        (<em class="parameter"><code><a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a> *box</code></em>,
53
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> pack_start</code></em>);
54
 
<span class="returnvalue">gboolean</span>            <a class="link" href="StBoxLayout.html#st-box-layout-get-pack-start" title="st_box_layout_get_pack_start ()">st_box_layout_get_pack_start</a>        (<em class="parameter"><code><a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a> *box</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> vertical</code></em>);
55
55
</pre>
56
56
</div>
57
57
<div class="refsect1">
58
58
<a name="StBoxLayout.object-hierarchy"></a><h2>Object Hierarchy</h2>
59
59
<pre class="synopsis">
60
 
  GObject
61
 
   +----GInitiallyUnowned
62
 
         +----ClutterActor
 
60
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
61
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
62
         +----<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html">ClutterActor</a>
63
63
               +----<a class="link" href="StWidget.html" title="StWidget">StWidget</a>
64
64
                     +----StBoxLayout
65
65
</pre>
68
68
<a name="StBoxLayout.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
69
69
<p>
70
70
StBoxLayout implements
71
 
 ClutterContainer,  ClutterScriptable,  ClutterAnimatable,  AtkImplementorIface and  StScrollable.</p>
 
71
 <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>,  AtkImplementorIface and  StScrollable.</p>
72
72
</div>
73
73
<div class="refsect1">
74
74
<a name="StBoxLayout.properties"></a><h2>Properties</h2>
75
75
<pre class="synopsis">
76
 
  "<a class="link" href="StBoxLayout.html#StBoxLayout--pack-start" title='The "pack-start" property'>pack-start</a>"               <span class="type">gboolean</span>              : Read / Write
77
 
  "<a class="link" href="StBoxLayout.html#StBoxLayout--vertical" title='The "vertical" property'>vertical</a>"                 <span class="type">gboolean</span>              : Read / Write
 
76
  "<a class="link" href="StBoxLayout.html#StBoxLayout--pack-start" title='The "pack-start" property'>pack-start</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 
77
  "<a class="link" href="StBoxLayout.html#StBoxLayout--vertical" title='The "vertical" property'>vertical</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
78
78
</pre>
79
79
</div>
80
80
<div class="refsect1">
108
108
</div>
109
109
<hr>
110
110
<div class="refsect2">
 
111
<a name="st-box-layout-get-pack-start"></a><h3>st_box_layout_get_pack_start ()</h3>
 
112
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            st_box_layout_get_pack_start        (<em class="parameter"><code><a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a> *box</code></em>);</pre>
 
113
<p>
 
114
Get the value of the <span class="type">"pack-start"</span> property.
 
115
</p>
 
116
<div class="variablelist"><table border="0" class="variablelist">
 
117
<colgroup>
 
118
<col align="left" valign="top">
 
119
<col>
 
120
</colgroup>
 
121
<tbody>
 
122
<tr>
 
123
<td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
 
124
<td>A <a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a>
 
125
</td>
 
126
</tr>
 
127
<tr>
 
128
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
129
<td>
 
130
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if pack-start is enabled</td>
 
131
</tr>
 
132
</tbody>
 
133
</table></div>
 
134
</div>
 
135
<hr>
 
136
<div class="refsect2">
 
137
<a name="st-box-layout-get-vertical"></a><h3>st_box_layout_get_vertical ()</h3>
 
138
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            st_box_layout_get_vertical          (<em class="parameter"><code><a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a> *box</code></em>);</pre>
 
139
<p>
 
140
Get the value of the <span class="type">"vertical"</span> property.
 
141
</p>
 
142
<div class="variablelist"><table border="0" class="variablelist">
 
143
<colgroup>
 
144
<col align="left" valign="top">
 
145
<col>
 
146
</colgroup>
 
147
<tbody>
 
148
<tr>
 
149
<td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
 
150
<td>A <a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a>
 
151
</td>
 
152
</tr>
 
153
<tr>
 
154
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
155
<td>
 
156
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the layout is vertical</td>
 
157
</tr>
 
158
</tbody>
 
159
</table></div>
 
160
</div>
 
161
<hr>
 
162
<div class="refsect2">
111
163
<a name="st-box-layout-new"></a><h3>st_box_layout_new ()</h3>
112
164
<pre class="programlisting"><a class="link" href="StWidget.html" title="StWidget"><span class="returnvalue">StWidget</span></a> *          st_box_layout_new                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
113
165
<p>
127
179
</div>
128
180
<hr>
129
181
<div class="refsect2">
 
182
<a name="st-box-layout-set-pack-start"></a><h3>st_box_layout_set_pack_start ()</h3>
 
183
<pre class="programlisting"><span class="returnvalue">void</span>                st_box_layout_set_pack_start        (<em class="parameter"><code><a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a> *box</code></em>,
 
184
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> pack_start</code></em>);</pre>
 
185
<p>
 
186
Set the value of the <span class="type">"pack-start"</span> property.
 
187
</p>
 
188
<div class="variablelist"><table border="0" class="variablelist">
 
189
<colgroup>
 
190
<col align="left" valign="top">
 
191
<col>
 
192
</colgroup>
 
193
<tbody>
 
194
<tr>
 
195
<td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
 
196
<td>A <a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a>
 
197
</td>
 
198
</tr>
 
199
<tr>
 
200
<td><p><span class="term"><em class="parameter"><code>pack_start</code></em> :</span></p></td>
 
201
<td>
 
202
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the layout should use pack-start</td>
 
203
</tr>
 
204
</tbody>
 
205
</table></div>
 
206
</div>
 
207
<hr>
 
208
<div class="refsect2">
130
209
<a name="st-box-layout-set-vertical"></a><h3>st_box_layout_set_vertical ()</h3>
131
210
<pre class="programlisting"><span class="returnvalue">void</span>                st_box_layout_set_vertical          (<em class="parameter"><code><a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a> *box</code></em>,
132
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> vertical</code></em>);</pre>
 
211
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> vertical</code></em>);</pre>
133
212
<p>
134
213
Set the value of the <span class="type">"vertical"</span> property
135
214
</p>
147
226
<tr>
148
227
<td><p><span class="term"><em class="parameter"><code>vertical</code></em> :</span></p></td>
149
228
<td>
150
 
<code class="literal">TRUE</code> if the layout should be vertical</td>
151
 
</tr>
152
 
</tbody>
153
 
</table></div>
154
 
</div>
155
 
<hr>
156
 
<div class="refsect2">
157
 
<a name="st-box-layout-get-vertical"></a><h3>st_box_layout_get_vertical ()</h3>
158
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            st_box_layout_get_vertical          (<em class="parameter"><code><a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a> *box</code></em>);</pre>
159
 
<p>
160
 
Get the value of the <span class="type">"vertical"</span> property.
161
 
</p>
162
 
<div class="variablelist"><table border="0" class="variablelist">
163
 
<colgroup>
164
 
<col align="left" valign="top">
165
 
<col>
166
 
</colgroup>
167
 
<tbody>
168
 
<tr>
169
 
<td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
170
 
<td>A <a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a>
171
 
</td>
172
 
</tr>
173
 
<tr>
174
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
175
 
<td>
176
 
<code class="literal">TRUE</code> if the layout is vertical</td>
177
 
</tr>
178
 
</tbody>
179
 
</table></div>
180
 
</div>
181
 
<hr>
182
 
<div class="refsect2">
183
 
<a name="st-box-layout-set-pack-start"></a><h3>st_box_layout_set_pack_start ()</h3>
184
 
<pre class="programlisting"><span class="returnvalue">void</span>                st_box_layout_set_pack_start        (<em class="parameter"><code><a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a> *box</code></em>,
185
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> pack_start</code></em>);</pre>
186
 
<p>
187
 
Set the value of the <span class="type">"pack-start"</span> property.
188
 
</p>
189
 
<div class="variablelist"><table border="0" class="variablelist">
190
 
<colgroup>
191
 
<col align="left" valign="top">
192
 
<col>
193
 
</colgroup>
194
 
<tbody>
195
 
<tr>
196
 
<td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
197
 
<td>A <a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a>
198
 
</td>
199
 
</tr>
200
 
<tr>
201
 
<td><p><span class="term"><em class="parameter"><code>pack_start</code></em> :</span></p></td>
202
 
<td>
203
 
<code class="literal">TRUE</code> if the layout should use pack-start</td>
204
 
</tr>
205
 
</tbody>
206
 
</table></div>
207
 
</div>
208
 
<hr>
209
 
<div class="refsect2">
210
 
<a name="st-box-layout-get-pack-start"></a><h3>st_box_layout_get_pack_start ()</h3>
211
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            st_box_layout_get_pack_start        (<em class="parameter"><code><a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a> *box</code></em>);</pre>
212
 
<p>
213
 
Get the value of the <span class="type">"pack-start"</span> property.
214
 
</p>
215
 
<div class="variablelist"><table border="0" class="variablelist">
216
 
<colgroup>
217
 
<col align="left" valign="top">
218
 
<col>
219
 
</colgroup>
220
 
<tbody>
221
 
<tr>
222
 
<td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
223
 
<td>A <a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a>
224
 
</td>
225
 
</tr>
226
 
<tr>
227
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
228
 
<td>
229
 
<code class="literal">TRUE</code> if pack-start is enabled</td>
 
229
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the layout should be vertical</td>
230
230
</tr>
231
231
</tbody>
232
232
</table></div>
236
236
<a name="StBoxLayout.property-details"></a><h2>Property Details</h2>
237
237
<div class="refsect2">
238
238
<a name="StBoxLayout--pack-start"></a><h3>The <code class="literal">"pack-start"</code> property</h3>
239
 
<pre class="programlisting">  "pack-start"               <span class="type">gboolean</span>              : Read / Write</pre>
 
239
<pre class="programlisting">  "pack-start"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
240
240
<p>Whether to pack items at the start of the box.</p>
241
241
<p>Default value: FALSE</p>
242
242
</div>
243
243
<hr>
244
244
<div class="refsect2">
245
245
<a name="StBoxLayout--vertical"></a><h3>The <code class="literal">"vertical"</code> property</h3>
246
 
<pre class="programlisting">  "vertical"                 <span class="type">gboolean</span>              : Read / Write</pre>
 
246
<pre class="programlisting">  "vertical"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
247
247
<p>Whether the layout should be vertical, ratherthan horizontal.</p>
248
248
<p>Default value: FALSE</p>
249
249
</div>
251
251
</div>
252
252
<div class="footer">
253
253
<hr>
254
 
          Generated by GTK-Doc V1.18.1</div>
 
254
          Generated by GTK-Doc V1.18</div>
255
255
</body>
256
256
</html>
 
 
b'\\ No newline at end of file'