1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>ClutterBoxLayout</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
<link rel="home" href="index.html" title="Clutter Reference Manual">
8
<link rel="up" href="ch04.html" title="Layout managers">
9
<link rel="prev" href="ClutterFlowLayout.html" title="ClutterFlowLayout">
10
<link rel="next" href="clutteranimation.html" title="Part V. Clutter Animation Framework">
11
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="clutter-overview.html" title="Part I. Overview">
14
<link rel="part" href="building-clutter.html" title="Part II. Building Clutter">
15
<link rel="part" href="running-clutter.html" title="Part III. Running Clutter">
16
<link rel="part" href="clutterbase.html" title="Part IV. Clutter Core Reference">
17
<link rel="chapter" href="ch01.html" title="Abstract classes and interfaces">
18
<link rel="chapter" href="ch02.html" title="Base actors">
19
<link rel="chapter" href="ch03.html" title="Container actors">
20
<link rel="chapter" href="ch04.html" title="Layout managers">
21
<link rel="part" href="clutteranimation.html" title="Part V. Clutter Animation Framework">
22
<link rel="chapter" href="ch05.html" title="Base classes">
23
<link rel="chapter" href="ch06.html" title="Behaviours">
24
<link rel="chapter" href="ch07.html" title="High Level API">
25
<link rel="part" href="cluttertools.html" title="Part VI. Clutter Tools">
26
<link rel="chapter" href="ch08.html" title="General purpose API">
27
<link rel="chapter" href="ch09.html" title="User interface definition">
28
<link rel="chapter" href="ch10.html" title="Generic list model">
29
<link rel="part" href="clutterbackends.html" title="Part VII. Clutter Backends">
30
<link rel="part" href="additionaldocs.html" title="Part VIII. Additional Documentation">
31
<link rel="chapter" href="clutter-subclassing-ClutterActor.html" title="Implementing a new actor">
32
<link rel="chapter" href="clutter-animations.html" title="Creating Animations with Clutter">
33
<link rel="chapter" href="creating-your-own-behaviours.html" title="Creating You Own Behaviours">
34
<link rel="part" href="migration.html" title="Part IX. Migrating from previous version of Clutter">
35
<link rel="part" href="pt10.html" title="Part I. ">
36
<link rel="chapter" href="migrating-ClutterEffect.html" title="Migrating from ClutterEffect">
37
<link rel="chapter" href="migrating-ClutterPath.html" title="Migrating to ClutterPath">
38
<link rel="part" href="clutterobjects.html" title="Part X. Clutter Actors and Objects">
39
<link rel="chapter" href="clutterobjecthierarchy.html" title="Object Hierarchy">
40
<link rel="chapter" href="clutterobjectindex.html" title="Object Index">
41
<link rel="part" href="clutterglossary.html" title="Part XI. Glossaries">
42
<link rel="glossary" href="go01.html" title="Glossary">
43
<link rel="glossary" href="annotation-glossary.html" title="Annotation Glossary">
44
<link rel="index" href="ix01.html" title="Index of all symbols">
45
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
46
<link rel="index" href="ix03.html" title="Index of new symbols in 0.2">
47
<link rel="index" href="ix04.html" title="Index of new symbols in 0.4">
48
<link rel="index" href="ix05.html" title="Index of new symbols in 0.6">
49
<link rel="index" href="ix06.html" title="Index of new symbols in 0.8">
50
<link rel="index" href="ix07.html" title="Index of new symbols in 1.0">
51
<link rel="index" href="ix08.html" title="Index of new symbols in 1.2">
52
<link rel="appendix" href="license.html" title="Appendix A. License">
54
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
55
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
57
<td><a accesskey="p" href="ClutterFlowLayout.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
58
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
59
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
60
<th width="100%" align="center">Clutter Reference Manual</th>
61
<td><a accesskey="n" href="clutteranimation.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
63
<tr><td colspan="5" class="shortcuts">
64
<a href="#ClutterBoxLayout.synopsis" class="shortcut">Top</a>
66
<a href="#ClutterBoxLayout.description" class="shortcut">Description</a>
68
<a href="#ClutterBoxLayout.object-hierarchy" class="shortcut">Object Hierarchy</a>
70
<a href="#ClutterBoxLayout.properties" class="shortcut">Properties</a>
73
<div class="refentry" title="ClutterBoxLayout">
74
<a name="ClutterBoxLayout"></a><div class="titlepage"></div>
75
<div class="refnamediv"><table width="100%"><tr>
77
<h2><span class="refentrytitle"><a name="ClutterBoxLayout.top_of_page"></a>ClutterBoxLayout</span></h2>
78
<p>ClutterBoxLayout — A layout manager arranging children on a single line</p>
80
<td valign="top" align="right"></td>
82
<div class="refsynopsisdiv" title="Synopsis">
83
<a name="ClutterBoxLayout.synopsis"></a><h2>Synopsis</h2>
84
<pre class="synopsis">enum <a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment">ClutterBoxAlignment</a>;
85
<a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout-struct" title="ClutterBoxLayout">ClutterBoxLayout</a>;
86
<a class="link" href="ClutterBoxLayout.html#ClutterBoxLayoutClass" title="ClutterBoxLayoutClass">ClutterBoxLayoutClass</a>;
87
<a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="returnvalue">ClutterLayoutManager</span></a> * <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-new" title="clutter_box_layout_new ()">clutter_box_layout_new</a> (void);
88
<span class="returnvalue">void</span> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-pack-start" title="clutter_box_layout_set_pack_start ()">clutter_box_layout_set_pack_start</a> (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
89
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> pack_start);
90
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-get-pack-start" title="clutter_box_layout_get_pack_start ()">clutter_box_layout_get_pack_start</a> (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout);
91
<span class="returnvalue">void</span> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-spacing" title="clutter_box_layout_set_spacing ()">clutter_box_layout_set_spacing</a> (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
92
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> spacing);
93
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-get-spacing" title="clutter_box_layout_get_spacing ()">clutter_box_layout_get_spacing</a> (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout);
94
<span class="returnvalue">void</span> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-vertical" title="clutter_box_layout_set_vertical ()">clutter_box_layout_set_vertical</a> (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
95
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> vertical);
96
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-get-vertical" title="clutter_box_layout_get_vertical ()">clutter_box_layout_get_vertical</a> (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout);
98
<span class="returnvalue">void</span> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-pack" title="clutter_box_layout_pack ()">clutter_box_layout_pack</a> (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
99
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *actor,
100
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> expand,
101
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> x_fill,
102
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> y_fill,
103
<a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment"><span class="returnvalue">ClutterBoxAlignment</span></a> x_align,
104
<a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment"><span class="returnvalue">ClutterBoxAlignment</span></a> y_align);
106
<span class="returnvalue">void</span> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-alignment" title="clutter_box_layout_set_alignment ()">clutter_box_layout_set_alignment</a> (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
107
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *actor,
108
<a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment"><span class="returnvalue">ClutterBoxAlignment</span></a> x_align,
109
<a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment"><span class="returnvalue">ClutterBoxAlignment</span></a> y_align);
110
<span class="returnvalue">void</span> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-get-alignment" title="clutter_box_layout_get_alignment ()">clutter_box_layout_get_alignment</a> (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
111
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *actor,
112
<a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment"><span class="returnvalue">ClutterBoxAlignment</span></a> *x_align,
113
<a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment"><span class="returnvalue">ClutterBoxAlignment</span></a> *y_align);
114
<span class="returnvalue">void</span> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-expand" title="clutter_box_layout_set_expand ()">clutter_box_layout_set_expand</a> (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
115
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *actor,
116
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> expand);
117
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-get-expand" title="clutter_box_layout_get_expand ()">clutter_box_layout_get_expand</a> (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
118
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *actor);
119
<span class="returnvalue">void</span> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-fill" title="clutter_box_layout_set_fill ()">clutter_box_layout_set_fill</a> (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
120
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *actor,
121
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> x_fill,
122
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> y_fill);
123
<span class="returnvalue">void</span> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-get-fill" title="clutter_box_layout_get_fill ()">clutter_box_layout_get_fill</a> (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
124
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *actor,
125
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> *x_fill,
126
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> *y_fill);
128
<span class="returnvalue">void</span> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-use-animations" title="clutter_box_layout_set_use_animations ()">clutter_box_layout_set_use_animations</a>
129
(<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
130
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> animate);
131
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-get-use-animations" title="clutter_box_layout_get_use_animations ()">clutter_box_layout_get_use_animations</a>
132
(<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout);
133
<span class="returnvalue">void</span> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-easing-duration" title="clutter_box_layout_set_easing_duration ()">clutter_box_layout_set_easing_duration</a>
134
(<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
135
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> msecs);
136
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-get-easing-duration" title="clutter_box_layout_get_easing_duration ()">clutter_box_layout_get_easing_duration</a>
137
(<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout);
138
<span class="returnvalue">void</span> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-easing-mode" title="clutter_box_layout_set_easing_mode ()">clutter_box_layout_set_easing_mode</a> (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
139
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="returnvalue">gulong</span></a> mode);
140
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="returnvalue">gulong</span></a> <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-get-easing-mode" title="clutter_box_layout_get_easing_mode ()">clutter_box_layout_get_easing_mode</a> (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout);
143
<div class="refsect1" title="Object Hierarchy">
144
<a name="ClutterBoxLayout.object-hierarchy"></a><h2>Object Hierarchy</h2>
145
<pre class="synopsis">
146
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
147
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
148
+----<a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager">ClutterLayoutManager</a>
149
+----ClutterBoxLayout
152
<div class="refsect1" title="Properties">
153
<a name="ClutterBoxLayout.properties"></a><h2>Properties</h2>
154
<pre class="synopsis">
155
"<a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--easing-duration" title='The "easing-duration" property'>easing-duration</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
156
"<a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--easing-mode" title='The "easing-mode" property'>easing-mode</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> : Read / Write
157
"<a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--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
158
"<a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--spacing" title='The "spacing" property'>spacing</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
159
"<a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--use-animations" title='The "use-animations" property'>use-animations</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
160
"<a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--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
163
<div class="refsect1" title="Description">
164
<a name="ClutterBoxLayout.description"></a><h2>Description</h2>
166
The <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> is a <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> implementing the
167
following layout policy:
169
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
170
<li class="listitem"><p>all children are arranged on a single
172
<li class="listitem"><p>the axis used is controlled by the
173
<a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--vertical" title='The "vertical" property'><span class="type">"vertical"</span></a> boolean property;</p></li>
174
<li class="listitem"><p>the order of the packing is determined by the
175
<a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--pack-start" title='The "pack-start" property'><span class="type">"pack-start"</span></a> boolean property;</p></li>
176
<li class="listitem"><p>each child will be allocated to its natural
177
size or, if set to expand, the available size;</p></li>
178
<li class="listitem"><p>if a child is set to fill on either (or both)
179
axis, its allocation will match all the available size; the
180
fill layout property only makes sense if the expand property is
182
<li class="listitem"><p>if a child is set to expand but not to fill then
183
it is possible to control the alignment using the X and Y alignment
184
layout properties.</p></li>
191
<a name="box-layout"></a><p class="title"><b>Figure 6. Box layout</b></p>
192
<div class="figure-contents">
193
<p>The image shows a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> with the
194
<a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--vertical" title='The "vertical" property'><span class="type">"vertical"</span></a> property set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
195
<div><img src="box-layout.png" alt="Box layout"></div>
198
<p><br class="figure-break">
201
It is possible to control the spacing between children of a
202
<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> by using <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-spacing" title="clutter_box_layout_set_spacing ()"><code class="function">clutter_box_layout_set_spacing()</code></a>.
205
In order to set the layout properties when packing an actor inside a
206
<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> you should use the <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-pack" title="clutter_box_layout_pack ()"><code class="function">clutter_box_layout_pack()</code></a>
210
<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> is available since Clutter 1.2</p>
212
<div class="refsect1" title="Details">
213
<a name="ClutterBoxLayout.details"></a><h2>Details</h2>
214
<div class="refsect2" title="enum ClutterBoxAlignment">
215
<a name="ClutterBoxAlignment"></a><h3>enum ClutterBoxAlignment</h3>
216
<pre class="programlisting">typedef enum {
217
CLUTTER_BOX_ALIGNMENT_START,
218
CLUTTER_BOX_ALIGNMENT_END,
219
CLUTTER_BOX_ALIGNMENT_CENTER
220
} ClutterBoxAlignment;
223
The alignment policies available on each axis of the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p>
224
<div class="variablelist"><table border="0">
225
<col align="left" valign="top">
228
<td><p><a name="CLUTTER-BOX-ALIGNMENT-START:CAPS"></a><span class="term"><code class="literal">CLUTTER_BOX_ALIGNMENT_START</code></span></p></td>
229
<td> Align the child to the top or to
230
to the left, depending on the used axis
234
<td><p><a name="CLUTTER-BOX-ALIGNMENT-END:CAPS"></a><span class="term"><code class="literal">CLUTTER_BOX_ALIGNMENT_END</code></span></p></td>
235
<td> Align the child to the bottom or to
236
the right, depending on the used axis
240
<td><p><a name="CLUTTER-BOX-ALIGNMENT-CENTER:CAPS"></a><span class="term"><code class="literal">CLUTTER_BOX_ALIGNMENT_CENTER</code></span></p></td>
241
<td> Align the child to the center
246
<p class="since">Since 1.2</p>
249
<div class="refsect2" title="ClutterBoxLayout">
250
<a name="ClutterBoxLayout-struct"></a><h3>ClutterBoxLayout</h3>
251
<pre class="programlisting">typedef struct _ClutterBoxLayout ClutterBoxLayout;</pre>
253
The <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> structure contains only private data
254
and should be accessed using the provided API</p>
255
<p class="since">Since 1.2</p>
258
<div class="refsect2" title="ClutterBoxLayoutClass">
259
<a name="ClutterBoxLayoutClass"></a><h3>ClutterBoxLayoutClass</h3>
260
<pre class="programlisting">typedef struct {
261
} ClutterBoxLayoutClass;
264
The <a class="link" href="ClutterBoxLayout.html#ClutterBoxLayoutClass" title="ClutterBoxLayoutClass"><span class="type">ClutterBoxLayoutClass</span></a> structure contains only private
265
data and should be accessed using the provided API</p>
266
<p class="since">Since 1.2</p>
269
<div class="refsect2" title="clutter_box_layout_new ()">
270
<a name="clutter-box-layout-new"></a><h3>clutter_box_layout_new ()</h3>
271
<pre class="programlisting"><a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="returnvalue">ClutterLayoutManager</span></a> * clutter_box_layout_new (void);</pre>
273
Creates a new <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> layout manager</p>
274
<div class="variablelist"><table border="0">
275
<col align="left" valign="top">
277
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
278
<td> the newly created <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
283
<p class="since">Since 1.2</p>
286
<div class="refsect2" title="clutter_box_layout_set_pack_start ()">
287
<a name="clutter-box-layout-set-pack-start"></a><h3>clutter_box_layout_set_pack_start ()</h3>
288
<pre class="programlisting"><span class="returnvalue">void</span> clutter_box_layout_set_pack_start (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
289
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> pack_start);</pre>
291
Sets whether children of <em class="parameter"><code>layout</code></em> should be layed out by appending
292
them or by prepending them</p>
293
<div class="variablelist"><table border="0">
294
<col align="left" valign="top">
297
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
298
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
302
<td><p><span class="term"><em class="parameter"><code>pack_start</code></em> :</span></p></td>
303
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <em class="parameter"><code>layout</code></em> should pack children at the
304
beginning of the layout
309
<p class="since">Since 1.2</p>
312
<div class="refsect2" title="clutter_box_layout_get_pack_start ()">
313
<a name="clutter-box-layout-get-pack-start"></a><h3>clutter_box_layout_get_pack_start ()</h3>
314
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> clutter_box_layout_get_pack_start (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout);</pre>
316
Retrieves the value set using <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-pack-start" title="clutter_box_layout_set_pack_start ()"><code class="function">clutter_box_layout_set_pack_start()</code></a></p>
317
<div class="variablelist"><table border="0">
318
<col align="left" valign="top">
321
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
322
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
326
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
327
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> should pack children
328
at the beginning of the layout, and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise
334
<p class="since">Since 1.2</p>
337
<div class="refsect2" title="clutter_box_layout_set_spacing ()">
338
<a name="clutter-box-layout-set-spacing"></a><h3>clutter_box_layout_set_spacing ()</h3>
339
<pre class="programlisting"><span class="returnvalue">void</span> clutter_box_layout_set_spacing (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
340
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> spacing);</pre>
342
Sets the spacing between children of <em class="parameter"><code>layout</code></em></p>
343
<div class="variablelist"><table border="0">
344
<col align="left" valign="top">
347
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
348
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
352
<td><p><span class="term"><em class="parameter"><code>spacing</code></em> :</span></p></td>
353
<td> the spacing between children of the layout, in pixels
358
<p class="since">Since 1.2</p>
361
<div class="refsect2" title="clutter_box_layout_get_spacing ()">
362
<a name="clutter-box-layout-get-spacing"></a><h3>clutter_box_layout_get_spacing ()</h3>
363
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> clutter_box_layout_get_spacing (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout);</pre>
365
Retrieves the spacing set using <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-spacing" title="clutter_box_layout_set_spacing ()"><code class="function">clutter_box_layout_set_spacing()</code></a></p>
366
<div class="variablelist"><table border="0">
367
<col align="left" valign="top">
370
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
371
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
375
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
376
<td> the spacing between children of the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
382
<p class="since">Since 1.2</p>
385
<div class="refsect2" title="clutter_box_layout_set_vertical ()">
386
<a name="clutter-box-layout-set-vertical"></a><h3>clutter_box_layout_set_vertical ()</h3>
387
<pre class="programlisting"><span class="returnvalue">void</span> clutter_box_layout_set_vertical (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
388
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> vertical);</pre>
390
Sets whether <em class="parameter"><code>layout</code></em> should arrange its children vertically alongside
391
the Y axis, instead of horizontally alongside the X axis</p>
392
<div class="variablelist"><table border="0">
393
<col align="left" valign="top">
396
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
397
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
401
<td><p><span class="term"><em class="parameter"><code>vertical</code></em> :</span></p></td>
402
<td> <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
407
<p class="since">Since 1.2</p>
410
<div class="refsect2" title="clutter_box_layout_get_vertical ()">
411
<a name="clutter-box-layout-get-vertical"></a><h3>clutter_box_layout_get_vertical ()</h3>
412
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> clutter_box_layout_get_vertical (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout);</pre>
414
Retrieves the orientation of the <em class="parameter"><code>layout</code></em> as set using the
415
<a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-vertical" title="clutter_box_layout_set_vertical ()"><code class="function">clutter_box_layout_set_vertical()</code></a> function</p>
416
<div class="variablelist"><table border="0">
417
<col align="left" valign="top">
420
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
421
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
425
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
426
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> is arranging its children
427
vertically, and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise
433
<p class="since">Since 1.2</p>
436
<div class="refsect2" title="clutter_box_layout_pack ()">
437
<a name="clutter-box-layout-pack"></a><h3>clutter_box_layout_pack ()</h3>
438
<pre class="programlisting"><span class="returnvalue">void</span> clutter_box_layout_pack (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
439
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *actor,
440
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> expand,
441
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> x_fill,
442
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> y_fill,
443
<a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment"><span class="returnvalue">ClutterBoxAlignment</span></a> x_align,
444
<a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment"><span class="returnvalue">ClutterBoxAlignment</span></a> y_align);</pre>
446
Packs <em class="parameter"><code>actor</code></em> inside the <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> associated to <em class="parameter"><code>layout</code></em>
447
and sets the layout properties</p>
448
<div class="variablelist"><table border="0">
449
<col align="left" valign="top">
452
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
453
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
457
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
458
<td> a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>
462
<td><p><span class="term"><em class="parameter"><code>expand</code></em> :</span></p></td>
463
<td> whether the <em class="parameter"><code>actor</code></em> should expand
467
<td><p><span class="term"><em class="parameter"><code>x_fill</code></em> :</span></p></td>
468
<td> whether the <em class="parameter"><code>actor</code></em> should fill horizontally
472
<td><p><span class="term"><em class="parameter"><code>y_fill</code></em> :</span></p></td>
473
<td> whether the <em class="parameter"><code>actor</code></em> should fill vertically
477
<td><p><span class="term"><em class="parameter"><code>x_align</code></em> :</span></p></td>
478
<td> the horizontal alignment policy for <em class="parameter"><code>actor</code></em>
482
<td><p><span class="term"><em class="parameter"><code>y_align</code></em> :</span></p></td>
483
<td> the vertical alignment policy for <em class="parameter"><code>actor</code></em>
488
<p class="since">Since 1.2</p>
491
<div class="refsect2" title="clutter_box_layout_set_alignment ()">
492
<a name="clutter-box-layout-set-alignment"></a><h3>clutter_box_layout_set_alignment ()</h3>
493
<pre class="programlisting"><span class="returnvalue">void</span> clutter_box_layout_set_alignment (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
494
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *actor,
495
<a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment"><span class="returnvalue">ClutterBoxAlignment</span></a> x_align,
496
<a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment"><span class="returnvalue">ClutterBoxAlignment</span></a> y_align);</pre>
498
Sets the horizontal and vertical alignment policies for <em class="parameter"><code>actor</code></em>
499
inside <em class="parameter"><code>layout</code></em></p>
500
<div class="variablelist"><table border="0">
501
<col align="left" valign="top">
504
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
505
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
509
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
510
<td> a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> child of <em class="parameter"><code>layout</code></em>
514
<td><p><span class="term"><em class="parameter"><code>x_align</code></em> :</span></p></td>
515
<td> Horizontal alignment policy for <em class="parameter"><code>actor</code></em>
519
<td><p><span class="term"><em class="parameter"><code>y_align</code></em> :</span></p></td>
520
<td> Vertical alignment policy for <em class="parameter"><code>actor</code></em>
525
<p class="since">Since 1.2</p>
528
<div class="refsect2" title="clutter_box_layout_get_alignment ()">
529
<a name="clutter-box-layout-get-alignment"></a><h3>clutter_box_layout_get_alignment ()</h3>
530
<pre class="programlisting"><span class="returnvalue">void</span> clutter_box_layout_get_alignment (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
531
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *actor,
532
<a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment"><span class="returnvalue">ClutterBoxAlignment</span></a> *x_align,
533
<a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment"><span class="returnvalue">ClutterBoxAlignment</span></a> *y_align);</pre>
535
Retrieves the horizontal and vertical alignment policies for <em class="parameter"><code>actor</code></em>
536
as set using <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-pack" title="clutter_box_layout_pack ()"><code class="function">clutter_box_layout_pack()</code></a> or <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-alignment" title="clutter_box_layout_set_alignment ()"><code class="function">clutter_box_layout_set_alignment()</code></a></p>
537
<div class="variablelist"><table border="0">
538
<col align="left" valign="top">
541
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
542
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
546
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
547
<td> a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> child of <em class="parameter"><code>layout</code></em>
551
<td><p><span class="term"><em class="parameter"><code>x_align</code></em> :</span></p></td>
552
<td> return location for the horizontal alignment policy. <acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>. </td>
555
<td><p><span class="term"><em class="parameter"><code>y_align</code></em> :</span></p></td>
556
<td> return location for the vertical alignment policy. <acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>. </td>
560
<p class="since">Since 1.2</p>
563
<div class="refsect2" title="clutter_box_layout_set_expand ()">
564
<a name="clutter-box-layout-set-expand"></a><h3>clutter_box_layout_set_expand ()</h3>
565
<pre class="programlisting"><span class="returnvalue">void</span> clutter_box_layout_set_expand (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
566
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *actor,
567
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> expand);</pre>
569
Sets whether <em class="parameter"><code>actor</code></em> should expand inside <em class="parameter"><code>layout</code></em></p>
570
<div class="variablelist"><table border="0">
571
<col align="left" valign="top">
574
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
575
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
579
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
580
<td> a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> child of <em class="parameter"><code>layout</code></em>
584
<td><p><span class="term"><em class="parameter"><code>expand</code></em> :</span></p></td>
585
<td> whether <em class="parameter"><code>actor</code></em> should expand
590
<p class="since">Since 1.2</p>
593
<div class="refsect2" title="clutter_box_layout_get_expand ()">
594
<a name="clutter-box-layout-get-expand"></a><h3>clutter_box_layout_get_expand ()</h3>
595
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> clutter_box_layout_get_expand (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
596
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *actor);</pre>
598
Retrieves whether <em class="parameter"><code>actor</code></em> should expand inside <em class="parameter"><code>layout</code></em></p>
599
<div class="variablelist"><table border="0">
600
<col align="left" valign="top">
603
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
604
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
608
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
609
<td> a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> child of <em class="parameter"><code>layout</code></em>
613
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
614
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> should expand, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise
620
<p class="since">Since 1.2</p>
623
<div class="refsect2" title="clutter_box_layout_set_fill ()">
624
<a name="clutter-box-layout-set-fill"></a><h3>clutter_box_layout_set_fill ()</h3>
625
<pre class="programlisting"><span class="returnvalue">void</span> clutter_box_layout_set_fill (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
626
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *actor,
627
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> x_fill,
628
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> y_fill);</pre>
630
Sets the horizontal and vertical fill policies for <em class="parameter"><code>actor</code></em>
631
inside <em class="parameter"><code>layout</code></em></p>
632
<div class="variablelist"><table border="0">
633
<col align="left" valign="top">
636
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
637
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
641
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
642
<td> a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> child of <em class="parameter"><code>layout</code></em>
646
<td><p><span class="term"><em class="parameter"><code>x_fill</code></em> :</span></p></td>
647
<td> whether <em class="parameter"><code>actor</code></em> should fill horizontally the allocated space
651
<td><p><span class="term"><em class="parameter"><code>y_fill</code></em> :</span></p></td>
652
<td> whether <em class="parameter"><code>actor</code></em> should fill vertically the allocated space
657
<p class="since">Since 1.2</p>
660
<div class="refsect2" title="clutter_box_layout_get_fill ()">
661
<a name="clutter-box-layout-get-fill"></a><h3>clutter_box_layout_get_fill ()</h3>
662
<pre class="programlisting"><span class="returnvalue">void</span> clutter_box_layout_get_fill (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
663
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *actor,
664
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> *x_fill,
665
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> *y_fill);</pre>
667
Retrieves the horizontal and vertical fill policies for <em class="parameter"><code>actor</code></em>
668
as set using <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-pack" title="clutter_box_layout_pack ()"><code class="function">clutter_box_layout_pack()</code></a> or <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-fill" title="clutter_box_layout_set_fill ()"><code class="function">clutter_box_layout_set_fill()</code></a></p>
669
<div class="variablelist"><table border="0">
670
<col align="left" valign="top">
673
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
674
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
678
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
679
<td> a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> child of <em class="parameter"><code>layout</code></em>
683
<td><p><span class="term"><em class="parameter"><code>x_fill</code></em> :</span></p></td>
684
<td> return location for the horizontal fill policy. <acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>. </td>
687
<td><p><span class="term"><em class="parameter"><code>y_fill</code></em> :</span></p></td>
688
<td> return location for the vertical fill policy. <acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>. </td>
692
<p class="since">Since 1.2</p>
695
<div class="refsect2" title="clutter_box_layout_set_use_animations ()">
696
<a name="clutter-box-layout-set-use-animations"></a><h3>clutter_box_layout_set_use_animations ()</h3>
697
<pre class="programlisting"><span class="returnvalue">void</span> clutter_box_layout_set_use_animations
698
(<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
699
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> animate);</pre>
701
Sets whether <em class="parameter"><code>layout</code></em> should animate changes in the layout properties
704
The duration of the animations is controlled by
705
<a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-easing-duration" title="clutter_box_layout_set_easing_duration ()"><code class="function">clutter_box_layout_set_easing_duration()</code></a>; the easing mode to be used
706
by the animations is controlled by <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-easing-mode" title="clutter_box_layout_set_easing_mode ()"><code class="function">clutter_box_layout_set_easing_mode()</code></a></p>
707
<div class="variablelist"><table border="0">
708
<col align="left" valign="top">
711
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
712
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
716
<td><p><span class="term"><em class="parameter"><code>animate</code></em> :</span></p></td>
717
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <em class="parameter"><code>layout</code></em> should use animations
722
<p class="since">Since 1.2</p>
725
<div class="refsect2" title="clutter_box_layout_get_use_animations ()">
726
<a name="clutter-box-layout-get-use-animations"></a><h3>clutter_box_layout_get_use_animations ()</h3>
727
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> clutter_box_layout_get_use_animations
728
(<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout);</pre>
730
Retrieves whether <em class="parameter"><code>layout</code></em> should animate changes in the layout properties
733
Since <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-use-animations" title="clutter_box_layout_set_use_animations ()"><code class="function">clutter_box_layout_set_use_animations()</code></a></p>
734
<div class="variablelist"><table border="0">
735
<col align="left" valign="top">
738
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
739
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
743
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
744
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the animations should be used, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise
750
<p class="since">Since 1.2</p>
753
<div class="refsect2" title="clutter_box_layout_set_easing_duration ()">
754
<a name="clutter-box-layout-set-easing-duration"></a><h3>clutter_box_layout_set_easing_duration ()</h3>
755
<pre class="programlisting"><span class="returnvalue">void</span> clutter_box_layout_set_easing_duration
756
(<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
757
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> msecs);</pre>
759
Sets the duration of the animations used by <em class="parameter"><code>layout</code></em> when animating changes
760
in the layout properties
763
Use <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-use-animations" title="clutter_box_layout_set_use_animations ()"><code class="function">clutter_box_layout_set_use_animations()</code></a> to enable and disable the
765
<div class="variablelist"><table border="0">
766
<col align="left" valign="top">
769
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
770
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
774
<td><p><span class="term"><em class="parameter"><code>msecs</code></em> :</span></p></td>
775
<td> the duration of the animations, in milliseconds
780
<p class="since">Since 1.2</p>
783
<div class="refsect2" title="clutter_box_layout_get_easing_duration ()">
784
<a name="clutter-box-layout-get-easing-duration"></a><h3>clutter_box_layout_get_easing_duration ()</h3>
785
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> clutter_box_layout_get_easing_duration
786
(<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout);</pre>
788
Retrieves the duration set using <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-easing-duration" title="clutter_box_layout_set_easing_duration ()"><code class="function">clutter_box_layout_set_easing_duration()</code></a></p>
789
<div class="variablelist"><table border="0">
790
<col align="left" valign="top">
793
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
794
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
798
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
799
<td> the duration of the animations, in milliseconds
805
<p class="since">Since 1.2</p>
808
<div class="refsect2" title="clutter_box_layout_set_easing_mode ()">
809
<a name="clutter-box-layout-set-easing-mode"></a><h3>clutter_box_layout_set_easing_mode ()</h3>
810
<pre class="programlisting"><span class="returnvalue">void</span> clutter_box_layout_set_easing_mode (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout,
811
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="returnvalue">gulong</span></a> mode);</pre>
813
Sets the easing mode to be used by <em class="parameter"><code>layout</code></em> when animating changes in layout
817
Use <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-use-animations" title="clutter_box_layout_set_use_animations ()"><code class="function">clutter_box_layout_set_use_animations()</code></a> to enable and disable the
819
<div class="variablelist"><table border="0">
820
<col align="left" valign="top">
823
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
824
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
828
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
829
<td> an easing mode, either from <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a> or a logical id
830
from <a class="link" href="ClutterAlpha.html#clutter-alpha-register-func" title="clutter_alpha_register_func ()"><code class="function">clutter_alpha_register_func()</code></a>
835
<p class="since">Since 1.2</p>
838
<div class="refsect2" title="clutter_box_layout_get_easing_mode ()">
839
<a name="clutter-box-layout-get-easing-mode"></a><h3>clutter_box_layout_get_easing_mode ()</h3>
840
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="returnvalue">gulong</span></a> clutter_box_layout_get_easing_mode (<a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="returnvalue">ClutterBoxLayout</span></a> *layout);</pre>
842
Retrieves the easing mode set using <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-easing-mode" title="clutter_box_layout_set_easing_mode ()"><code class="function">clutter_box_layout_set_easing_mode()</code></a></p>
843
<div class="variablelist"><table border="0">
844
<col align="left" valign="top">
847
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
848
<td> a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>
852
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
859
<p class="since">Since 1.2</p>
862
<div class="refsect1" title="Property Details">
863
<a name="ClutterBoxLayout.property-details"></a><h2>Property Details</h2>
864
<div class="refsect2" title='The "easing-duration" property'>
865
<a name="ClutterBoxLayout--easing-duration"></a><h3>The <code class="literal">"easing-duration"</code> property</h3>
866
<pre class="programlisting"> "easing-duration" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
868
The duration of the animations, in case <a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--use-animations" title='The "use-animations" property'><span class="type">"use-animations"</span></a>
869
is set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>
872
The duration is expressed in milliseconds</p>
873
<p>Default value: 500</p>
874
<p class="since">Since 1.2</p>
877
<div class="refsect2" title='The "easing-mode" property'>
878
<a name="ClutterBoxLayout--easing-mode"></a><h3>The <code class="literal">"easing-mode"</code> property</h3>
879
<pre class="programlisting"> "easing-mode" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> : Read / Write</pre>
881
The easing mode for the animations, in case
882
<a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--use-animations" title='The "use-animations" property'><span class="type">"use-animations"</span></a> is set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>
885
The easing mode has the same semantics of <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation--mode" title='The "mode" property'><span class="type">"mode"</span></a>: it can
886
either be a value from the <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a> enumeration, like
887
<a class="link" href="clutter-Implicit-Animations.html#CLUTTER-EASE-OUT-CUBIC:CAPS"><code class="literal">CLUTTER_EASE_OUT_CUBIC</code></a>, or a logical id as returned by
888
<a class="link" href="ClutterAlpha.html#clutter-alpha-register-func" title="clutter_alpha_register_func ()"><code class="function">clutter_alpha_register_func()</code></a>
891
The default value is <a class="link" href="clutter-Implicit-Animations.html#CLUTTER-EASE-OUT-CUBIC:CAPS"><code class="literal">CLUTTER_EASE_OUT_CUBIC</code></a></p>
892
<p class="since">Since 1.2</p>
895
<div class="refsect2" title='The "pack-start" property'>
896
<a name="ClutterBoxLayout--pack-start"></a><h3>The <code class="literal">"pack-start"</code> property</h3>
897
<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>
899
Whether the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> should pack items at the start
900
or append them at the end</p>
901
<p>Default value: FALSE</p>
902
<p class="since">Since 1.2</p>
905
<div class="refsect2" title='The "spacing" property'>
906
<a name="ClutterBoxLayout--spacing"></a><h3>The <code class="literal">"spacing"</code> property</h3>
907
<pre class="programlisting"> "spacing" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
909
The spacing between children of the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>, in pixels</p>
910
<p>Default value: 0</p>
911
<p class="since">Since 1.2</p>
914
<div class="refsect2" title='The "use-animations" property'>
915
<a name="ClutterBoxLayout--use-animations"></a><h3>The <code class="literal">"use-animations"</code> property</h3>
916
<pre class="programlisting"> "use-animations" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
918
Whether the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> should animate changes in the
919
layout properties</p>
920
<p>Default value: FALSE</p>
921
<p class="since">Since 1.2</p>
924
<div class="refsect2" title='The "vertical" property'>
925
<a name="ClutterBoxLayout--vertical"></a><h3>The <code class="literal">"vertical"</code> property</h3>
926
<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>
928
Whether the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> should arrange its children
929
alongside the Y axis, instead of alongside the X axis</p>
930
<p>Default value: FALSE</p>
931
<p class="since">Since 1.2</p>
937
Generated by GTK-Doc V1.13</div>
b'\\ No newline at end of file'
added
removed
doc/reference/clutter/html/ClutterBoxLayout.html
