cleanup specfile for packaging
[profile/ivi/clutter.git] / doc / reference / clutter / html / ClutterFlowLayout.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>ClutterFlowLayout</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="Clutter Reference Manual">
8 <link rel="up" href="ch03.html" title="Layout managers">
9 <link rel="prev" href="ClutterBinLayout.html" title="ClutterBinLayout">
10 <link rel="next" href="ClutterBoxLayout.html" title="ClutterBoxLayout">
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="ClutterBinLayout.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch03.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">Clutter Reference Manual</th>
21 <td><a accesskey="n" href="ClutterBoxLayout.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="#ClutterFlowLayout.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#ClutterFlowLayout.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#ClutterFlowLayout.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#ClutterFlowLayout.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry">
34 <a name="ClutterFlowLayout"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
36 <td valign="top">
37 <h2><span class="refentrytitle"><a name="ClutterFlowLayout.top_of_page"></a>ClutterFlowLayout</span></h2>
38 <p>ClutterFlowLayout — A reflowing layout manager</p>
39 </td>
40 <td valign="top" align="right"></td>
41 </tr></table></div>
42 <div class="refsynopsisdiv">
43 <a name="ClutterFlowLayout.synopsis"></a><h2>Synopsis</h2>
44 <pre class="synopsis">enum                <a class="link" href="ClutterFlowLayout.html#ClutterFlowOrientation" title="enum ClutterFlowOrientation">ClutterFlowOrientation</a>;
45 struct              <a class="link" href="ClutterFlowLayout.html#ClutterFlowLayout-struct" title="struct ClutterFlowLayout">ClutterFlowLayout</a>;
46 struct              <a class="link" href="ClutterFlowLayout.html#ClutterFlowLayoutClass" title="struct ClutterFlowLayoutClass">ClutterFlowLayoutClass</a>;
47 <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="returnvalue">ClutterLayoutManager</span></a> * <a class="link" href="ClutterFlowLayout.html#clutter-flow-layout-new" title="clutter_flow_layout_new ()">clutter_flow_layout_new</a>          (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html#ClutterFlowOrientation" title="enum ClutterFlowOrientation"><span class="type">ClutterFlowOrientation</span></a> orientation</code></em>);
48 <span class="returnvalue">void</span>                <a class="link" href="ClutterFlowLayout.html#clutter-flow-layout-set-homogeneous" title="clutter_flow_layout_set_homogeneous ()">clutter_flow_layout_set_homogeneous</a> (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>,
49                                                          <em class="parameter"><code><span class="type">gboolean</span> homogeneous</code></em>);
50 <span class="returnvalue">gboolean</span>            <a class="link" href="ClutterFlowLayout.html#clutter-flow-layout-get-homogeneous" title="clutter_flow_layout_get_homogeneous ()">clutter_flow_layout_get_homogeneous</a> (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>);
51 <span class="returnvalue">void</span>                <a class="link" href="ClutterFlowLayout.html#clutter-flow-layout-set-orientation" title="clutter_flow_layout_set_orientation ()">clutter_flow_layout_set_orientation</a> (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>,
52                                                          <em class="parameter"><code><a class="link" href="ClutterFlowLayout.html#ClutterFlowOrientation" title="enum ClutterFlowOrientation"><span class="type">ClutterFlowOrientation</span></a> orientation</code></em>);
53 <a class="link" href="ClutterFlowLayout.html#ClutterFlowOrientation" title="enum ClutterFlowOrientation"><span class="returnvalue">ClutterFlowOrientation</span></a> <a class="link" href="ClutterFlowLayout.html#clutter-flow-layout-get-orientation" title="clutter_flow_layout_get_orientation ()">clutter_flow_layout_get_orientation</a>
54                                                         (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>);
55
56 <span class="returnvalue">void</span>                <a class="link" href="ClutterFlowLayout.html#clutter-flow-layout-set-column-spacing" title="clutter_flow_layout_set_column_spacing ()">clutter_flow_layout_set_column_spacing</a>
57                                                         (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>,
58                                                          <em class="parameter"><code><span class="type">gfloat</span> spacing</code></em>);
59 <span class="returnvalue">gfloat</span>              <a class="link" href="ClutterFlowLayout.html#clutter-flow-layout-get-column-spacing" title="clutter_flow_layout_get_column_spacing ()">clutter_flow_layout_get_column_spacing</a>
60                                                         (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>);
61 <span class="returnvalue">void</span>                <a class="link" href="ClutterFlowLayout.html#clutter-flow-layout-set-row-spacing" title="clutter_flow_layout_set_row_spacing ()">clutter_flow_layout_set_row_spacing</a> (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>,
62                                                          <em class="parameter"><code><span class="type">gfloat</span> spacing</code></em>);
63 <span class="returnvalue">gfloat</span>              <a class="link" href="ClutterFlowLayout.html#clutter-flow-layout-get-row-spacing" title="clutter_flow_layout_get_row_spacing ()">clutter_flow_layout_get_row_spacing</a> (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>);
64 <span class="returnvalue">void</span>                <a class="link" href="ClutterFlowLayout.html#clutter-flow-layout-set-column-width" title="clutter_flow_layout_set_column_width ()">clutter_flow_layout_set_column_width</a>
65                                                         (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>,
66                                                          <em class="parameter"><code><span class="type">gfloat</span> min_width</code></em>,
67                                                          <em class="parameter"><code><span class="type">gfloat</span> max_width</code></em>);
68 <span class="returnvalue">void</span>                <a class="link" href="ClutterFlowLayout.html#clutter-flow-layout-get-column-width" title="clutter_flow_layout_get_column_width ()">clutter_flow_layout_get_column_width</a>
69                                                         (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>,
70                                                          <em class="parameter"><code><span class="type">gfloat</span> *min_width</code></em>,
71                                                          <em class="parameter"><code><span class="type">gfloat</span> *max_width</code></em>);
72 <span class="returnvalue">void</span>                <a class="link" href="ClutterFlowLayout.html#clutter-flow-layout-set-row-height" title="clutter_flow_layout_set_row_height ()">clutter_flow_layout_set_row_height</a>  (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>,
73                                                          <em class="parameter"><code><span class="type">gfloat</span> min_height</code></em>,
74                                                          <em class="parameter"><code><span class="type">gfloat</span> max_height</code></em>);
75 <span class="returnvalue">void</span>                <a class="link" href="ClutterFlowLayout.html#clutter-flow-layout-get-row-height" title="clutter_flow_layout_get_row_height ()">clutter_flow_layout_get_row_height</a>  (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>,
76                                                          <em class="parameter"><code><span class="type">gfloat</span> *min_height</code></em>,
77                                                          <em class="parameter"><code><span class="type">gfloat</span> *max_height</code></em>);
78 </pre>
79 </div>
80 <div class="refsect1">
81 <a name="ClutterFlowLayout.object-hierarchy"></a><h2>Object Hierarchy</h2>
82 <pre class="synopsis">
83   GObject
84    +----GInitiallyUnowned
85          +----<a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager">ClutterLayoutManager</a>
86                +----ClutterFlowLayout
87 </pre>
88 </div>
89 <div class="refsect1">
90 <a name="ClutterFlowLayout.properties"></a><h2>Properties</h2>
91 <pre class="synopsis">
92   "<a class="link" href="ClutterFlowLayout.html#ClutterFlowLayout--column-spacing" title='The "column-spacing" property'>column-spacing</a>"           <span class="type">gfloat</span>                : Read / Write
93   "<a class="link" href="ClutterFlowLayout.html#ClutterFlowLayout--homogeneous" title='The "homogeneous" property'>homogeneous</a>"              <span class="type">gboolean</span>              : Read / Write
94   "<a class="link" href="ClutterFlowLayout.html#ClutterFlowLayout--max-column-width" title='The "max-column-width" property'>max-column-width</a>"         <span class="type">gfloat</span>                : Read / Write
95   "<a class="link" href="ClutterFlowLayout.html#ClutterFlowLayout--max-row-height" title='The "max-row-height" property'>max-row-height</a>"           <span class="type">gfloat</span>                : Read / Write
96   "<a class="link" href="ClutterFlowLayout.html#ClutterFlowLayout--min-column-width" title='The "min-column-width" property'>min-column-width</a>"         <span class="type">gfloat</span>                : Read / Write
97   "<a class="link" href="ClutterFlowLayout.html#ClutterFlowLayout--min-row-height" title='The "min-row-height" property'>min-row-height</a>"           <span class="type">gfloat</span>                : Read / Write
98   "<a class="link" href="ClutterFlowLayout.html#ClutterFlowLayout--orientation" title='The "orientation" property'>orientation</a>"              <a class="link" href="ClutterFlowLayout.html#ClutterFlowOrientation" title="enum ClutterFlowOrientation"><span class="type">ClutterFlowOrientation</span></a>  : Read / Write / Construct
99   "<a class="link" href="ClutterFlowLayout.html#ClutterFlowLayout--row-spacing" title='The "row-spacing" property'>row-spacing</a>"              <span class="type">gfloat</span>                : Read / Write
100 </pre>
101 </div>
102 <div class="refsect1">
103 <a name="ClutterFlowLayout.description"></a><h2>Description</h2>
104 <p>
105 <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> is a layout manager which implements the following
106 policy:
107 </p>
108 <p>
109 </p>
110 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
111 <li class="listitem"><p>the preferred natural size depends on the value
112   of the <a class="link" href="ClutterFlowLayout.html#ClutterFlowLayout--orientation" title='The "orientation" property'><span class="type">"orientation"</span></a> property; the layout will try
113   to maintain all its children on a single row or
114   column;</p></li>
115 <li class="listitem"><p>if either the width or the height allocated are
116   smaller than the preferred ones, the layout will wrap; in this case,
117   the preferred height or width, respectively, will take into account
118   the amount of columns and rows;</p></li>
119 <li class="listitem"><p>each line (either column or row) in reflowing will
120   have the size of the biggest cell on that line; if the
121   <a class="link" href="ClutterFlowLayout.html#ClutterFlowLayout--homogeneous" title='The "homogeneous" property'><span class="type">"homogeneous"</span></a> property is set to <code class="literal">FALSE</code> the actor
122   will be allocated within that area, and if set to <code class="literal">TRUE</code> instead the
123   actor will be given exactly that area;</p></li>
124 <li class="listitem"><p>the size of the columns or rows can be controlled
125   for both minimum and maximum; the spacing can also be controlled
126   in both columns and rows.</p></li>
127 </ul></div>
128 <p>
129 </p>
130 <p>
131 </p>
132 <div class="figure">
133 <a name="flow-layout-image"></a><p class="title"><b>Figure 5. Horizontal flow layout</b></p>
134 <div class="figure-contents">
135 <p>The image shows a <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> with the
136   <a class="link" href="ClutterFlowLayout.html#ClutterFlowLayout--orientation" title='The "orientation" property'><span class="type">"orientation"</span></a> propert set to
137   <a class="link" href="ClutterFlowLayout.html#CLUTTER-FLOW-HORIZONTAL:CAPS"><code class="literal">CLUTTER_FLOW_HORIZONTAL</code></a>.</p>
138 <div><img src="flow-layout.png" alt="Horizontal flow layout"></div>
139 </div>
140 </div>
141 <p><br class="figure-break">
142 </p>
143 <p>
144 <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> is available since Clutter 1.2
145 </p>
146 </div>
147 <div class="refsect1">
148 <a name="ClutterFlowLayout.details"></a><h2>Details</h2>
149 <div class="refsect2">
150 <a name="ClutterFlowOrientation"></a><h3>enum ClutterFlowOrientation</h3>
151 <pre class="programlisting">typedef enum {
152  /*&lt; prefix=CLUTTER_FLOW &gt;*/
153   CLUTTER_FLOW_HORIZONTAL,
154   CLUTTER_FLOW_VERTICAL
155 } ClutterFlowOrientation;
156 </pre>
157 <p>
158 The direction of the arrangement of the children inside
159 a <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a>
160 </p>
161 <div class="variablelist"><table border="0">
162 <col align="left" valign="top">
163 <tbody>
164 <tr>
165 <td><p><a name="CLUTTER-FLOW-HORIZONTAL:CAPS"></a><span class="term"><code class="literal">CLUTTER_FLOW_HORIZONTAL</code></span></p></td>
166 <td>Arrange the children of the flow layout
167   horizontally first
168 </td>
169 </tr>
170 <tr>
171 <td><p><a name="CLUTTER-FLOW-VERTICAL:CAPS"></a><span class="term"><code class="literal">CLUTTER_FLOW_VERTICAL</code></span></p></td>
172 <td>Arrange the children of the flow layout
173   vertically first
174 </td>
175 </tr>
176 </tbody>
177 </table></div>
178 <p class="since">Since 1.2</p>
179 </div>
180 <hr>
181 <div class="refsect2">
182 <a name="ClutterFlowLayout-struct"></a><h3>struct ClutterFlowLayout</h3>
183 <pre class="programlisting">struct ClutterFlowLayout;</pre>
184 <p>
185 The <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> structure contains only private data
186 and should be accessed using the provided API
187 </p>
188 <p class="since">Since 1.2</p>
189 </div>
190 <hr>
191 <div class="refsect2">
192 <a name="ClutterFlowLayoutClass"></a><h3>struct ClutterFlowLayoutClass</h3>
193 <pre class="programlisting">struct ClutterFlowLayoutClass {
194 };
195 </pre>
196 <p>
197 The <a class="link" href="ClutterFlowLayout.html#ClutterFlowLayoutClass" title="struct ClutterFlowLayoutClass"><span class="type">ClutterFlowLayoutClass</span></a> structure contains only private data
198 and should be accessed using the provided API
199 </p>
200 <p class="since">Since 1.2</p>
201 </div>
202 <hr>
203 <div class="refsect2">
204 <a name="clutter-flow-layout-new"></a><h3>clutter_flow_layout_new ()</h3>
205 <pre class="programlisting"><a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="returnvalue">ClutterLayoutManager</span></a> * clutter_flow_layout_new          (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html#ClutterFlowOrientation" title="enum ClutterFlowOrientation"><span class="type">ClutterFlowOrientation</span></a> orientation</code></em>);</pre>
206 <p>
207 Creates a new <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> with the given <em class="parameter"><code>orientation</code></em>
208 </p>
209 <div class="variablelist"><table border="0">
210 <col align="left" valign="top">
211 <tbody>
212 <tr>
213 <td><p><span class="term"><em class="parameter"><code>orientation</code></em> :</span></p></td>
214 <td>the orientation of the flow layout</td>
215 </tr>
216 <tr>
217 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
218 <td>the newly created <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a>
219 </td>
220 </tr>
221 </tbody>
222 </table></div>
223 <p class="since">Since 1.2</p>
224 </div>
225 <hr>
226 <div class="refsect2">
227 <a name="clutter-flow-layout-set-homogeneous"></a><h3>clutter_flow_layout_set_homogeneous ()</h3>
228 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_flow_layout_set_homogeneous (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>,
229                                                          <em class="parameter"><code><span class="type">gboolean</span> homogeneous</code></em>);</pre>
230 <p>
231 Sets whether the <em class="parameter"><code>layout</code></em> should allocate the same space for
232 each child
233 </p>
234 <div class="variablelist"><table border="0">
235 <col align="left" valign="top">
236 <tbody>
237 <tr>
238 <td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
239 <td>a <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a>
240 </td>
241 </tr>
242 <tr>
243 <td><p><span class="term"><em class="parameter"><code>homogeneous</code></em> :</span></p></td>
244 <td>whether the layout should be homogeneous or not</td>
245 </tr>
246 </tbody>
247 </table></div>
248 <p class="since">Since 1.2</p>
249 </div>
250 <hr>
251 <div class="refsect2">
252 <a name="clutter-flow-layout-get-homogeneous"></a><h3>clutter_flow_layout_get_homogeneous ()</h3>
253 <pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_flow_layout_get_homogeneous (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>);</pre>
254 <p>
255 Retrieves whether the <em class="parameter"><code>layout</code></em> is homogeneous
256 </p>
257 <div class="variablelist"><table border="0">
258 <col align="left" valign="top">
259 <tbody>
260 <tr>
261 <td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
262 <td>a <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a>
263 </td>
264 </tr>
265 <tr>
266 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
267 <td>
268 <code class="literal">TRUE</code> if the <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> is homogeneous</td>
269 </tr>
270 </tbody>
271 </table></div>
272 <p class="since">Since 1.2</p>
273 </div>
274 <hr>
275 <div class="refsect2">
276 <a name="clutter-flow-layout-set-orientation"></a><h3>clutter_flow_layout_set_orientation ()</h3>
277 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_flow_layout_set_orientation (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>,
278                                                          <em class="parameter"><code><a class="link" href="ClutterFlowLayout.html#ClutterFlowOrientation" title="enum ClutterFlowOrientation"><span class="type">ClutterFlowOrientation</span></a> orientation</code></em>);</pre>
279 <p>
280 Sets the orientation of the flow layout
281 </p>
282 <p>
283 The orientation controls the direction used to allocate
284 the children: either horizontally or vertically. The
285 orientation also controls the direction of the overflowing
286 </p>
287 <div class="variablelist"><table border="0">
288 <col align="left" valign="top">
289 <tbody>
290 <tr>
291 <td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
292 <td>a <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a>
293 </td>
294 </tr>
295 <tr>
296 <td><p><span class="term"><em class="parameter"><code>orientation</code></em> :</span></p></td>
297 <td>the orientation of the layout</td>
298 </tr>
299 </tbody>
300 </table></div>
301 <p class="since">Since 1.2</p>
302 </div>
303 <hr>
304 <div class="refsect2">
305 <a name="clutter-flow-layout-get-orientation"></a><h3>clutter_flow_layout_get_orientation ()</h3>
306 <pre class="programlisting"><a class="link" href="ClutterFlowLayout.html#ClutterFlowOrientation" title="enum ClutterFlowOrientation"><span class="returnvalue">ClutterFlowOrientation</span></a> clutter_flow_layout_get_orientation
307                                                         (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>);</pre>
308 <p>
309 Retrieves the orientation of the <em class="parameter"><code>layout</code></em>
310 </p>
311 <div class="variablelist"><table border="0">
312 <col align="left" valign="top">
313 <tbody>
314 <tr>
315 <td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
316 <td>a <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a>
317 </td>
318 </tr>
319 <tr>
320 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
321 <td>the orientation of the <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a>
322 </td>
323 </tr>
324 </tbody>
325 </table></div>
326 <p class="since">Since 1.2</p>
327 </div>
328 <hr>
329 <div class="refsect2">
330 <a name="clutter-flow-layout-set-column-spacing"></a><h3>clutter_flow_layout_set_column_spacing ()</h3>
331 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_flow_layout_set_column_spacing
332                                                         (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>,
333                                                          <em class="parameter"><code><span class="type">gfloat</span> spacing</code></em>);</pre>
334 <p>
335 Sets the space between columns, in pixels
336 </p>
337 <div class="variablelist"><table border="0">
338 <col align="left" valign="top">
339 <tbody>
340 <tr>
341 <td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
342 <td>a <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a>
343 </td>
344 </tr>
345 <tr>
346 <td><p><span class="term"><em class="parameter"><code>spacing</code></em> :</span></p></td>
347 <td>the space between columns</td>
348 </tr>
349 </tbody>
350 </table></div>
351 <p class="since">Since 1.2</p>
352 </div>
353 <hr>
354 <div class="refsect2">
355 <a name="clutter-flow-layout-get-column-spacing"></a><h3>clutter_flow_layout_get_column_spacing ()</h3>
356 <pre class="programlisting"><span class="returnvalue">gfloat</span>              clutter_flow_layout_get_column_spacing
357                                                         (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>);</pre>
358 <p>
359 Retrieves the spacing between columns
360 </p>
361 <div class="variablelist"><table border="0">
362 <col align="left" valign="top">
363 <tbody>
364 <tr>
365 <td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
366 <td>a <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a>
367 </td>
368 </tr>
369 <tr>
370 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
371 <td>the spacing between columns of the <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a>,
372 in pixels</td>
373 </tr>
374 </tbody>
375 </table></div>
376 <p class="since">Since 1.2</p>
377 </div>
378 <hr>
379 <div class="refsect2">
380 <a name="clutter-flow-layout-set-row-spacing"></a><h3>clutter_flow_layout_set_row_spacing ()</h3>
381 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_flow_layout_set_row_spacing (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>,
382                                                          <em class="parameter"><code><span class="type">gfloat</span> spacing</code></em>);</pre>
383 <p>
384 Sets the spacing between rows, in pixels
385 </p>
386 <div class="variablelist"><table border="0">
387 <col align="left" valign="top">
388 <tbody>
389 <tr>
390 <td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
391 <td>a <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a>
392 </td>
393 </tr>
394 <tr>
395 <td><p><span class="term"><em class="parameter"><code>spacing</code></em> :</span></p></td>
396 <td>the space between rows</td>
397 </tr>
398 </tbody>
399 </table></div>
400 <p class="since">Since 1.2</p>
401 </div>
402 <hr>
403 <div class="refsect2">
404 <a name="clutter-flow-layout-get-row-spacing"></a><h3>clutter_flow_layout_get_row_spacing ()</h3>
405 <pre class="programlisting"><span class="returnvalue">gfloat</span>              clutter_flow_layout_get_row_spacing (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>);</pre>
406 <p>
407 Retrieves the spacing between rows
408 </p>
409 <div class="variablelist"><table border="0">
410 <col align="left" valign="top">
411 <tbody>
412 <tr>
413 <td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
414 <td>a <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a>
415 </td>
416 </tr>
417 <tr>
418 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
419 <td>the spacing between rows of the <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a>,
420 in pixels</td>
421 </tr>
422 </tbody>
423 </table></div>
424 <p class="since">Since 1.2</p>
425 </div>
426 <hr>
427 <div class="refsect2">
428 <a name="clutter-flow-layout-set-column-width"></a><h3>clutter_flow_layout_set_column_width ()</h3>
429 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_flow_layout_set_column_width
430                                                         (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>,
431                                                          <em class="parameter"><code><span class="type">gfloat</span> min_width</code></em>,
432                                                          <em class="parameter"><code><span class="type">gfloat</span> max_width</code></em>);</pre>
433 <p>
434 Sets the minimum and maximum widths that a column can have
435 </p>
436 <div class="variablelist"><table border="0">
437 <col align="left" valign="top">
438 <tbody>
439 <tr>
440 <td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
441 <td>a <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a>
442 </td>
443 </tr>
444 <tr>
445 <td><p><span class="term"><em class="parameter"><code>min_width</code></em> :</span></p></td>
446 <td>minimum width of a column</td>
447 </tr>
448 <tr>
449 <td><p><span class="term"><em class="parameter"><code>max_width</code></em> :</span></p></td>
450 <td>maximum width of a column</td>
451 </tr>
452 </tbody>
453 </table></div>
454 <p class="since">Since 1.2</p>
455 </div>
456 <hr>
457 <div class="refsect2">
458 <a name="clutter-flow-layout-get-column-width"></a><h3>clutter_flow_layout_get_column_width ()</h3>
459 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_flow_layout_get_column_width
460                                                         (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>,
461                                                          <em class="parameter"><code><span class="type">gfloat</span> *min_width</code></em>,
462                                                          <em class="parameter"><code><span class="type">gfloat</span> *max_width</code></em>);</pre>
463 <p>
464 Retrieves the minimum and maximum column widths
465 </p>
466 <div class="variablelist"><table border="0">
467 <col align="left" valign="top">
468 <tbody>
469 <tr>
470 <td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
471 <td>a <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a>
472 </td>
473 </tr>
474 <tr>
475 <td><p><span class="term"><em class="parameter"><code>min_width</code></em> :</span></p></td>
476 <td>return location for the minimum column width, or <a href="/home/ebassi/gnome3/install/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>
477 </td>
478 </tr>
479 <tr>
480 <td><p><span class="term"><em class="parameter"><code>max_width</code></em> :</span></p></td>
481 <td>return location for the maximum column width, or <a href="/home/ebassi/gnome3/install/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>
482 </td>
483 </tr>
484 </tbody>
485 </table></div>
486 <p class="since">Since 1.2</p>
487 </div>
488 <hr>
489 <div class="refsect2">
490 <a name="clutter-flow-layout-set-row-height"></a><h3>clutter_flow_layout_set_row_height ()</h3>
491 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_flow_layout_set_row_height  (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>,
492                                                          <em class="parameter"><code><span class="type">gfloat</span> min_height</code></em>,
493                                                          <em class="parameter"><code><span class="type">gfloat</span> max_height</code></em>);</pre>
494 <p>
495 Sets the minimum and maximum heights that a row can have
496 </p>
497 <div class="variablelist"><table border="0">
498 <col align="left" valign="top">
499 <tbody>
500 <tr>
501 <td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
502 <td>a <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a>
503 </td>
504 </tr>
505 <tr>
506 <td><p><span class="term"><em class="parameter"><code>min_height</code></em> :</span></p></td>
507 <td>the minimum height of a row</td>
508 </tr>
509 <tr>
510 <td><p><span class="term"><em class="parameter"><code>max_height</code></em> :</span></p></td>
511 <td>the maximum height of a row</td>
512 </tr>
513 </tbody>
514 </table></div>
515 <p class="since">Since 1.2</p>
516 </div>
517 <hr>
518 <div class="refsect2">
519 <a name="clutter-flow-layout-get-row-height"></a><h3>clutter_flow_layout_get_row_height ()</h3>
520 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_flow_layout_get_row_height  (<em class="parameter"><code><a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> *layout</code></em>,
521                                                          <em class="parameter"><code><span class="type">gfloat</span> *min_height</code></em>,
522                                                          <em class="parameter"><code><span class="type">gfloat</span> *max_height</code></em>);</pre>
523 <p>
524 Retrieves the minimum and maximum row heights
525 </p>
526 <div class="variablelist"><table border="0">
527 <col align="left" valign="top">
528 <tbody>
529 <tr>
530 <td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
531 <td>a <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a>
532 </td>
533 </tr>
534 <tr>
535 <td><p><span class="term"><em class="parameter"><code>min_height</code></em> :</span></p></td>
536 <td>return location for the minimum row height, or <a href="/home/ebassi/gnome3/install/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>
537 </td>
538 </tr>
539 <tr>
540 <td><p><span class="term"><em class="parameter"><code>max_height</code></em> :</span></p></td>
541 <td>return location for the maximum row height, or <a href="/home/ebassi/gnome3/install/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>
542 </td>
543 </tr>
544 </tbody>
545 </table></div>
546 <p class="since">Since 1.2</p>
547 </div>
548 </div>
549 <div class="refsect1">
550 <a name="ClutterFlowLayout.property-details"></a><h2>Property Details</h2>
551 <div class="refsect2">
552 <a name="ClutterFlowLayout--column-spacing"></a><h3>The <code class="literal">"column-spacing"</code> property</h3>
553 <pre class="programlisting">  "column-spacing"           <span class="type">gfloat</span>                : Read / Write</pre>
554 <p>
555 The spacing between columns, in pixels; the value of this
556 property is honoured by horizontal non-overflowing layouts
557 and by vertical overflowing layouts
558 </p>
559 <p>Allowed values: &gt;= 0</p>
560 <p>Default value: 0</p>
561 <p class="since">Since 1.2</p>
562 </div>
563 <hr>
564 <div class="refsect2">
565 <a name="ClutterFlowLayout--homogeneous"></a><h3>The <code class="literal">"homogeneous"</code> property</h3>
566 <pre class="programlisting">  "homogeneous"              <span class="type">gboolean</span>              : Read / Write</pre>
567 <p>
568 Whether each child inside the <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a> should receive
569 the same allocation
570 </p>
571 <p>Default value: FALSE</p>
572 <p class="since">Since 1.2</p>
573 </div>
574 <hr>
575 <div class="refsect2">
576 <a name="ClutterFlowLayout--max-column-width"></a><h3>The <code class="literal">"max-column-width"</code> property</h3>
577 <pre class="programlisting">  "max-column-width"         <span class="type">gfloat</span>                : Read / Write</pre>
578 <p>
579 Maximum width for each column in the layout, in pixels. If
580 set to -1 the width will be the maximum child width
581 </p>
582 <p>Allowed values: &gt;= -1</p>
583 <p>Default value: -1</p>
584 <p class="since">Since 1.2</p>
585 </div>
586 <hr>
587 <div class="refsect2">
588 <a name="ClutterFlowLayout--max-row-height"></a><h3>The <code class="literal">"max-row-height"</code> property</h3>
589 <pre class="programlisting">  "max-row-height"           <span class="type">gfloat</span>                : Read / Write</pre>
590 <p>
591 Maximum height for each row in the layout, in pixels. If
592 set to -1 the width will be the maximum child height
593 </p>
594 <p>Allowed values: &gt;= -1</p>
595 <p>Default value: -1</p>
596 <p class="since">Since 1.2</p>
597 </div>
598 <hr>
599 <div class="refsect2">
600 <a name="ClutterFlowLayout--min-column-width"></a><h3>The <code class="literal">"min-column-width"</code> property</h3>
601 <pre class="programlisting">  "min-column-width"         <span class="type">gfloat</span>                : Read / Write</pre>
602 <p>
603 Minimum width for each column in the layout, in pixels
604 </p>
605 <p>Allowed values: &gt;= 0</p>
606 <p>Default value: 0</p>
607 <p class="since">Since 1.2</p>
608 </div>
609 <hr>
610 <div class="refsect2">
611 <a name="ClutterFlowLayout--min-row-height"></a><h3>The <code class="literal">"min-row-height"</code> property</h3>
612 <pre class="programlisting">  "min-row-height"           <span class="type">gfloat</span>                : Read / Write</pre>
613 <p>
614 Minimum height for each row in the layout, in pixels
615 </p>
616 <p>Allowed values: &gt;= 0</p>
617 <p>Default value: 0</p>
618 <p class="since">Since 1.2</p>
619 </div>
620 <hr>
621 <div class="refsect2">
622 <a name="ClutterFlowLayout--orientation"></a><h3>The <code class="literal">"orientation"</code> property</h3>
623 <pre class="programlisting">  "orientation"              <a class="link" href="ClutterFlowLayout.html#ClutterFlowOrientation" title="enum ClutterFlowOrientation"><span class="type">ClutterFlowOrientation</span></a>  : Read / Write / Construct</pre>
624 <p>
625 The orientation of the <a class="link" href="ClutterFlowLayout.html" title="ClutterFlowLayout"><span class="type">ClutterFlowLayout</span></a>. The children
626 of the layout will be layed out following the orientation.
627 </p>
628 <p>
629 This property also controls the overflowing directions
630 </p>
631 <p>Default value: CLUTTER_FLOW_HORIZONTAL</p>
632 <p class="since">Since 1.2</p>
633 </div>
634 <hr>
635 <div class="refsect2">
636 <a name="ClutterFlowLayout--row-spacing"></a><h3>The <code class="literal">"row-spacing"</code> property</h3>
637 <pre class="programlisting">  "row-spacing"              <span class="type">gfloat</span>                : Read / Write</pre>
638 <p>
639 The spacing between rows, in pixels; the value of this
640 property is honoured by vertical non-overflowing layouts and
641 by horizontal overflowing layouts
642 </p>
643 <p>Allowed values: &gt;= 0</p>
644 <p>Default value: 0</p>
645 <p class="since">Since 1.2</p>
646 </div>
647 </div>
648 </div>
649 <div class="footer">
650 <hr>
651           Generated by GTK-Doc V1.18.1</div>
652 </body>
653 </html>