doc/reference/clutter/html/ClutterBox.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>ClutterBox</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="Clutter Reference Manual">
   8 <link rel="up" href="deprecated.html" title="Part X. Deprecated Classes">
   9 <link rel="prev" href="ClutterGroup.html" title="ClutterGroup">
  10 <link rel="next" href="ClutterRectangle.html" title="ClutterRectangle">
  11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="ClutterGroup.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="deprecated.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">Clutter Reference Manual</th>
  21 <td><a accesskey="n" href="ClutterRectangle.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#ClutterBox.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterBox.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterBox.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterBox.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#ClutterBox.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="ClutterBox"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="ClutterBox.top_of_page"></a>ClutterBox</span></h2>
  40 <p>ClutterBox — A Generic layout container</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="ClutterBox.synopsis"></a><h2>Synopsis</h2>
  46 <pre class="synopsis">struct              <a class="link" href="ClutterBox.html#ClutterBox-struct" title="struct ClutterBox">ClutterBox</a>;
  47 struct              <a class="link" href="ClutterBox.html#ClutterBoxClass" title="struct ClutterBoxClass">ClutterBoxClass</a>;
  48 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="ClutterBox.html#clutter-box-new" title="clutter_box_new ()">clutter_box_new</a>                     (<em class="parameter"><code><a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> *manager</code></em>);
  49 <span class="returnvalue">void</span>                <a class="link" href="ClutterBox.html#clutter-box-set-layout-manager" title="clutter_box_set_layout_manager ()">clutter_box_set_layout_manager</a>      (<em class="parameter"><code><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> *box</code></em>,
  50                                                          <em class="parameter"><code><a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> *manager</code></em>);
  51 <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="returnvalue">ClutterLayoutManager</span></a> * <a class="link" href="ClutterBox.html#clutter-box-get-layout-manager" title="clutter_box_get_layout_manager ()">clutter_box_get_layout_manager</a>   (<em class="parameter"><code><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> *box</code></em>);
  52 <span class="returnvalue">void</span>                <a class="link" href="ClutterBox.html#clutter-box-set-color" title="clutter_box_set_color ()">clutter_box_set_color</a>               (<em class="parameter"><code><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> *box</code></em>,
  53                                                          <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
  54 <span class="returnvalue">void</span>                <a class="link" href="ClutterBox.html#clutter-box-get-color" title="clutter_box_get_color ()">clutter_box_get_color</a>               (<em class="parameter"><code><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> *box</code></em>,
  55                                                          <em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
  56
  57 <span class="returnvalue">void</span>                <a class="link" href="ClutterBox.html#clutter-box-pack" title="clutter_box_pack ()">clutter_box_pack</a>                    (<em class="parameter"><code><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> *box</code></em>,
  58                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
  59                                                          <em class="parameter"><code>const <span class="type">gchar</span> *first_property</code></em>,
  60                                                          <em class="parameter"><code>...</code></em>);
  61 <span class="returnvalue">void</span>                <a class="link" href="ClutterBox.html#clutter-box-packv" title="clutter_box_packv ()">clutter_box_packv</a>                   (<em class="parameter"><code><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> *box</code></em>,
  62                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
  63                                                          <em class="parameter"><code><span class="type">guint</span> n_properties</code></em>,
  64                                                          <em class="parameter"><code>const <span class="type">gchar</span> * const properties[]</code></em>,
  65                                                          <em class="parameter"><code>const <span class="type">GValue</span> *values</code></em>);
  66 <span class="returnvalue">void</span>                <a class="link" href="ClutterBox.html#clutter-box-pack-after" title="clutter_box_pack_after ()">clutter_box_pack_after</a>              (<em class="parameter"><code><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> *box</code></em>,
  67                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
  68                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *sibling</code></em>,
  69                                                          <em class="parameter"><code>const <span class="type">gchar</span> *first_property</code></em>,
  70                                                          <em class="parameter"><code>...</code></em>);
  71 <span class="returnvalue">void</span>                <a class="link" href="ClutterBox.html#clutter-box-pack-before" title="clutter_box_pack_before ()">clutter_box_pack_before</a>             (<em class="parameter"><code><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> *box</code></em>,
  72                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
  73                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *sibling</code></em>,
  74                                                          <em class="parameter"><code>const <span class="type">gchar</span> *first_property</code></em>,
  75                                                          <em class="parameter"><code>...</code></em>);
  76 <span class="returnvalue">void</span>                <a class="link" href="ClutterBox.html#clutter-box-pack-at" title="clutter_box_pack_at ()">clutter_box_pack_at</a>                 (<em class="parameter"><code><a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> *box</code></em>,
  77                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
  78                                                          <em class="parameter"><code><span class="type">gint</span> position</code></em>,
  79                                                          <em class="parameter"><code>const <span class="type">gchar</span> *first_property</code></em>,
  80                                                          <em class="parameter"><code>...</code></em>);
  81 </pre>
  82 </div>
  83 <div class="refsect1">
  84 <a name="ClutterBox.object-hierarchy"></a><h2>Object Hierarchy</h2>
  85 <pre class="synopsis">
  86   GObject
  87    +----GInitiallyUnowned
  88          +----<a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
  89                +----ClutterBox
  90 </pre>
  91 </div>
  92 <div class="refsect1">
  93 <a name="ClutterBox.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  94 <p>
  95 ClutterBox implements
  96  <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>
  97 </div>
  98 <div class="refsect1">
  99 <a name="ClutterBox.properties"></a><h2>Properties</h2>
 100 <pre class="synopsis">
 101   "<a class="link" href="ClutterBox.html#ClutterBox--color" title='The "color" property'>color</a>"                    <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write
 102   "<a class="link" href="ClutterBox.html#ClutterBox--color-set" title='The "color-set" property'>color-set</a>"                <span class="type">gboolean</span>              : Read / Write
 103 </pre>
 104 </div>
 105 <div class="refsect1">
 106 <a name="ClutterBox.description"></a><h2>Description</h2>
 107 <p>
 108 <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>
 109 interface. A Box delegates the whole size requisition and size allocation to
 110 a <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> instance.
 111 </p>
 112 <p>
 113 </p>
 114 <div class="example">
 115 <a name="example-clutter-box"></a><p class="title"><b>Example 30. Using ClutterBox</b></p>
 116 <div class="example-contents">
 117 <p>The following code shows how to create a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> with
 118   a <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> sub-class, and how to add children to
 119   it via <a class="link" href="ClutterBox.html#clutter-box-pack" title="clutter_box_pack ()"><code class="function">clutter_box_pack()</code></a>.</p>
 120 <pre class="programlisting">
 121  ClutterActor *box;
 122  ClutterLayoutManager *layout;
 123
 124  /* Create the layout manager first */
 125  layout = clutter_box_layout_new ();
 126  clutter_box_layout_set_homogeneous (CLUTTER_BOX_LAYOUT (layout), TRUE);
 127  clutter_box_layout_set_spacing (CLUTTER_BOX_LAYOUT (layout), 12);
 128
 129  /* Then create the ClutterBox actor. The Box will take
 130   * ownership of the ClutterLayoutManager instance by sinking
 131   * its floating reference
 132   */
 133  box = clutter_box_new (layout);
 134
 135  /* Now add children to the Box using the variadic arguments
 136   * function clutter_box_pack() to set layout properties
 137   */
 138  clutter_box_pack (CLUTTER_BOX (box), actor,
 139                    "x-align", CLUTTER_BOX_ALIGNMENT_CENTER,
 140                    "y-align", CLUTTER_BOX_ALIGNMENT_END,
 141                    "expand", TRUE,
 142                    NULL);
 143   </pre>
 144 </div>
 145 </div>
 146 <p><br class="example-break">
 147 </p>
 148 <p>
 149 <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
 150 <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
 151 layout properties while adding the new child to the box.
 152 </p>
 153 <p>
 154 <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> is available since Clutter 1.2
 155 </p>
 156 </div>
 157 <div class="refsect1">
 158 <a name="ClutterBox.details"></a><h2>Details</h2>
 159 <div class="refsect2">
 160 <a name="ClutterBox-struct"></a><h3>struct ClutterBox</h3>
 161 <pre class="programlisting">struct ClutterBox;</pre>
 162 <p>
 163 The <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> structure contains only private data and should
 164 be accessed using the provided API
 165 </p>
 166 <p class="since">Since 1.2</p>
 167 </div>
 168 <hr>
 169 <div class="refsect2">
 170 <a name="ClutterBoxClass"></a><h3>struct ClutterBoxClass</h3>
 171 <pre class="programlisting">struct ClutterBoxClass {
 172 };
 173 </pre>
 174 <p>
 175 The <a class="link" href="ClutterBox.html#ClutterBoxClass" title="struct ClutterBoxClass"><span class="type">ClutterBoxClass</span></a> structure contains only private data
 176 </p>
 177 <p class="since">Since 1.2</p>
 178 </div>
 179 <hr>
 180 <div class="refsect2">
 181 <a name="clutter-box-new"></a><h3>clutter_box_new ()</h3>
 182 <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>
 183 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 184 <h3 class="title">Warning</h3>
 185 <p><code class="literal">clutter_box_new</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use <a class="link" href="ClutterActor.html#clutter-actor-new" title="clutter_actor_new ()"><code class="function">clutter_actor_new()</code></a> instead.</p>
 186 </div>
 187 <p>
 188 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
 189 out by the passed <em class="parameter"><code>manager</code></em>
 190 </p>
 191 <div class="variablelist"><table border="0">
 192 <col align="left" valign="top">
 193 <tbody>
 194 <tr>
 195 <td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
 196 <td>a <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a>
 197 </td>
 198 </tr>
 199 <tr>
 200 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 201 <td>the newly created <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a> actor</td>
 202 </tr>
 203 </tbody>
 204 </table></div>
 205 <p class="since">Since 1.2</p>
 206 </div>
 207 <hr>
 208 <div class="refsect2">
 209 <a name="clutter-box-set-layout-manager"></a><h3>clutter_box_set_layout_manager ()</h3>
 210 <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>,
 211                                                          <em class="parameter"><code><a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> *manager</code></em>);</pre>
 212 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 213 <h3 class="title">Warning</h3>
 214 <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. 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>
 215 </div>
 216 <p>
 217 Sets the <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> for <em class="parameter"><code>box</code></em>
 218 </p>
 219 <p>
 220 A <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> is a delegate object that controls the
 221 layout of the children of <em class="parameter"><code>box</code></em>
 222 </p>
 223 <div class="variablelist"><table border="0">
 224 <col align="left" valign="top">
 225 <tbody>
 226 <tr>
 227 <td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
 228 <td>a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a>
 229 </td>
 230 </tr>
 231 <tr>
 232 <td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
 233 <td>a <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a>
 234 </td>
 235 </tr>
 236 </tbody>
 237 </table></div>
 238 <p class="since">Since 1.2</p>
 239 </div>
 240 <hr>
 241 <div class="refsect2">
 242 <a name="clutter-box-get-layout-manager"></a><h3>clutter_box_get_layout_manager ()</h3>
 243 <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>
 244 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 245 <h3 class="title">Warning</h3>
 246 <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. 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>
 247 </div>
 248 <p>
 249 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>
 250 </p>
 251 <div class="variablelist"><table border="0">
 252 <col align="left" valign="top">
 253 <tbody>
 254 <tr>
 255 <td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
 256 <td>a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a>
 257 </td>
 258 </tr>
 259 <tr>
 260 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 261 <td>a <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a>. The returned
 262 <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
 263 be unreferenced. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 264 </td>
 265 </tr>
 266 </tbody>
 267 </table></div>
 268 <p class="since">Since 1.2</p>
 269 </div>
 270 <hr>
 271 <div class="refsect2">
 272 <a name="clutter-box-set-color"></a><h3>clutter_box_set_color ()</h3>
 273 <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>,
 274                                                          <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
 275 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 276 <h3 class="title">Warning</h3>
 277 <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. 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>
 278 </div>
 279 <p>
 280 Sets (or unsets) the background color for <em class="parameter"><code>box</code></em>
 281 </p>
 282 <div class="variablelist"><table border="0">
 283 <col align="left" valign="top">
 284 <tbody>
 285 <tr>
 286 <td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
 287 <td>a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a>
 288 </td>
 289 </tr>
 290 <tr>
 291 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
 292 <td>the background color, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to unset. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 293 </td>
 294 </tr>
 295 </tbody>
 296 </table></div>
 297 <p class="since">Since 1.2</p>
 298 </div>
 299 <hr>
 300 <div class="refsect2">
 301 <a name="clutter-box-get-color"></a><h3>clutter_box_get_color ()</h3>
 302 <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>,
 303                                                          <em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
 304 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 305 <h3 class="title">Warning</h3>
 306 <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. 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>
 307 </div>
 308 <p>
 309 Retrieves the background color of <em class="parameter"><code>box</code></em>
 310 </p>
 311 <p>
 312 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
 313 returned <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> is undefined
 314 </p>
 315 <div class="variablelist"><table border="0">
 316 <col align="left" valign="top">
 317 <tbody>
 318 <tr>
 319 <td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
 320 <td>a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a>
 321 </td>
 322 </tr>
 323 <tr>
 324 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
 325 <td>return location for a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>. <span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span>
 326 </td>
 327 </tr>
 328 </tbody>
 329 </table></div>
 330 <p class="since">Since 1.2</p>
 331 </div>
 332 <hr>
 333 <div class="refsect2">
 334 <a name="clutter-box-pack"></a><h3>clutter_box_pack ()</h3>
 335 <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>,
 336                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
 337                                                          <em class="parameter"><code>const <span class="type">gchar</span> *first_property</code></em>,
 338                                                          <em class="parameter"><code>...</code></em>);</pre>
 339 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 340 <h3 class="title">Warning</h3>
 341 <p><code class="literal">clutter_box_pack</code> has been deprecated since version 1.10 and should not be used in newly-written code. 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.</p>
 342 </div>
 343 <p>
 344 Adds <em class="parameter"><code>actor</code></em> to <em class="parameter"><code>box</code></em> and sets layout properties at the same time,
 345 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
 346 </p>
 347 <p>
 348 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>
 349 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>
 350 </p>
 351 <p>
 352 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>
 353 variant instead
 354 </p>
 355 <div class="variablelist"><table border="0">
 356 <col align="left" valign="top">
 357 <tbody>
 358 <tr>
 359 <td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
 360 <td>a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a>
 361 </td>
 362 </tr>
 363 <tr>
 364 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
 365 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>
 366 </td>
 367 </tr>
 368 <tr>
 369 <td><p><span class="term"><em class="parameter"><code>first_property</code></em> :</span></p></td>
 370 <td>the name of the first property to set, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 371 </td>
 372 </tr>
 373 <tr>
 374 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 375 <td>a list of property name and value pairs, terminated by <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 376 </td>
 377 </tr>
 378 </tbody>
 379 </table></div>
 380 <p class="since">Since 1.2</p>
 381 </div>
 382 <hr>
 383 <div class="refsect2">
 384 <a name="clutter-box-packv"></a><h3>clutter_box_packv ()</h3>
 385 <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>,
 386                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
 387                                                          <em class="parameter"><code><span class="type">guint</span> n_properties</code></em>,
 388                                                          <em class="parameter"><code>const <span class="type">gchar</span> * const properties[]</code></em>,
 389                                                          <em class="parameter"><code>const <span class="type">GValue</span> *values</code></em>);</pre>
 390 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 391 <h3 class="title">Warning</h3>
 392 <p><code class="literal">clutter_box_packv</code> has been deprecated since version 1.10 and should not be used in newly-written code. 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.</p>
 393 </div>
 394 <p>
 395 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
 396 bindings to use
 397 </p>
 398 <div class="variablelist"><table border="0">
 399 <col align="left" valign="top">
 400 <tbody>
 401 <tr>
 402 <td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
 403 <td>a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a>
 404 </td>
 405 </tr>
 406 <tr>
 407 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
 408 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>
 409 </td>
 410 </tr>
 411 <tr>
 412 <td><p><span class="term"><em class="parameter"><code>n_properties</code></em> :</span></p></td>
 413 <td>the number of properties to set</td>
 414 </tr>
 415 <tr>
 416 <td><p><span class="term"><em class="parameter"><code>properties</code></em> :</span></p></td>
 417 <td>a vector
 418 containing the property names to set. <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>
 419 </td>
 420 </tr>
 421 <tr>
 422 <td><p><span class="term"><em class="parameter"><code>values</code></em> :</span></p></td>
 423 <td>a vector containing the property
 424 values to set. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_properties]</span>
 425 </td>
 426 </tr>
 427 </tbody>
 428 </table></div>
 429 <p class="since">Since 1.2</p>
 430 </div>
 431 <hr>
 432 <div class="refsect2">
 433 <a name="clutter-box-pack-after"></a><h3>clutter_box_pack_after ()</h3>
 434 <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>,
 435                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
 436                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *sibling</code></em>,
 437                                                          <em class="parameter"><code>const <span class="type">gchar</span> *first_property</code></em>,
 438                                                          <em class="parameter"><code>...</code></em>);</pre>
 439 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 440 <h3 class="title">Warning</h3>
 441 <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. 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.</p>
 442 </div>
 443 <p>
 444 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
 445 properties at the same time, if the <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> used by
 446 <em class="parameter"><code>box</code></em> supports them
 447 </p>
 448 <p>
 449 If <em class="parameter"><code>sibling</code></em> is <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> then <em class="parameter"><code>actor</code></em> is placed at the end of the
 450 list of children, to be allocated and painted after every other child
 451 </p>
 452 <p>
 453 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>,
 454 <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>
 455 </p>
 456 <div class="variablelist"><table border="0">
 457 <col align="left" valign="top">
 458 <tbody>
 459 <tr>
 460 <td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
 461 <td>a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a>
 462 </td>
 463 </tr>
 464 <tr>
 465 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
 466 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>
 467 </td>
 468 </tr>
 469 <tr>
 470 <td><p><span class="term"><em class="parameter"><code>sibling</code></em> :</span></p></td>
 471 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 472 </td>
 473 </tr>
 474 <tr>
 475 <td><p><span class="term"><em class="parameter"><code>first_property</code></em> :</span></p></td>
 476 <td>the name of the first property to set, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 477 </td>
 478 </tr>
 479 <tr>
 480 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 481 <td>a list of property name and value pairs, terminated by <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 482 </td>
 483 </tr>
 484 </tbody>
 485 </table></div>
 486 <p class="since">Since 1.2</p>
 487 </div>
 488 <hr>
 489 <div class="refsect2">
 490 <a name="clutter-box-pack-before"></a><h3>clutter_box_pack_before ()</h3>
 491 <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>,
 492                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
 493                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *sibling</code></em>,
 494                                                          <em class="parameter"><code>const <span class="type">gchar</span> *first_property</code></em>,
 495                                                          <em class="parameter"><code>...</code></em>);</pre>
 496 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 497 <h3 class="title">Warning</h3>
 498 <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. 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.</p>
 499 </div>
 500 <p>
 501 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
 502 properties at the same time, if the <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> used by
 503 <em class="parameter"><code>box</code></em> supports them
 504 </p>
 505 <p>
 506 If <em class="parameter"><code>sibling</code></em> is <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> then <em class="parameter"><code>actor</code></em> is placed at the beginning of the
 507 list of children, to be allocated and painted below every other child
 508 </p>
 509 <p>
 510 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>,
 511 <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>
 512 </p>
 513 <div class="variablelist"><table border="0">
 514 <col align="left" valign="top">
 515 <tbody>
 516 <tr>
 517 <td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
 518 <td>a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a>
 519 </td>
 520 </tr>
 521 <tr>
 522 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
 523 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>
 524 </td>
 525 </tr>
 526 <tr>
 527 <td><p><span class="term"><em class="parameter"><code>sibling</code></em> :</span></p></td>
 528 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 529 </td>
 530 </tr>
 531 <tr>
 532 <td><p><span class="term"><em class="parameter"><code>first_property</code></em> :</span></p></td>
 533 <td>the name of the first property to set, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 534 </td>
 535 </tr>
 536 <tr>
 537 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 538 <td>a list of property name and value pairs, terminated by <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 539 </td>
 540 </tr>
 541 </tbody>
 542 </table></div>
 543 <p class="since">Since 1.2</p>
 544 </div>
 545 <hr>
 546 <div class="refsect2">
 547 <a name="clutter-box-pack-at"></a><h3>clutter_box_pack_at ()</h3>
 548 <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>,
 549                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
 550                                                          <em class="parameter"><code><span class="type">gint</span> position</code></em>,
 551                                                          <em class="parameter"><code>const <span class="type">gchar</span> *first_property</code></em>,
 552                                                          <em class="parameter"><code>...</code></em>);</pre>
 553 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 554 <h3 class="title">Warning</h3>
 555 <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. 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.</p>
 556 </div>
 557 <p>
 558 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
 559 properties at the same time, if the <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> used by
 560 <em class="parameter"><code>box</code></em> supports them
 561 </p>
 562 <p>
 563 If <em class="parameter"><code>position</code></em> is a negative number, or is larger than the number of
 564 children of <em class="parameter"><code>box</code></em>, the new child is added at the end of the list of
 565 children
 566 </p>
 567 <div class="variablelist"><table border="0">
 568 <col align="left" valign="top">
 569 <tbody>
 570 <tr>
 571 <td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
 572 <td>a <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a>
 573 </td>
 574 </tr>
 575 <tr>
 576 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
 577 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>
 578 </td>
 579 </tr>
 580 <tr>
 581 <td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
 582 <td>the position to insert the <em class="parameter"><code>actor</code></em> at</td>
 583 </tr>
 584 <tr>
 585 <td><p><span class="term"><em class="parameter"><code>first_property</code></em> :</span></p></td>
 586 <td>the name of the first property to set, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 587 </td>
 588 </tr>
 589 <tr>
 590 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 591 <td>a list of property name and value pairs, terminated by <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 592 </td>
 593 </tr>
 594 </tbody>
 595 </table></div>
 596 <p class="since">Since 1.2</p>
 597 </div>
 598 </div>
 599 <div class="refsect1">
 600 <a name="ClutterBox.property-details"></a><h2>Property Details</h2>
 601 <div class="refsect2">
 602 <a name="ClutterBox--color"></a><h3>The <code class="literal">"color"</code> property</h3>
 603 <pre class="programlisting">  "color"                    <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write</pre>
 604 <p>
 605 The color to be used to paint the background of the
 606 <a class="link" href="ClutterBox.html" title="ClutterBox"><span class="type">ClutterBox</span></a>. Setting this property will set the
 607 <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
 608 </p>
 609 <p class="since">Since 1.2</p>
 610 </div>
 611 <hr>
 612 <div class="refsect2">
 613 <a name="ClutterBox--color-set"></a><h3>The <code class="literal">"color-set"</code> property</h3>
 614 <pre class="programlisting">  "color-set"                <span class="type">gboolean</span>              : Read / Write</pre>
 615 <p>
 616 Whether the <a class="link" href="ClutterBox.html#ClutterBox--color" title='The "color" property'><span class="type">"color"</span></a> property has been set
 617 </p>
 618 <p>Default value: FALSE</p>
 619 <p class="since">Since 1.2</p>
 620 </div>
 621 </div>
 622 </div>
 623 <div class="footer">
 624 <hr>
 625           Generated by GTK-Doc V1.18.1</div>
 626 </body>
 627 </html>