12e76e43b2af0d81bab270ef8adfe6866af487e3
[profile/ivi/clutter.git] / doc / reference / clutter / html / ClutterAlignConstraint.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>ClutterAlignConstraint</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="ch05.html" title="Constraints">
9 <link rel="prev" href="ch05.html" title="Constraints">
10 <link rel="next" href="ClutterBindConstraint.html" title="ClutterBindConstraint">
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="ch05.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch05.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="ClutterBindConstraint.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="#ClutterAlignConstraint.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#ClutterAlignConstraint.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#ClutterAlignConstraint.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#ClutterAlignConstraint.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry">
34 <a name="ClutterAlignConstraint"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
36 <td valign="top">
37 <h2><span class="refentrytitle"><a name="ClutterAlignConstraint.top_of_page"></a>ClutterAlignConstraint</span></h2>
38 <p>ClutterAlignConstraint — A constraint aligning the position of an actor</p>
39 </td>
40 <td valign="top" align="right"></td>
41 </tr></table></div>
42 <div class="refsynopsisdiv">
43 <a name="ClutterAlignConstraint.synopsis"></a><h2>Synopsis</h2>
44 <pre class="synopsis">                    <a class="link" href="ClutterAlignConstraint.html#ClutterAlignConstraint-struct" title="ClutterAlignConstraint">ClutterAlignConstraint</a>;
45 enum                <a class="link" href="ClutterAlignConstraint.html#ClutterAlignAxis" title="enum ClutterAlignAxis">ClutterAlignAxis</a>;
46 <a class="link" href="ClutterConstraint.html" title="ClutterConstraint"><span class="returnvalue">ClutterConstraint</span></a> * <a class="link" href="ClutterAlignConstraint.html#clutter-align-constraint-new" title="clutter_align_constraint_new ()">clutter_align_constraint_new</a>        (<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *source</code></em>,
47                                                          <em class="parameter"><code><a class="link" href="ClutterAlignConstraint.html#ClutterAlignAxis" title="enum ClutterAlignAxis"><span class="type">ClutterAlignAxis</span></a> axis</code></em>,
48                                                          <em class="parameter"><code><span class="type">gfloat</span> factor</code></em>);
49 <span class="returnvalue">void</span>                <a class="link" href="ClutterAlignConstraint.html#clutter-align-constraint-set-source" title="clutter_align_constraint_set_source ()">clutter_align_constraint_set_source</a> (<em class="parameter"><code><a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a> *align</code></em>,
50                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *source</code></em>);
51 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="ClutterAlignConstraint.html#clutter-align-constraint-get-source" title="clutter_align_constraint_get_source ()">clutter_align_constraint_get_source</a> (<em class="parameter"><code><a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a> *align</code></em>);
52 <span class="returnvalue">void</span>                <a class="link" href="ClutterAlignConstraint.html#clutter-align-constraint-set-align-axis" title="clutter_align_constraint_set_align_axis ()">clutter_align_constraint_set_align_axis</a>
53                                                         (<em class="parameter"><code><a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a> *align</code></em>,
54                                                          <em class="parameter"><code><a class="link" href="ClutterAlignConstraint.html#ClutterAlignAxis" title="enum ClutterAlignAxis"><span class="type">ClutterAlignAxis</span></a> axis</code></em>);
55 <a class="link" href="ClutterAlignConstraint.html#ClutterAlignAxis" title="enum ClutterAlignAxis"><span class="returnvalue">ClutterAlignAxis</span></a>    <a class="link" href="ClutterAlignConstraint.html#clutter-align-constraint-get-align-axis" title="clutter_align_constraint_get_align_axis ()">clutter_align_constraint_get_align_axis</a>
56                                                         (<em class="parameter"><code><a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a> *align</code></em>);
57 <span class="returnvalue">void</span>                <a class="link" href="ClutterAlignConstraint.html#clutter-align-constraint-set-factor" title="clutter_align_constraint_set_factor ()">clutter_align_constraint_set_factor</a> (<em class="parameter"><code><a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a> *align</code></em>,
58                                                          <em class="parameter"><code><span class="type">gfloat</span> factor</code></em>);
59 <span class="returnvalue">gfloat</span>              <a class="link" href="ClutterAlignConstraint.html#clutter-align-constraint-get-factor" title="clutter_align_constraint_get_factor ()">clutter_align_constraint_get_factor</a> (<em class="parameter"><code><a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a> *align</code></em>);
60 </pre>
61 </div>
62 <div class="refsect1">
63 <a name="ClutterAlignConstraint.object-hierarchy"></a><h2>Object Hierarchy</h2>
64 <pre class="synopsis">
65   GObject
66    +----GInitiallyUnowned
67          +----<a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta">ClutterActorMeta</a>
68                +----<a class="link" href="ClutterConstraint.html" title="ClutterConstraint">ClutterConstraint</a>
69                      +----ClutterAlignConstraint
70 </pre>
71 </div>
72 <div class="refsect1">
73 <a name="ClutterAlignConstraint.properties"></a><h2>Properties</h2>
74 <pre class="synopsis">
75   "<a class="link" href="ClutterAlignConstraint.html#ClutterAlignConstraint--align-axis" title='The "align-axis" property'>align-axis</a>"               <a class="link" href="ClutterAlignConstraint.html#ClutterAlignAxis" title="enum ClutterAlignAxis"><span class="type">ClutterAlignAxis</span></a>      : Read / Write / Construct
76   "<a class="link" href="ClutterAlignConstraint.html#ClutterAlignConstraint--factor" title='The "factor" property'>factor</a>"                   <span class="type">gfloat</span>                : Read / Write / Construct
77   "<a class="link" href="ClutterAlignConstraint.html#ClutterAlignConstraint--source" title='The "source" property'>source</a>"                   <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>*         : Read / Write / Construct
78 </pre>
79 </div>
80 <div class="refsect1">
81 <a name="ClutterAlignConstraint.description"></a><h2>Description</h2>
82 <p>
83 <a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a> is a <a class="link" href="ClutterConstraint.html" title="ClutterConstraint"><span class="type">ClutterConstraint</span></a> that aligns the position
84 of the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to which it is applied to the size of another
85 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> using an alignment factor
86 </p>
87 <p>
88 <a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a> is available since Clutter 1.4
89 </p>
90 </div>
91 <div class="refsect1">
92 <a name="ClutterAlignConstraint.details"></a><h2>Details</h2>
93 <div class="refsect2">
94 <a name="ClutterAlignConstraint-struct"></a><h3>ClutterAlignConstraint</h3>
95 <pre class="programlisting">typedef struct _ClutterAlignConstraint ClutterAlignConstraint;</pre>
96 <p>
97 <span class="structname">ClutterAlignConstraint</span> is an opaque structure
98 whose members cannot be directly accesses
99 </p>
100 <p class="since">Since 1.4</p>
101 </div>
102 <hr>
103 <div class="refsect2">
104 <a name="ClutterAlignAxis"></a><h3>enum ClutterAlignAxis</h3>
105 <pre class="programlisting">typedef enum {
106  /*&lt; prefix=CLUTTER_ALIGN &gt;*/
107   CLUTTER_ALIGN_X_AXIS,
108   CLUTTER_ALIGN_Y_AXIS,
109   CLUTTER_ALIGN_BOTH
110 } ClutterAlignAxis;
111 </pre>
112 <p>
113 Specifies the axis on which <a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a> should maintain
114 the alignment.
115 </p>
116 <div class="variablelist"><table border="0">
117 <col align="left" valign="top">
118 <tbody>
119 <tr>
120 <td><p><a name="CLUTTER-ALIGN-X-AXIS:CAPS"></a><span class="term"><code class="literal">CLUTTER_ALIGN_X_AXIS</code></span></p></td>
121 <td>Maintain the alignment on the X axis
122 </td>
123 </tr>
124 <tr>
125 <td><p><a name="CLUTTER-ALIGN-Y-AXIS:CAPS"></a><span class="term"><code class="literal">CLUTTER_ALIGN_Y_AXIS</code></span></p></td>
126 <td>Maintain the alignment on the Y axis
127 </td>
128 </tr>
129 <tr>
130 <td><p><a name="CLUTTER-ALIGN-BOTH:CAPS"></a><span class="term"><code class="literal">CLUTTER_ALIGN_BOTH</code></span></p></td>
131 <td>Maintain the alignment on both the X and Y axis
132 </td>
133 </tr>
134 </tbody>
135 </table></div>
136 <p class="since">Since 1.4</p>
137 </div>
138 <hr>
139 <div class="refsect2">
140 <a name="clutter-align-constraint-new"></a><h3>clutter_align_constraint_new ()</h3>
141 <pre class="programlisting"><a class="link" href="ClutterConstraint.html" title="ClutterConstraint"><span class="returnvalue">ClutterConstraint</span></a> * clutter_align_constraint_new        (<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *source</code></em>,
142                                                          <em class="parameter"><code><a class="link" href="ClutterAlignConstraint.html#ClutterAlignAxis" title="enum ClutterAlignAxis"><span class="type">ClutterAlignAxis</span></a> axis</code></em>,
143                                                          <em class="parameter"><code><span class="type">gfloat</span> factor</code></em>);</pre>
144 <p>
145 Creates a new constraint, aligning a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>'s position with
146 regards of the size of the actor to <em class="parameter"><code>source</code></em>, with the given
147 alignment <em class="parameter"><code>factor</code></em>
148 </p>
149 <div class="variablelist"><table border="0">
150 <col align="left" valign="top">
151 <tbody>
152 <tr>
153 <td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
154 <td>the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to use as the source of the
155 alignment, 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="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
156 </td>
157 </tr>
158 <tr>
159 <td><p><span class="term"><em class="parameter"><code>axis</code></em> :</span></p></td>
160 <td>the axis to be used to compute the alignment</td>
161 </tr>
162 <tr>
163 <td><p><span class="term"><em class="parameter"><code>factor</code></em> :</span></p></td>
164 <td>the alignment factor, between 0.0 and 1.0</td>
165 </tr>
166 <tr>
167 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
168 <td>the newly created <a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a>
169 </td>
170 </tr>
171 </tbody>
172 </table></div>
173 <p class="since">Since 1.4</p>
174 </div>
175 <hr>
176 <div class="refsect2">
177 <a name="clutter-align-constraint-set-source"></a><h3>clutter_align_constraint_set_source ()</h3>
178 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_align_constraint_set_source (<em class="parameter"><code><a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a> *align</code></em>,
179                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *source</code></em>);</pre>
180 <p>
181 Sets the source of the alignment constraint
182 </p>
183 <div class="variablelist"><table border="0">
184 <col align="left" valign="top">
185 <tbody>
186 <tr>
187 <td><p><span class="term"><em class="parameter"><code>align</code></em> :</span></p></td>
188 <td>a <a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a>
189 </td>
190 </tr>
191 <tr>
192 <td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
193 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to unset the source. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
194 </td>
195 </tr>
196 </tbody>
197 </table></div>
198 <p class="since">Since 1.4</p>
199 </div>
200 <hr>
201 <div class="refsect2">
202 <a name="clutter-align-constraint-get-source"></a><h3>clutter_align_constraint_get_source ()</h3>
203 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_align_constraint_get_source (<em class="parameter"><code><a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a> *align</code></em>);</pre>
204 <p>
205 Retrieves the source of the alignment
206 </p>
207 <div class="variablelist"><table border="0">
208 <col align="left" valign="top">
209 <tbody>
210 <tr>
211 <td><p><span class="term"><em class="parameter"><code>align</code></em> :</span></p></td>
212 <td>a <a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a>
213 </td>
214 </tr>
215 <tr>
216 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
217 <td>the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> used as the source
218 of the alignment. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
219 </td>
220 </tr>
221 </tbody>
222 </table></div>
223 <p class="since">Since 1.4</p>
224 </div>
225 <hr>
226 <div class="refsect2">
227 <a name="clutter-align-constraint-set-align-axis"></a><h3>clutter_align_constraint_set_align_axis ()</h3>
228 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_align_constraint_set_align_axis
229                                                         (<em class="parameter"><code><a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a> *align</code></em>,
230                                                          <em class="parameter"><code><a class="link" href="ClutterAlignConstraint.html#ClutterAlignAxis" title="enum ClutterAlignAxis"><span class="type">ClutterAlignAxis</span></a> axis</code></em>);</pre>
231 <p>
232 Sets the axis to which the alignment refers to
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>align</code></em> :</span></p></td>
239 <td>a <a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a>
240 </td>
241 </tr>
242 <tr>
243 <td><p><span class="term"><em class="parameter"><code>axis</code></em> :</span></p></td>
244 <td>the axis to which the alignment refers to</td>
245 </tr>
246 </tbody>
247 </table></div>
248 <p class="since">Since 1.4</p>
249 </div>
250 <hr>
251 <div class="refsect2">
252 <a name="clutter-align-constraint-get-align-axis"></a><h3>clutter_align_constraint_get_align_axis ()</h3>
253 <pre class="programlisting"><a class="link" href="ClutterAlignConstraint.html#ClutterAlignAxis" title="enum ClutterAlignAxis"><span class="returnvalue">ClutterAlignAxis</span></a>    clutter_align_constraint_get_align_axis
254                                                         (<em class="parameter"><code><a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a> *align</code></em>);</pre>
255 <p>
256 Retrieves the value set using <a class="link" href="ClutterAlignConstraint.html#clutter-align-constraint-set-align-axis" title="clutter_align_constraint_set_align_axis ()"><code class="function">clutter_align_constraint_set_align_axis()</code></a>
257 </p>
258 <div class="variablelist"><table border="0">
259 <col align="left" valign="top">
260 <tbody>
261 <tr>
262 <td><p><span class="term"><em class="parameter"><code>align</code></em> :</span></p></td>
263 <td>a <a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a>
264 </td>
265 </tr>
266 <tr>
267 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
268 <td>the alignment axis</td>
269 </tr>
270 </tbody>
271 </table></div>
272 <p class="since">Since 1.4</p>
273 </div>
274 <hr>
275 <div class="refsect2">
276 <a name="clutter-align-constraint-set-factor"></a><h3>clutter_align_constraint_set_factor ()</h3>
277 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_align_constraint_set_factor (<em class="parameter"><code><a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a> *align</code></em>,
278                                                          <em class="parameter"><code><span class="type">gfloat</span> factor</code></em>);</pre>
279 <p>
280 Sets the alignment factor of the constraint
281 </p>
282 <p>
283 The factor depends on the <a class="link" href="ClutterAlignConstraint.html#ClutterAlignConstraint--align-axis" title='The "align-axis" property'><span class="type">"align-axis"</span></a> property
284 and it is a value between 0.0 (meaning left, when
285 <a class="link" href="ClutterAlignConstraint.html#ClutterAlignConstraint--align-axis" title='The "align-axis" property'><span class="type">"align-axis"</span></a> is set to <a class="link" href="ClutterAlignConstraint.html#CLUTTER-ALIGN-X-AXIS:CAPS"><code class="literal">CLUTTER_ALIGN_X_AXIS</code></a>; or
286 meaning top, when <a class="link" href="ClutterAlignConstraint.html#ClutterAlignConstraint--align-axis" title='The "align-axis" property'><span class="type">"align-axis"</span></a> is set to
287 <a class="link" href="ClutterAlignConstraint.html#CLUTTER-ALIGN-Y-AXIS:CAPS"><code class="literal">CLUTTER_ALIGN_Y_AXIS</code></a>) and 1.0 (meaning right, when
288 <a class="link" href="ClutterAlignConstraint.html#ClutterAlignConstraint--align-axis" title='The "align-axis" property'><span class="type">"align-axis"</span></a> is set to <a class="link" href="ClutterAlignConstraint.html#CLUTTER-ALIGN-X-AXIS:CAPS"><code class="literal">CLUTTER_ALIGN_X_AXIS</code></a>; or
289 meaning bottom, when <a class="link" href="ClutterAlignConstraint.html#ClutterAlignConstraint--align-axis" title='The "align-axis" property'><span class="type">"align-axis"</span></a> is set to
290 <a class="link" href="ClutterAlignConstraint.html#CLUTTER-ALIGN-Y-AXIS:CAPS"><code class="literal">CLUTTER_ALIGN_Y_AXIS</code></a>). A value of 0.5 aligns in the middle in either
291 cases
292 </p>
293 <div class="variablelist"><table border="0">
294 <col align="left" valign="top">
295 <tbody>
296 <tr>
297 <td><p><span class="term"><em class="parameter"><code>align</code></em> :</span></p></td>
298 <td>a <a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a>
299 </td>
300 </tr>
301 <tr>
302 <td><p><span class="term"><em class="parameter"><code>factor</code></em> :</span></p></td>
303 <td>the alignment factor, between 0.0 and 1.0</td>
304 </tr>
305 </tbody>
306 </table></div>
307 <p class="since">Since 1.4</p>
308 </div>
309 <hr>
310 <div class="refsect2">
311 <a name="clutter-align-constraint-get-factor"></a><h3>clutter_align_constraint_get_factor ()</h3>
312 <pre class="programlisting"><span class="returnvalue">gfloat</span>              clutter_align_constraint_get_factor (<em class="parameter"><code><a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a> *align</code></em>);</pre>
313 <p>
314 Retrieves the factor set using <a class="link" href="ClutterAlignConstraint.html#clutter-align-constraint-set-factor" title="clutter_align_constraint_set_factor ()"><code class="function">clutter_align_constraint_set_factor()</code></a>
315 </p>
316 <div class="variablelist"><table border="0">
317 <col align="left" valign="top">
318 <tbody>
319 <tr>
320 <td><p><span class="term"><em class="parameter"><code>align</code></em> :</span></p></td>
321 <td>a <a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a>
322 </td>
323 </tr>
324 <tr>
325 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
326 <td>the alignment factor</td>
327 </tr>
328 </tbody>
329 </table></div>
330 <p class="since">Since 1.4</p>
331 </div>
332 </div>
333 <div class="refsect1">
334 <a name="ClutterAlignConstraint.property-details"></a><h2>Property Details</h2>
335 <div class="refsect2">
336 <a name="ClutterAlignConstraint--align-axis"></a><h3>The <code class="literal">"align-axis"</code> property</h3>
337 <pre class="programlisting">  "align-axis"               <a class="link" href="ClutterAlignConstraint.html#ClutterAlignAxis" title="enum ClutterAlignAxis"><span class="type">ClutterAlignAxis</span></a>      : Read / Write / Construct</pre>
338 <p>
339 The axis to be used to compute the alignment
340 </p>
341 <p>Default value: CLUTTER_ALIGN_X_AXIS</p>
342 <p class="since">Since 1.4</p>
343 </div>
344 <hr>
345 <div class="refsect2">
346 <a name="ClutterAlignConstraint--factor"></a><h3>The <code class="literal">"factor"</code> property</h3>
347 <pre class="programlisting">  "factor"                   <span class="type">gfloat</span>                : Read / Write / Construct</pre>
348 <p>
349 The alignment factor, as a normalized value between 0.0 and 1.0
350 </p>
351 <p>
352 The factor depends on the <a class="link" href="ClutterAlignConstraint.html#ClutterAlignConstraint--align-axis" title='The "align-axis" property'><span class="type">"align-axis"</span></a> property:
353 with an align-axis value of <a class="link" href="ClutterAlignConstraint.html#CLUTTER-ALIGN-X-AXIS:CAPS"><code class="literal">CLUTTER_ALIGN_X_AXIS</code></a>, 0.0 means left and
354 1.0 means right; with a value of <a class="link" href="ClutterAlignConstraint.html#CLUTTER-ALIGN-Y-AXIS:CAPS"><code class="literal">CLUTTER_ALIGN_Y_AXIS</code></a>, 0.0 means top
355 and 1.0 means bottom.
356 </p>
357 <p>Allowed values: [0,1]</p>
358 <p>Default value: 0</p>
359 <p class="since">Since 1.4</p>
360 </div>
361 <hr>
362 <div class="refsect2">
363 <a name="ClutterAlignConstraint--source"></a><h3>The <code class="literal">"source"</code> property</h3>
364 <pre class="programlisting">  "source"                   <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>*         : Read / Write / Construct</pre>
365 <p>
366 The <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> used as the source for the alignment.
367 </p>
368 <p>
369 The <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> must not be a child or a grandchild of the actor
370 using the constraint.
371 </p>
372 <p class="since">Since 1.4</p>
373 </div>
374 </div>
375 </div>
376 <div class="footer">
377 <hr>
378           Generated by GTK-Doc V1.18.1</div>
379 </body>
380 </html>