<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterBox: 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="deprecated.html" title="Part X. Deprecated Classes">
<link rel="prev" href="ClutterBehaviourScale.html" title="ClutterBehaviourScale">
<link rel="next" href="ClutterCairoTexture.html" title="ClutterCairoTexture">
<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="#ClutterBox.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ClutterBox.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#ClutterBox.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ClutterBox.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="deprecated.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ClutterBehaviourScale.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterCairoTexture.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterBox"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterBox.top_of_page"></a>ClutterBox</span></h2>
<p>ClutterBox — A Generic layout container</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterBox.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="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterBox.html#clutter-box-new" title="clutter_box_new ()">clutter_box_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="ClutterBox.html#clutter-box-set-layout-manager" title="clutter_box_set_layout_manager ()">clutter_box_set_layout_manager</a> <span class="c_punctuation">()</span>
</td>
</tr>
<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="ClutterBox.html#clutter-box-get-layout-manager" title="clutter_box_get_layout_manager ()">clutter_box_get_layout_manager</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="ClutterBox.html#clutter-box-set-color" title="clutter_box_set_color ()">clutter_box_set_color</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="ClutterBox.html#clutter-box-get-color" title="clutter_box_get_color ()">clutter_box_get_color</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="ClutterBox.html#clutter-box-pack" title="clutter_box_pack ()">clutter_box_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="ClutterBox.html#clutter-box-packv" title="clutter_box_packv ()">clutter_box_packv</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="ClutterBox.html#clutter-box-pack-after" title="clutter_box_pack_after ()">clutter_box_pack_after</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="ClutterBox.html#clutter-box-pack-before" title="clutter_box_pack_before ()">clutter_box_pack_before</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="ClutterBox.html#clutter-box-pack-at" title="clutter_box_pack_at ()">clutter_box_pack_at</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterBox.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">
<a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *</td>
<td class="property_name"><a class="link" href="ClutterBox.html#ClutterBox--color" title="The “color” property">color</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="ClutterBox.html#ClutterBox--color-set" title="The “color-set” property">color-set</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterBox.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">struct</td>
<td class="function_name"><a class="link" href="ClutterBox.html#ClutterBox-struct" title="struct ClutterBox">ClutterBox</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterBox.html#ClutterBoxClass" title="struct ClutterBoxClass">ClutterBoxClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterBox.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
<span class="lineart">╰──</span> ClutterBox
</pre>
</div>
<div class="refsect1">
<a name="ClutterBox.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
ClutterBox implements
<a class="link" href="ClutterContainer.html" title="ClutterContainer">ClutterContainer</a>, <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>, <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable">ClutterAnimatable</a> and AtkImplementorIface.</p>
</div>
<div class="refsect1">
<a name="ClutterBox.description"></a><h2>Description</h2>
<p><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> is a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> sub-class implementing the <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
interface. A Box delegates the whole size requisition and size allocation to
a <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> instance.</p>
<p><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> is available since Clutter 1.2</p>
<p><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> is deprecated since Clutter 1.10; all its relevant API is provided
by <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>, via the <a class="link" href="ClutterActor.html#ClutterActor--layout-manager" title="The “layout-manager” property"><span class="type">“layout-manager”</span></a> property.</p>
<div class="refsect3">
<a name="id-1.11.12.8.5"></a><h4>Using ClutterBox</h4>
<p>The following code shows how to create a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> with
a <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> sub-class, and how to add children to
it via <a class="link" href="ClutterBox.html#clutter-box-pack" title="clutter_box_pack ()"><code class="function">clutter_box_pack()</code></a>.</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">ClutterActor</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">box</span><span class="symbol">;</span>
<span class="usertype">ClutterLayoutManager</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">layout</span><span class="symbol">;</span>
<span class="comment">// Create the layout manager first</span>
<span class="normal">layout </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="ClutterBoxLayout.html#clutter-box-layout-new">clutter_box_layout_new</a></span><span class="normal"> </span><span class="symbol">();</span>
<span class="function"><a href="ClutterBoxLayout.html#clutter-box-layout-set-homogeneous">clutter_box_layout_set_homogeneous</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">CLUTTER_BOX_LAYOUT</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">layout</span><span class="symbol">),</span><span class="normal"> TRUE</span><span class="symbol">);</span>
<span class="function"><a href="ClutterBoxLayout.html#clutter-box-layout-set-spacing">clutter_box_layout_set_spacing</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">CLUTTER_BOX_LAYOUT</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">layout</span><span class="symbol">),</span><span class="normal"> </span><span class="number">12</span><span class="symbol">);</span>
<span class="comment">// Then create the ClutterBox actor. The Box will take</span>
<span class="comment">// ownership of the ClutterLayoutManager instance by sinking</span>
<span class="comment">// its floating reference</span>
<span class="normal">box </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="ClutterBox.html#clutter-box-new">clutter_box_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">layout</span><span class="symbol">);</span>
<span class="comment">// Now add children to the Box using the variadic arguments</span>
<span class="comment">// function clutter_box_pack() to set layout properties</span>
<span class="function"><a href="ClutterBox.html#clutter-box-pack">clutter_box_pack</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">CLUTTER_BOX</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">box</span><span class="symbol">),</span><span class="normal"> actor</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"x-align"</span><span class="symbol">,</span><span class="normal"> <a href="ClutterBoxLayout.html#CLUTTER-BOX-ALIGNMENT-CENTER:CAPS">CLUTTER_BOX_ALIGNMENT_CENTER</a></span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"y-align"</span><span class="symbol">,</span><span class="normal"> <a href="ClutterBoxLayout.html#CLUTTER-BOX-ALIGNMENT-END:CAPS">CLUTTER_BOX_ALIGNMENT_END</a></span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"expand"</span><span class="symbol">,</span><span class="normal"> TRUE</span><span class="symbol">,</span>
<span class="normal"> NULL</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a>'s <a class="link" href="ClutterBox.html#clutter-box-pack" title="clutter_box_pack ()"><code class="function">clutter_box_pack()</code></a> wraps the generic
<a class="link" href="ClutterContainer.html#clutter-container-add-actor" title="clutter_container_add_actor ()"><code class="function">clutter_container_add_actor()</code></a> function, but it also allows setting
layout properties while adding the new child to the box.</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterBox.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-box-new"></a><h3>clutter_box_new ()</h3>
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
clutter_box_new (<em class="parameter"><code><a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> *manager</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_new</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterActor.html#clutter-actor-new" title="clutter_actor_new ()"><code class="function">clutter_actor_new()</code></a> instead.</p>
</div>
<p>Creates a new <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a>. The children of the box will be layed
out by the passed <em class="parameter"><code>manager</code></em>
</p>
<div class="refsect3">
<a name="clutter-box-new.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>manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-box-new.returns"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> actor</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-set-layout-manager"></a><h3>clutter_box_set_layout_manager ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_set_layout_manager (<em class="parameter"><code><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> *box</code></em>,
<em class="parameter"><code><a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> *manager</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_set_layout_manager</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterActor.html#clutter-actor-set-layout-manager" title="clutter_actor_set_layout_manager ()"><code class="function">clutter_actor_set_layout_manager()</code></a> instead.</p>
</div>
<p>Sets the <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> for <em class="parameter"><code>box</code></em>
</p>
<p>A <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> is a delegate object that controls the
layout of the children of <em class="parameter"><code>box</code></em>
</p>
<div class="refsect3">
<a name="clutter-box-set-layout-manager.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>box</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></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-get-layout-manager"></a><h3>clutter_box_get_layout_manager ()</h3>
<pre class="programlisting"><a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="returnvalue">ClutterLayoutManager</span></a> *
clutter_box_get_layout_manager (<em class="parameter"><code><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> *box</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_get_layout_manager</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterActor.html#clutter-actor-get-layout-manager" title="clutter_actor_get_layout_manager ()"><code class="function">clutter_actor_get_layout_manager()</code></a> instead.</p>
</div>
<p>Retrieves the <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> instance used by <em class="parameter"><code>box</code></em>
</p>
<div class="refsect3">
<a name="clutter-box-get-layout-manager.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>box</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-box-get-layout-manager.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a>. The returned
<a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> is owned by the <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> and it should not
be unreferenced. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></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-set-color"></a><h3>clutter_box_set_color ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_set_color (<em class="parameter"><code><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> *box</code></em>,
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_set_color</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterActor.html#clutter-actor-set-background-color" title="clutter_actor_set_background_color ()"><code class="function">clutter_actor_set_background_color()</code></a> instead.</p>
</div>
<p>Sets (or unsets) the background color for <em class="parameter"><code>box</code></em>
</p>
<div class="refsect3">
<a name="clutter-box-set-color.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>box</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p> the background color, or <code class="literal">NULL</code> to unset. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</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-get-color"></a><h3>clutter_box_get_color ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_get_color (<em class="parameter"><code><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> *box</code></em>,
<em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_get_color</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterActor.html#clutter-actor-get-background-color" title="clutter_actor_get_background_color ()"><code class="function">clutter_actor_get_background_color()</code></a> instead.</p>
</div>
<p>Retrieves the background color of <em class="parameter"><code>box</code></em>
</p>
<p>If the <a class="link" href="ClutterBox.html#ClutterBox--color-set" title="The “color-set” property"><span class="type">“color-set”</span></a> property is set to <code class="literal">FALSE</code> the
returned <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> is undefined</p>
<div class="refsect3">
<a name="clutter-box-get-color.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>box</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p> return location for a <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</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-pack"></a><h3>clutter_box_pack ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_pack (<em class="parameter"><code><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> *box</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>const <span class="type">gchar</span> *first_property</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_pack</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterActor.html#clutter-actor-add-child" title="clutter_actor_add_child ()"><code class="function">clutter_actor_add_child()</code></a> instead. To set
specific layout properties, use <a class="link" href="ClutterLayoutManager.html#clutter-layout-manager-child-set" title="clutter_layout_manager_child_set ()"><code class="function">clutter_layout_manager_child_set()</code></a></p>
</div>
<p>Adds <em class="parameter"><code>actor</code></em>
to <em class="parameter"><code>box</code></em>
and sets layout properties at the same time,
if the <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> used by <em class="parameter"><code>box</code></em>
has them</p>
<p>This function is a wrapper around <a class="link" href="ClutterContainer.html#clutter-container-add-actor" title="clutter_container_add_actor ()"><code class="function">clutter_container_add_actor()</code></a>
and <a class="link" href="ClutterLayoutManager.html#clutter-layout-manager-child-set" title="clutter_layout_manager_child_set ()"><code class="function">clutter_layout_manager_child_set()</code></a></p>
<p>Language bindings should use the vector-based <a class="link" href="ClutterBox.html#clutter-box-packv" title="clutter_box_packv ()"><code class="function">clutter_box_packv()</code></a>
variant instead</p>
<div class="refsect3">
<a name="clutter-box-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>box</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</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>first_property</p></td>
<td class="parameter_description"><p>the name of the first property to set, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>a list of property name and value pairs, terminated by <code class="literal">NULL</code></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-packv"></a><h3>clutter_box_packv ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_packv (<em class="parameter"><code><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> *box</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">guint</span> n_properties</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> * const properties[]</code></em>,
<em class="parameter"><code>const <span class="type">GValue</span> *values</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_packv</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterActor.html#clutter-actor-add-child" title="clutter_actor_add_child ()"><code class="function">clutter_actor_add_child()</code></a> instead. To set
specific layout properties, use <a class="link" href="ClutterLayoutManager.html#clutter-layout-manager-child-set" title="clutter_layout_manager_child_set ()"><code class="function">clutter_layout_manager_child_set()</code></a></p>
</div>
<p>Vector-based variant of <a class="link" href="ClutterBox.html#clutter-box-pack" title="clutter_box_pack ()"><code class="function">clutter_box_pack()</code></a>, intended for language
bindings to use</p>
<div class="refsect3">
<a name="clutter-box-packv.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>box</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</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>n_properties</p></td>
<td class="parameter_description"><p>the number of properties to set</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>properties</p></td>
<td class="parameter_description"><p> a vector
containing the property names to set. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_properties][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>values</p></td>
<td class="parameter_description"><p> a vector containing the property
values to set. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_properties]</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-pack-after"></a><h3>clutter_box_pack_after ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_pack_after (<em class="parameter"><code><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> *box</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="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *sibling</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *first_property</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_pack_after</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterActor.html#clutter-actor-insert-child-above" title="clutter_actor_insert_child_above ()"><code class="function">clutter_actor_insert_child_above()</code></a> instead.
To set specific layout properties, use <a class="link" href="ClutterLayoutManager.html#clutter-layout-manager-child-set" title="clutter_layout_manager_child_set ()"><code class="function">clutter_layout_manager_child_set()</code></a></p>
</div>
<p>Adds <em class="parameter"><code>actor</code></em>
to <em class="parameter"><code>box</code></em>
, placing it after <em class="parameter"><code>sibling</code></em>
, and sets layout
properties at the same time, if the <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> used by
<em class="parameter"><code>box</code></em>
supports them</p>
<p>If <em class="parameter"><code>sibling</code></em>
is <code class="literal">NULL</code> then <em class="parameter"><code>actor</code></em>
is placed at the end of the
list of children, to be allocated and painted after every other child</p>
<p>This function is a wrapper around <a class="link" href="ClutterContainer.html#clutter-container-add-actor" title="clutter_container_add_actor ()"><code class="function">clutter_container_add_actor()</code></a>,
<a class="link" href="ClutterContainer.html#clutter-container-raise-child" title="clutter_container_raise_child ()"><code class="function">clutter_container_raise_child()</code></a> and <a class="link" href="ClutterLayoutManager.html#clutter-layout-manager-child-set" title="clutter_layout_manager_child_set ()"><code class="function">clutter_layout_manager_child_set()</code></a></p>
<div class="refsect3">
<a name="clutter-box-pack-after.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>box</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</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>sibling</p></td>
<td class="parameter_description"><p> a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>first_property</p></td>
<td class="parameter_description"><p>the name of the first property to set, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>a list of property name and value pairs, terminated by <code class="literal">NULL</code></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-pack-before"></a><h3>clutter_box_pack_before ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_pack_before (<em class="parameter"><code><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> *box</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="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *sibling</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *first_property</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_pack_before</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterActor.html#clutter-actor-insert-child-below" title="clutter_actor_insert_child_below ()"><code class="function">clutter_actor_insert_child_below()</code></a> instead.
To set specific layout properties, use <a class="link" href="ClutterLayoutManager.html#clutter-layout-manager-child-set" title="clutter_layout_manager_child_set ()"><code class="function">clutter_layout_manager_child_set()</code></a></p>
</div>
<p>Adds <em class="parameter"><code>actor</code></em>
to <em class="parameter"><code>box</code></em>
, placing it before <em class="parameter"><code>sibling</code></em>
, and sets layout
properties at the same time, if the <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> used by
<em class="parameter"><code>box</code></em>
supports them</p>
<p>If <em class="parameter"><code>sibling</code></em>
is <code class="literal">NULL</code> then <em class="parameter"><code>actor</code></em>
is placed at the beginning of the
list of children, to be allocated and painted below every other child</p>
<p>This function is a wrapper around <a class="link" href="ClutterContainer.html#clutter-container-add-actor" title="clutter_container_add_actor ()"><code class="function">clutter_container_add_actor()</code></a>,
<a class="link" href="ClutterContainer.html#clutter-container-lower-child" title="clutter_container_lower_child ()"><code class="function">clutter_container_lower_child()</code></a> and <a class="link" href="ClutterLayoutManager.html#clutter-layout-manager-child-set" title="clutter_layout_manager_child_set ()"><code class="function">clutter_layout_manager_child_set()</code></a></p>
<div class="refsect3">
<a name="clutter-box-pack-before.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>box</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</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>sibling</p></td>
<td class="parameter_description"><p> a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>first_property</p></td>
<td class="parameter_description"><p>the name of the first property to set, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>a list of property name and value pairs, terminated by <code class="literal">NULL</code></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-pack-at"></a><h3>clutter_box_pack_at ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_box_pack_at (<em class="parameter"><code><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> *box</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">gint</span> position</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *first_property</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_box_pack_at</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterActor.html#clutter-actor-insert-child-at-index" title="clutter_actor_insert_child_at_index ()"><code class="function">clutter_actor_insert_child_at_index()</code></a> instead.
To set specific layout properties, use <a class="link" href="ClutterLayoutManager.html#clutter-layout-manager-child-set" title="clutter_layout_manager_child_set ()"><code class="function">clutter_layout_manager_child_set()</code></a></p>
</div>
<p>Adds <em class="parameter"><code>actor</code></em>
to <em class="parameter"><code>box</code></em>
, placing it at <em class="parameter"><code>position</code></em>
, and sets layout
properties at the same time, if the <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> used by
<em class="parameter"><code>box</code></em>
supports them</p>
<p>If <em class="parameter"><code>position</code></em>
is a negative number, or is larger than the number of
children of <em class="parameter"><code>box</code></em>
, the new child is added at the end of the list of
children</p>
<div class="refsect3">
<a name="clutter-box-pack-at.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>box</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</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>position</p></td>
<td class="parameter_description"><p>the position to insert the <em class="parameter"><code>actor</code></em>
at</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>first_property</p></td>
<td class="parameter_description"><p>the name of the first property to set, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>a list of property name and value pairs, terminated by <code class="literal">NULL</code></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>
</div>
<div class="refsect1">
<a name="ClutterBox.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterBox-struct"></a><h3>struct ClutterBox</h3>
<pre class="programlisting">struct ClutterBox;</pre>
<p>The <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</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="ClutterBoxClass"></a><h3>struct ClutterBoxClass</h3>
<pre class="programlisting">struct ClutterBoxClass {
};
</pre>
<p>The <a class="link" href="ClutterBox.html#ClutterBoxClass" title="struct ClutterBoxClass"><span class="type">ClutterBoxClass</span></a> structure contains only private data</p>
<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="ClutterBox.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterBox--color"></a><h3>The <code class="literal">“color”</code> property</h3>
<pre class="programlisting"> “color” <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *</pre>
<p>The color to be used to paint the background of the
<a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a>. Setting this property will set the
<a class="link" href="ClutterBox.html#ClutterBox--color-set" title="The “color-set” property"><span class="type">“color-set”</span></a> property as a side effect</p>
<p>This property sets the <a class="link" href="ClutterActor.html#ClutterActor--background-color" title="The “background-color” property"><span class="type">“background-color”</span></a> property
internally.</p>
<div class="warning">
<p><code class="literal">ClutterBox:color</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use the <a class="link" href="ClutterActor.html#ClutterActor--background-color" title="The “background-color” property"><span class="type">“background-color”</span></a> property</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="ClutterBox--color-set"></a><h3>The <code class="literal">“color-set”</code> property</h3>
<pre class="programlisting"> “color-set” <span class="type">gboolean</span></pre>
<p>Whether the <a class="link" href="ClutterBox.html#ClutterBox--color" title="The “color” property"><span class="type">“color”</span></a> property has been set.</p>
<p>This property reads the <a class="link" href="ClutterActor.html#ClutterActor--background-color-set" title="The “background-color-set” property"><span class="type">“background-color-set”</span></a> property
internally.</p>
<div class="warning">
<p><code class="literal">ClutterBox:color-set</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use the <a class="link" href="ClutterActor.html#ClutterActor--background-color-set" title="The “background-color-set” property"><span class="type">“background-color-set”</span></a> property</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>