← Back to branch summary

~ubuntu-branches/ubuntu/saucy/gnome-shell/saucy-proposed

« back to all changes in this revision

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

Tags: upstream-3.3.90
Import upstream version 3.3.90

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/st/html/StBoxLayout.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>StBoxLayout</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="index.html" title="St Reference Manual">
 
8
<link rel="up" href="containers.html" title="Containers">
 
9
<link rel="prev" href="StBin.html" title="StBin">
 
10
<link rel="next" href="StGroup.html" title="StGroup">
 
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="StBin.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="containers.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">St Reference Manual</th>
 
21
<td><a accesskey="n" href="StGroup.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#StBoxLayout.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#StBoxLayout.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#StBoxLayout.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#StBoxLayout.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
31
                   | 
 
32
                  <a href="#StBoxLayout.properties" class="shortcut">Properties</a>
 
33
</td></tr>
 
34
</table>
 
35
<div class="refentry">
 
36
<a name="StBoxLayout"></a><div class="titlepage"></div>
 
37
<div class="refnamediv"><table width="100%"><tr>
 
38
<td valign="top">
 
39
<h2><span class="refentrytitle"><a name="StBoxLayout.top_of_page"></a>StBoxLayout</span></h2>
 
40
<p>StBoxLayout — a layout container arranging children in a single line</p>
 
41
</td>
 
42
<td valign="top" align="right"></td>
 
43
</tr></table></div>
 
44
<div class="refsynopsisdiv">
 
45
<a name="StBoxLayout.synopsis"></a><h2>Synopsis</h2>
 
46
<pre class="synopsis">struct              <a class="link" href="StBoxLayout.html#StBoxLayout-struct" title="struct StBoxLayout">StBoxLayout</a>;
 
47
struct              <a class="link" href="StBoxLayout.html#StBoxLayoutClass" title="struct StBoxLayoutClass">StBoxLayoutClass</a>;
 
48
<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>);
 
49
<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>);
 
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><span class="type">gboolean</span> pack_start</code></em>);
 
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>,
 
54
                                                         <em class="parameter"><code><span class="type">gboolean</span> vertical</code></em>);
 
55
</pre>
 
56
</div>
 
57
<div class="refsect1">
 
58
<a name="StBoxLayout.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
59
<pre class="synopsis">
 
60
  GObject
 
61
   +----GInitiallyUnowned
 
62
         +----ClutterActor
 
63
               +----<a class="link" href="StWidget.html" title="StWidget">StWidget</a>
 
64
                     +----<a class="link" href="StContainer.html" title="StContainer">StContainer</a>
 
65
                           +----StBoxLayout
 
66
</pre>
 
67
</div>
 
68
<div class="refsect1">
 
69
<a name="StBoxLayout.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 
70
<p>
 
71
StBoxLayout implements
 
72
 ClutterContainer,  ClutterScriptable,  ClutterAnimatable,  AtkImplementorIface and  StScrollable.</p>
 
73
</div>
 
74
<div class="refsect1">
 
75
<a name="StBoxLayout.properties"></a><h2>Properties</h2>
 
76
<pre class="synopsis">
 
77
  "<a class="link" href="StBoxLayout.html#StBoxLayout--pack-start" title='The "pack-start" property'>pack-start</a>"               <span class="type">gboolean</span>              : Read / Write
 
78
  "<a class="link" href="StBoxLayout.html#StBoxLayout--vertical" title='The "vertical" property'>vertical</a>"                 <span class="type">gboolean</span>              : Read / Write
 
79
</pre>
 
80
</div>
 
81
<div class="refsect1">
 
82
<a name="StBoxLayout.description"></a><h2>Description</h2>
 
83
<p>
 
84
The <a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a> arranges its children along a single line, where each
 
85
child can be allocated either its preferred size or larger if the expand
 
86
option is set. If the fill option is set, the actor will be allocated more
 
87
than its requested size. If the fill option is not set, but the expand option
 
88
is enabled, then the position of the actor within the available space can
 
89
be determined by the alignment child property.
 
90
</p>
 
91
</div>
 
92
<div class="refsect1">
 
93
<a name="StBoxLayout.details"></a><h2>Details</h2>
 
94
<div class="refsect2">
 
95
<a name="StBoxLayout-struct"></a><h3>struct StBoxLayout</h3>
 
96
<pre class="programlisting">struct StBoxLayout;</pre>
 
97
<p>
 
98
The contents of this structure are private and should only be accessed
 
99
through the public API.
 
100
</p>
 
101
</div>
 
102
<hr>
 
103
<div class="refsect2">
 
104
<a name="StBoxLayoutClass"></a><h3>struct StBoxLayoutClass</h3>
 
105
<pre class="programlisting">struct StBoxLayoutClass {
 
106
  StContainerClass parent_class;
 
107
};
 
108
</pre>
 
109
</div>
 
110
<hr>
 
111
<div class="refsect2">
 
112
<a name="st-box-layout-get-pack-start"></a><h3>st_box_layout_get_pack_start ()</h3>
 
113
<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>
 
114
<p>
 
115
Get the value of the <span class="type">"pack-start"</span> property.
 
116
</p>
 
117
<div class="variablelist"><table border="0">
 
118
<col align="left" valign="top">
 
119
<tbody>
 
120
<tr>
 
121
<td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
 
122
<td>A <a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a>
 
123
</td>
 
124
</tr>
 
125
<tr>
 
126
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
127
<td>
 
128
<code class="literal">TRUE</code> if pack-start is enabled</td>
 
129
</tr>
 
130
</tbody>
 
131
</table></div>
 
132
</div>
 
133
<hr>
 
134
<div class="refsect2">
 
135
<a name="st-box-layout-get-vertical"></a><h3>st_box_layout_get_vertical ()</h3>
 
136
<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>
 
137
<p>
 
138
Get the value of the <span class="type">"vertical"</span> property.
 
139
</p>
 
140
<div class="variablelist"><table border="0">
 
141
<col align="left" valign="top">
 
142
<tbody>
 
143
<tr>
 
144
<td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
 
145
<td>A <a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a>
 
146
</td>
 
147
</tr>
 
148
<tr>
 
149
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
150
<td>
 
151
<code class="literal">TRUE</code> if the layout is vertical</td>
 
152
</tr>
 
153
</tbody>
 
154
</table></div>
 
155
</div>
 
156
<hr>
 
157
<div class="refsect2">
 
158
<a name="st-box-layout-new"></a><h3>st_box_layout_new ()</h3>
 
159
<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>
 
160
<p>
 
161
Create a new <a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a>.
 
162
</p>
 
163
<div class="variablelist"><table border="0">
 
164
<col align="left" valign="top">
 
165
<tbody><tr>
 
166
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
167
<td>a newly allocated <a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a>
 
168
</td>
 
169
</tr></tbody>
 
170
</table></div>
 
171
</div>
 
172
<hr>
 
173
<div class="refsect2">
 
174
<a name="st-box-layout-set-pack-start"></a><h3>st_box_layout_set_pack_start ()</h3>
 
175
<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>,
 
176
                                                         <em class="parameter"><code><span class="type">gboolean</span> pack_start</code></em>);</pre>
 
177
<p>
 
178
Set the value of the <span class="type">"pack-start"</span> property.
 
179
</p>
 
180
<div class="variablelist"><table border="0">
 
181
<col align="left" valign="top">
 
182
<tbody>
 
183
<tr>
 
184
<td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
 
185
<td>A <a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a>
 
186
</td>
 
187
</tr>
 
188
<tr>
 
189
<td><p><span class="term"><em class="parameter"><code>pack_start</code></em> :</span></p></td>
 
190
<td>
 
191
<code class="literal">TRUE</code> if the layout should use pack-start</td>
 
192
</tr>
 
193
</tbody>
 
194
</table></div>
 
195
</div>
 
196
<hr>
 
197
<div class="refsect2">
 
198
<a name="st-box-layout-set-vertical"></a><h3>st_box_layout_set_vertical ()</h3>
 
199
<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>,
 
200
                                                         <em class="parameter"><code><span class="type">gboolean</span> vertical</code></em>);</pre>
 
201
<p>
 
202
Set the value of the <span class="type">"vertical"</span> property
 
203
</p>
 
204
<div class="variablelist"><table border="0">
 
205
<col align="left" valign="top">
 
206
<tbody>
 
207
<tr>
 
208
<td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
 
209
<td>A <a class="link" href="StBoxLayout.html" title="StBoxLayout"><span class="type">StBoxLayout</span></a>
 
210
</td>
 
211
</tr>
 
212
<tr>
 
213
<td><p><span class="term"><em class="parameter"><code>vertical</code></em> :</span></p></td>
 
214
<td>
 
215
<code class="literal">TRUE</code> if the layout should be vertical</td>
 
216
</tr>
 
217
</tbody>
 
218
</table></div>
 
219
</div>
 
220
</div>
 
221
<div class="refsect1">
 
222
<a name="StBoxLayout.property-details"></a><h2>Property Details</h2>
 
223
<div class="refsect2">
 
224
<a name="StBoxLayout--pack-start"></a><h3>The <code class="literal">"pack-start"</code> property</h3>
 
225
<pre class="programlisting">  "pack-start"               <span class="type">gboolean</span>              : Read / Write</pre>
 
226
<p>Whether to pack items at the start of the box.</p>
 
227
<p>Default value: FALSE</p>
 
228
</div>
 
229
<hr>
 
230
<div class="refsect2">
 
231
<a name="StBoxLayout--vertical"></a><h3>The <code class="literal">"vertical"</code> property</h3>
 
232
<pre class="programlisting">  "vertical"                 <span class="type">gboolean</span>              : Read / Write</pre>
 
233
<p>Whether the layout should be vertical, ratherthan horizontal.</p>
 
234
<p>Default value: FALSE</p>
 
235
</div>
 
236
</div>
 
237
</div>
 
238
<div class="footer">
 
239
<hr>
 
240
          Generated by GTK-Doc V1.18.1</div>
 
241
</body>
 
242
</html>
 
 
b'\\ No newline at end of file'