<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterBoxLayout: Clutter Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Clutter Reference Manual">
<link rel="up" href="ch03.html" title="Layout managers">
<link rel="prev" href="ClutterFlowLayout.html" title="ClutterFlowLayout">
<link rel="next" href="ClutterGridLayout.html" title="ClutterGridLayout">
<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#ClutterBoxLayout.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ClutterBoxLayout.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ClutterBoxLayout.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ClutterFlowLayout.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterGridLayout.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterBoxLayout"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterBoxLayout.top_of_page"></a>ClutterBoxLayout</span></h2>
<p>ClutterBoxLayout — A layout manager arranging children on a single line</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterBoxLayout.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="returnvalue">ClutterLayoutManager</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterBoxLayout.html#clutter-box-layout-new" title="clutter_box_layout_new ()">clutter_box_layout_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-spacing" title="clutter_box_layout_set_spacing ()">clutter_box_layout_set_spacing</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterBoxLayout.html#clutter-box-layout-get-spacing" title="clutter_box_layout_get_spacing ()">clutter_box_layout_get_spacing</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-homogeneous" title="clutter_box_layout_set_homogeneous ()">clutter_box_layout_set_homogeneous</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterBoxLayout.html#clutter-box-layout-get-homogeneous" title="clutter_box_layout_get_homogeneous ()">clutter_box_layout_get_homogeneous</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterBoxLayout.html#ClutterOrientation" title="enum ClutterOrientation"><span class="returnvalue">ClutterOrientation</span></a>
</td>
<td class="function_name">
<a class="link" href="ClutterBoxLayout.html#clutter-box-layout-get-orientation" title="clutter_box_layout_get_orientation ()">clutter_box_layout_get_orientation</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-orientation" title="clutter_box_layout_set_orientation ()">clutter_box_layout_set_orientation</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-vertical" title="clutter_box_layout_set_vertical ()">clutter_box_layout_set_vertical</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterBoxLayout.html#clutter-box-layout-get-vertical" title="clutter_box_layout_get_vertical ()">clutter_box_layout_get_vertical</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterBoxLayout.html#clutter-box-layout-pack" title="clutter_box_layout_pack ()">clutter_box_layout_pack</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-alignment" title="clutter_box_layout_set_alignment ()">clutter_box_layout_set_alignment</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterBoxLayout.html#clutter-box-layout-get-alignment" title="clutter_box_layout_get_alignment ()">clutter_box_layout_get_alignment</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-expand" title="clutter_box_layout_set_expand ()">clutter_box_layout_set_expand</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterBoxLayout.html#clutter-box-layout-get-expand" title="clutter_box_layout_get_expand ()">clutter_box_layout_get_expand</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-fill" title="clutter_box_layout_set_fill ()">clutter_box_layout_set_fill</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterBoxLayout.html#clutter-box-layout-get-fill" title="clutter_box_layout_get_fill ()">clutter_box_layout_get_fill</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gulong</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterBoxLayout.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--easing-duration" title="The “easing-duration” property">easing-duration</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gulong</span></td>
<td class="property_name"><a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--easing-mode" title="The “easing-mode” property">easing-mode</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--homogeneous" title="The “homogeneous” property">homogeneous</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="ClutterBoxLayout.html#ClutterOrientation" title="enum ClutterOrientation"><span class="type">ClutterOrientation</span></a></td>
<td class="property_name"><a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--orientation" title="The “orientation” property">orientation</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--pack-start" title="The “pack-start” property">pack-start</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--spacing" title="The “spacing” property">spacing</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--use-animations" title="The “use-animations” property">use-animations</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--vertical" title="The “vertical” property">vertical</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterBoxLayout.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment">ClutterBoxAlignment</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout-struct" title="struct ClutterBoxLayout">ClutterBoxLayout</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterBoxLayout.html#ClutterBoxLayoutClass" title="struct ClutterBoxLayoutClass">ClutterBoxLayoutClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="ClutterBoxLayout.html#ClutterOrientation" title="enum ClutterOrientation">ClutterOrientation</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterBoxLayout.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager">ClutterLayoutManager</a>
<span class="lineart">╰──</span> ClutterBoxLayout
</pre>
</div>
<div class="refsect1">
<a name="ClutterBoxLayout.description"></a><h2>Description</h2>
<p>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
following layout policy:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>all children are arranged on a single line</p></li>
<li class="listitem"><p>the axis used is controlled by the <a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--orientation" title="The “orientation” property"><span class="type">“orientation”</span></a> property</p></li>
<li class="listitem"><p>the order of the packing is determined by the <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>
<li class="listitem"><p>each child will be allocated to its natural size or, if <a class="link" href="ClutterActor.html#ClutterActor--x-expand" title="The “x-expand” property"><span class="type">“x-expand”</span></a> or
<a class="link" href="ClutterActor.html#ClutterActor--y-expand" title="The “y-expand” property"><span class="type">“y-expand”</span></a> are set, the available size</p></li>
<li class="listitem"><p>honours the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>'s <a class="link" href="ClutterActor.html#ClutterActor--x-align" title="The “x-align” property"><span class="type">“x-align”</span></a> and <a class="link" href="ClutterActor.html#ClutterActor--y-align" title="The “y-align” property"><span class="type">“y-align”</span></a> properties
to fill the available size</p></li>
<li class="listitem"><p>if the <a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--homogeneous" title="The “homogeneous” property"><span class="type">“homogeneous”</span></a> boolean propert is set, then all widgets will
get the same size, ignoring expand settings and the preferred sizes</p></li>
</ul></div>
<p>It is possible to control the spacing between children of a
<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>.</p>
<p><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> is available since Clutter 1.2</p>
</div>
<div class="refsect1">
<a name="ClutterBoxLayout.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-box-layout-new"></a><h3>clutter_box_layout_new ()</h3>
<pre class="programlisting"><a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="returnvalue">ClutterLayoutManager</span></a> *
clutter_box_layout_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> layout manager</p>
<div class="refsect3">
<a name="clutter-box-layout-new.returns"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-set-pack-start"></a><h3>clutter_box_layout_set_pack_start ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_layout_set_pack_start (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> pack_start</code></em>);</pre>
<p>Sets whether children of <em class="parameter"><code>layout</code></em>
should be layed out by appending
them or by prepending them</p>
<div class="refsect3">
<a name="clutter-box-layout-set-pack-start.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pack_start</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if the <em class="parameter"><code>layout</code></em>
should pack children at the
beginning of the layout</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-get-pack-start"></a><h3>clutter_box_layout_get_pack_start ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_box_layout_get_pack_start (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>);</pre>
<p>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>
<div class="refsect3">
<a name="clutter-box-layout-get-pack-start.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-box-layout-get-pack-start.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> should pack children
at the beginning of the layout, and <code class="literal">FALSE</code> otherwise</p>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-set-spacing"></a><h3>clutter_box_layout_set_spacing ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_layout_set_spacing (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>,
<em class="parameter"><code><span class="type">guint</span> spacing</code></em>);</pre>
<p>Sets the spacing between children of <em class="parameter"><code>layout</code></em>
</p>
<div class="refsect3">
<a name="clutter-box-layout-set-spacing.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>spacing</p></td>
<td class="parameter_description"><p>the spacing between children of the layout, in pixels</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-get-spacing"></a><h3>clutter_box_layout_get_spacing ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_box_layout_get_spacing (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>);</pre>
<p>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>
<div class="refsect3">
<a name="clutter-box-layout-get-spacing.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-box-layout-get-spacing.returns"></a><h4>Returns</h4>
<p> the spacing between children of the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-set-homogeneous"></a><h3>clutter_box_layout_set_homogeneous ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_layout_set_homogeneous (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> homogeneous</code></em>);</pre>
<p>Sets whether the size of <em class="parameter"><code>layout</code></em>
children should be
homogeneous</p>
<div class="refsect3">
<a name="clutter-box-layout-set-homogeneous.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>homogeneous</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if the layout should be homogeneous</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-get-homogeneous"></a><h3>clutter_box_layout_get_homogeneous ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_box_layout_get_homogeneous (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>);</pre>
<p>Retrieves if the children sizes are allocated homogeneously.</p>
<div class="refsect3">
<a name="clutter-box-layout-get-homogeneous.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-box-layout-get-homogeneous.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> is arranging its children
homogeneously, and <code class="literal">FALSE</code> otherwise</p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-get-orientation"></a><h3>clutter_box_layout_get_orientation ()</h3>
<pre class="programlisting"><a class="link" href="ClutterBoxLayout.html#ClutterOrientation" title="enum ClutterOrientation"><span class="returnvalue">ClutterOrientation</span></a>
clutter_box_layout_get_orientation (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>);</pre>
<p>Retrieves the orientation of the <em class="parameter"><code>layout</code></em>
.</p>
<div class="refsect3">
<a name="clutter-box-layout-get-orientation.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-box-layout-get-orientation.returns"></a><h4>Returns</h4>
<p> the orientation of the layout</p>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-set-orientation"></a><h3>clutter_box_layout_set_orientation ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_layout_set_orientation (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>,
<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html#ClutterOrientation" title="enum ClutterOrientation"><span class="type">ClutterOrientation</span></a> orientation</code></em>);</pre>
<p>Sets the orientation of the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> layout manager.</p>
<div class="refsect3">
<a name="clutter-box-layout-set-orientation.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>orientation</p></td>
<td class="parameter_description"><p>the orientation of the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-set-vertical"></a><h3>clutter_box_layout_set_vertical ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_layout_set_vertical (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> vertical</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_layout_set_vertical</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-set-orientation" title="clutter_box_layout_set_orientation ()"><code class="function">clutter_box_layout_set_orientation()</code></a> instead.</p>
</div>
<p>Sets whether <em class="parameter"><code>layout</code></em>
should arrange its children vertically alongside
the Y axis, instead of horizontally alongside the X axis</p>
<div class="refsect3">
<a name="clutter-box-layout-set-vertical.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>vertical</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if the layout should be vertical</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-get-vertical"></a><h3>clutter_box_layout_get_vertical ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_box_layout_get_vertical (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_layout_get_vertical</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterBoxLayout.html#clutter-box-layout-get-orientation" title="clutter_box_layout_get_orientation ()"><code class="function">clutter_box_layout_get_orientation()</code></a> instead</p>
</div>
<p>Retrieves the orientation of the <em class="parameter"><code>layout</code></em>
as set using the
<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>
<div class="refsect3">
<a name="clutter-box-layout-get-vertical.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-box-layout-get-vertical.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> is arranging its children
vertically, and <code class="literal">FALSE</code> otherwise</p>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-pack"></a><h3>clutter_box_layout_pack ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_layout_pack (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>,
<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> expand</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> x_fill</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> y_fill</code></em>,
<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment"><span class="type">ClutterBoxAlignment</span></a> x_align</code></em>,
<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment"><span class="type">ClutterBoxAlignment</span></a> y_align</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_layout_pack</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> honours <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>'s
align and expand properties. The preferred way is adding
the <em class="parameter"><code>actor</code></em>
with <a class="link" href="ClutterActor.html#clutter-actor-add-child" title="clutter_actor_add_child ()"><code class="function">clutter_actor_add_child()</code></a> and setting
<a class="link" href="ClutterActor.html#ClutterActor--x-align" title="The “x-align” property"><span class="type">“x-align”</span></a>, <a class="link" href="ClutterActor.html#ClutterActor--y-align" title="The “y-align” property"><span class="type">“y-align”</span></a>,
<a class="link" href="ClutterActor.html#ClutterActor--x-expand" title="The “x-expand” property"><span class="type">“x-expand”</span></a> and <a class="link" href="ClutterActor.html#ClutterActor--y-expand" title="The “y-expand” property"><span class="type">“y-expand”</span></a></p>
</div>
<p>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>
and sets the layout properties</p>
<div class="refsect3">
<a name="clutter-box-layout-pack.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>actor</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>expand</p></td>
<td class="parameter_description"><p>whether the <em class="parameter"><code>actor</code></em>
should expand</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x_fill</p></td>
<td class="parameter_description"><p>whether the <em class="parameter"><code>actor</code></em>
should fill horizontally</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y_fill</p></td>
<td class="parameter_description"><p>whether the <em class="parameter"><code>actor</code></em>
should fill vertically</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x_align</p></td>
<td class="parameter_description"><p>the horizontal alignment policy for <em class="parameter"><code>actor</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y_align</p></td>
<td class="parameter_description"><p>the vertical alignment policy for <em class="parameter"><code>actor</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-set-alignment"></a><h3>clutter_box_layout_set_alignment ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_layout_set_alignment (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>,
<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment"><span class="type">ClutterBoxAlignment</span></a> x_align</code></em>,
<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment"><span class="type">ClutterBoxAlignment</span></a> y_align</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_layout_set_alignment</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> will honour <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>'s
<a class="link" href="ClutterActor.html#ClutterActor--x-align" title="The “x-align” property"><span class="type">“x-align”</span></a> and <a class="link" href="ClutterActor.html#ClutterActor--y-align" title="The “y-align” property"><span class="type">“y-align”</span></a> properies</p>
</div>
<p>Sets the horizontal and vertical alignment policies for <em class="parameter"><code>actor</code></em>
inside <em class="parameter"><code>layout</code></em>
</p>
<div class="refsect3">
<a name="clutter-box-layout-set-alignment.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>actor</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> child of <em class="parameter"><code>layout</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x_align</p></td>
<td class="parameter_description"><p>Horizontal alignment policy for <em class="parameter"><code>actor</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y_align</p></td>
<td class="parameter_description"><p>Vertical alignment policy for <em class="parameter"><code>actor</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-get-alignment"></a><h3>clutter_box_layout_get_alignment ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_layout_get_alignment (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>,
<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment"><span class="type">ClutterBoxAlignment</span></a> *x_align</code></em>,
<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html#ClutterBoxAlignment" title="enum ClutterBoxAlignment"><span class="type">ClutterBoxAlignment</span></a> *y_align</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_layout_get_alignment</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> will honour <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>'s
<a class="link" href="ClutterActor.html#ClutterActor--x-align" title="The “x-align” property"><span class="type">“x-align”</span></a> and <a class="link" href="ClutterActor.html#ClutterActor--y-align" title="The “y-align” property"><span class="type">“y-align”</span></a> properies</p>
</div>
<p>Retrieves the horizontal and vertical alignment policies for <em class="parameter"><code>actor</code></em>
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>
<div class="refsect3">
<a name="clutter-box-layout-get-alignment.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>actor</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> child of <em class="parameter"><code>layout</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x_align</p></td>
<td class="parameter_description"><p> return location for the horizontal alignment policy. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>y_align</p></td>
<td class="parameter_description"><p> return location for the vertical alignment policy. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-set-expand"></a><h3>clutter_box_layout_set_expand ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_layout_set_expand (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>,
<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> expand</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_layout_set_expand</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> will honour <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>'s
<a class="link" href="ClutterActor.html#ClutterActor--x-expand" title="The “x-expand” property"><span class="type">“x-expand”</span></a> and <a class="link" href="ClutterActor.html#ClutterActor--y-expand" title="The “y-expand” property"><span class="type">“y-expand”</span></a> properies</p>
</div>
<p>Sets whether <em class="parameter"><code>actor</code></em>
should expand inside <em class="parameter"><code>layout</code></em>
</p>
<div class="refsect3">
<a name="clutter-box-layout-set-expand.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>actor</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> child of <em class="parameter"><code>layout</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>expand</p></td>
<td class="parameter_description"><p>whether <em class="parameter"><code>actor</code></em>
should expand</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-get-expand"></a><h3>clutter_box_layout_get_expand ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_box_layout_get_expand (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>,
<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_layout_get_expand</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> will honour <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>'s
<a class="link" href="ClutterActor.html#ClutterActor--x-expand" title="The “x-expand” property"><span class="type">“x-expand”</span></a> and <a class="link" href="ClutterActor.html#ClutterActor--y-expand" title="The “y-expand” property"><span class="type">“y-expand”</span></a> properies</p>
</div>
<p>Retrieves whether <em class="parameter"><code>actor</code></em>
should expand inside <em class="parameter"><code>layout</code></em>
</p>
<div class="refsect3">
<a name="clutter-box-layout-get-expand.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>actor</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> child of <em class="parameter"><code>layout</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-box-layout-get-expand.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> should expand, <code class="literal">FALSE</code> otherwise</p>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-set-fill"></a><h3>clutter_box_layout_set_fill ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_layout_set_fill (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>,
<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> x_fill</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> y_fill</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_layout_set_fill</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> will honour <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>'s
<a class="link" href="ClutterActor.html#ClutterActor--x-align" title="The “x-align” property"><span class="type">“x-align”</span></a> and <a class="link" href="ClutterActor.html#ClutterActor--y-align" title="The “y-align” property"><span class="type">“y-align”</span></a> properies</p>
</div>
<p>Sets the horizontal and vertical fill policies for <em class="parameter"><code>actor</code></em>
inside <em class="parameter"><code>layout</code></em>
</p>
<div class="refsect3">
<a name="clutter-box-layout-set-fill.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>actor</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> child of <em class="parameter"><code>layout</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x_fill</p></td>
<td class="parameter_description"><p>whether <em class="parameter"><code>actor</code></em>
should fill horizontally the allocated space</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y_fill</p></td>
<td class="parameter_description"><p>whether <em class="parameter"><code>actor</code></em>
should fill vertically the allocated space</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-get-fill"></a><h3>clutter_box_layout_get_fill ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_layout_get_fill (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>,
<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> *x_fill</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> *y_fill</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_layout_get_fill</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> will honour <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>'s
<a class="link" href="ClutterActor.html#ClutterActor--x-align" title="The “x-align” property"><span class="type">“x-align”</span></a> and <a class="link" href="ClutterActor.html#ClutterActor--y-align" title="The “y-align” property"><span class="type">“y-align”</span></a> properies</p>
</div>
<p>Retrieves the horizontal and vertical fill policies for <em class="parameter"><code>actor</code></em>
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>
<div class="refsect3">
<a name="clutter-box-layout-get-fill.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>actor</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> child of <em class="parameter"><code>layout</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x_fill</p></td>
<td class="parameter_description"><p> return location for the horizontal fill policy. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>y_fill</p></td>
<td class="parameter_description"><p> return location for the vertical fill policy. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-set-use-animations"></a><h3>clutter_box_layout_set_use_animations ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_layout_set_use_animations (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> animate</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_layout_set_use_animations</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>The layout manager will honour the easing state
of the children when allocating them.</p>
</div>
<p>Sets whether <em class="parameter"><code>layout</code></em>
should animate changes in the layout properties</p>
<p>The duration of the animations is controlled by
<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
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>
<p>Enabling animations will override the easing state of each child
of the actor using <em class="parameter"><code>layout</code></em>
, and will use the <a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--easing-mode" title="The “easing-mode” property"><span class="type">“easing-mode”</span></a>
and <a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--easing-duration" title="The “easing-duration” property"><span class="type">“easing-duration”</span></a> properties instead.</p>
<div class="refsect3">
<a name="clutter-box-layout-set-use-animations.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>animate</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if the <em class="parameter"><code>layout</code></em>
should use animations</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-get-use-animations"></a><h3>clutter_box_layout_get_use_animations ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_box_layout_get_use_animations (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>);</pre>
<div class="warning"><p><code class="literal">clutter_box_layout_get_use_animations</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p></div>
<p>Retrieves whether <em class="parameter"><code>layout</code></em>
should animate changes in the layout properties.</p>
<div class="refsect3">
<a name="clutter-box-layout-get-use-animations.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-box-layout-get-use-animations.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the animations should be used, <code class="literal">FALSE</code> otherwise</p>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-set-easing-duration"></a><h3>clutter_box_layout_set_easing_duration ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_layout_set_easing_duration
(<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>,
<em class="parameter"><code><span class="type">guint</span> msecs</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_layout_set_easing_duration</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>The layout manager will honour the easing state
of the children when allocating them.</p>
</div>
<p>Sets the duration of the animations used by <em class="parameter"><code>layout</code></em>
when animating changes
in the layout properties.</p>
<div class="refsect3">
<a name="clutter-box-layout-set-easing-duration.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>msecs</p></td>
<td class="parameter_description"><p>the duration of the animations, in milliseconds</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-get-easing-duration"></a><h3>clutter_box_layout_get_easing_duration ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_box_layout_get_easing_duration
(<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>);</pre>
<div class="warning"><p><code class="literal">clutter_box_layout_get_easing_duration</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p></div>
<p>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>
<div class="refsect3">
<a name="clutter-box-layout-get-easing-duration.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-box-layout-get-easing-duration.returns"></a><h4>Returns</h4>
<p> the duration of the animations, in milliseconds</p>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-set-easing-mode"></a><h3>clutter_box_layout_set_easing_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_layout_set_easing_mode (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>,
<em class="parameter"><code><span class="type">gulong</span> mode</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_layout_set_easing_mode</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>The layout manager will honour the easing state
of the children when allocating them.</p>
</div>
<p>Sets the easing mode to be used by <em class="parameter"><code>layout</code></em>
when animating changes in layout
properties.</p>
<div class="refsect3">
<a name="clutter-box-layout-set-easing-mode.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mode</p></td>
<td class="parameter_description"><p>an easing mode, either from <a class="link" href="ClutterTimeline.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a> or a logical id
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></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-box-layout-get-easing-mode"></a><h3>clutter_box_layout_get_easing_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">gulong</span>
clutter_box_layout_get_easing_mode (<em class="parameter"><code><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> *layout</code></em>);</pre>
<div class="warning"><p><code class="literal">clutter_box_layout_get_easing_mode</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p></div>
<p>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>
<div class="refsect3">
<a name="clutter-box-layout-get-easing-mode.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-box-layout-get-easing-mode.returns"></a><h4>Returns</h4>
<p> an easing mode</p>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterBoxLayout.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterBoxAlignment"></a><h3>enum ClutterBoxAlignment</h3>
<p>The alignment policies available on each axis of the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a></p>
<div class="refsect3">
<a name="ClutterBoxAlignment.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-BOX-ALIGNMENT-START:CAPS"></a>CLUTTER_BOX_ALIGNMENT_START</p></td>
<td class="enum_member_description">
<p>Align the child to the top or to
to the left, depending on the used axis</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-BOX-ALIGNMENT-END:CAPS"></a>CLUTTER_BOX_ALIGNMENT_END</p></td>
<td class="enum_member_description">
<p>Align the child to the bottom or to
the right, depending on the used axis</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-BOX-ALIGNMENT-CENTER:CAPS"></a>CLUTTER_BOX_ALIGNMENT_CENTER</p></td>
<td class="enum_member_description">
<p>Align the child to the center</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterBoxLayout-struct"></a><h3>struct ClutterBoxLayout</h3>
<pre class="programlisting">struct ClutterBoxLayout;</pre>
<p>The <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> structure contains only private data
and should be accessed using the provided API</p>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterBoxLayoutClass"></a><h3>struct ClutterBoxLayoutClass</h3>
<pre class="programlisting">struct ClutterBoxLayoutClass {
};
</pre>
<p>The <a class="link" href="ClutterBoxLayout.html#ClutterBoxLayoutClass" title="struct ClutterBoxLayoutClass"><span class="type">ClutterBoxLayoutClass</span></a> structure contains only private
data and should be accessed using the provided API</p>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterOrientation"></a><h3>enum ClutterOrientation</h3>
<p>Represents the orientation of actors or layout managers.</p>
<div class="refsect3">
<a name="ClutterOrientation.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-ORIENTATION-HORIZONTAL:CAPS"></a>CLUTTER_ORIENTATION_HORIZONTAL</p></td>
<td class="enum_member_description">
<p>An horizontal orientation</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-ORIENTATION-VERTICAL:CAPS"></a>CLUTTER_ORIENTATION_VERTICAL</p></td>
<td class="enum_member_description">
<p>A vertical orientation</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterBoxLayout.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterBoxLayout--easing-duration"></a><h3>The <code class="literal">“easing-duration”</code> property</h3>
<pre class="programlisting"> “easing-duration” <span class="type">guint</span></pre>
<p>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>
is set to <code class="literal">TRUE</code>.</p>
<p>The duration is expressed in milliseconds.</p>
<div class="warning">
<p><code class="literal">ClutterBoxLayout:easing-duration</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>The <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> will honour the easing state of
the children when allocating them.</p>
</div>
<p>Flags: Read / Write</p>
<p>Default value: 500</p>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterBoxLayout--easing-mode"></a><h3>The <code class="literal">“easing-mode”</code> property</h3>
<pre class="programlisting"> “easing-mode” <span class="type">gulong</span></pre>
<p>The easing mode for 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> is set to <code class="literal">TRUE</code>.</p>
<p>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
either be a value from the <a class="link" href="ClutterTimeline.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a> enumeration, like
<a class="link" href="ClutterTimeline.html#CLUTTER-EASE-OUT-CUBIC:CAPS"><code class="literal">CLUTTER_EASE_OUT_CUBIC</code></a>, or a logical id as returned by
<a class="link" href="ClutterAlpha.html#clutter-alpha-register-func" title="clutter_alpha_register_func ()"><code class="function">clutter_alpha_register_func()</code></a>.</p>
<p>The default value is <a class="link" href="ClutterTimeline.html#CLUTTER-EASE-OUT-CUBIC:CAPS"><code class="literal">CLUTTER_EASE_OUT_CUBIC</code></a>.</p>
<div class="warning">
<p><code class="literal">ClutterBoxLayout:easing-mode</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>The <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> will honour the easing state of
the children when allocating them.</p>
</div>
<p>Flags: Read / Write</p>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterBoxLayout--homogeneous"></a><h3>The <code class="literal">“homogeneous”</code> property</h3>
<pre class="programlisting"> “homogeneous” <span class="type">gboolean</span></pre>
<p>Whether the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> should arrange its children
homogeneously, i.e. all children get the same size</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterBoxLayout--orientation"></a><h3>The <code class="literal">“orientation”</code> property</h3>
<pre class="programlisting"> “orientation” <a class="link" href="ClutterBoxLayout.html#ClutterOrientation" title="enum ClutterOrientation"><span class="type">ClutterOrientation</span></a></pre>
<p>The orientation of the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>, either horizontal
or vertical</p>
<p>Flags: Read / Write</p>
<p>Default value: CLUTTER_ORIENTATION_HORIZONTAL</p>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterBoxLayout--pack-start"></a><h3>The <code class="literal">“pack-start”</code> property</h3>
<pre class="programlisting"> “pack-start” <span class="type">gboolean</span></pre>
<p>Whether the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> should pack items at the start
or append them at the end</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterBoxLayout--spacing"></a><h3>The <code class="literal">“spacing”</code> property</h3>
<pre class="programlisting"> “spacing” <span class="type">guint</span></pre>
<p>The spacing between children of the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a>, in pixels</p>
<p>Flags: Read / Write</p>
<p>Default value: 0</p>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterBoxLayout--use-animations"></a><h3>The <code class="literal">“use-animations”</code> property</h3>
<pre class="programlisting"> “use-animations” <span class="type">gboolean</span></pre>
<p>Whether the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> should animate changes in the
layout, overriding the easing state of the children.</p>
<div class="warning">
<p><code class="literal">ClutterBoxLayout:use-animations</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p><a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> will honour the easing state
of the children when allocating them.</p>
</div>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterBoxLayout--vertical"></a><h3>The <code class="literal">“vertical”</code> property</h3>
<pre class="programlisting"> “vertical” <span class="type">gboolean</span></pre>
<p>Whether the <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> should arrange its children
alongside the Y axis, instead of alongside the X axis</p>
<div class="warning">
<p><code class="literal">ClutterBoxLayout:vertical</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterBoxLayout.html#ClutterBoxLayout--orientation" title="The “orientation” property"><span class="type">“orientation”</span></a> instead.</p>
</div>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>