doc/reference/clutter/html/ClutterContainer.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>ClutterContainer</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="ch01.html" title="Abstract classes and interfaces">
   9 <link rel="prev" href="ClutterActor.html" title="ClutterActor">
  10 <link rel="next" href="ClutterChildMeta.html" title="ClutterChildMeta">
  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="ClutterActor.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.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="ClutterChildMeta.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="#ClutterContainer.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterContainer.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterContainer.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterContainer.prerequisites" class="shortcut">Prerequisites</a>
  31                    |
  32                   <a href="#ClutterContainer.implementations" class="shortcut">Known Implementations</a>
  33                    |
  34                   <a href="#ClutterContainer.signals" class="shortcut">Signals</a>
  35 </td></tr>
  36 </table>
  37 <div class="refentry">
  38 <a name="ClutterContainer"></a><div class="titlepage"></div>
  39 <div class="refnamediv"><table width="100%"><tr>
  40 <td valign="top">
  41 <h2><span class="refentrytitle"><a name="ClutterContainer.top_of_page"></a>ClutterContainer</span></h2>
  42 <p>ClutterContainer — An interface for container actors</p>
  43 </td>
  44 <td valign="top" align="right"></td>
  45 </tr></table></div>
  46 <div class="refsynopsisdiv">
  47 <a name="ClutterContainer.synopsis"></a><h2>Synopsis</h2>
  48 <pre class="synopsis">                    <a class="link" href="ClutterContainer.html#ClutterContainer-struct" title="ClutterContainer">ClutterContainer</a>;
  49 struct              <a class="link" href="ClutterContainer.html#ClutterContainerIface" title="struct ClutterContainerIface">ClutterContainerIface</a>;
  50 <span class="returnvalue">void</span>                <a class="link" href="ClutterContainer.html#clutter-container-add-actor" title="clutter_container_add_actor ()">clutter_container_add_actor</a>         (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
  51                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);
  52 <span class="returnvalue">void</span>                <a class="link" href="ClutterContainer.html#clutter-container-add" title="clutter_container_add ()">clutter_container_add</a>               (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
  53                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *first_actor</code></em>,
  54                                                          <em class="parameter"><code>...</code></em>);
  55 <span class="returnvalue">void</span>                <a class="link" href="ClutterContainer.html#clutter-container-add-valist" title="clutter_container_add_valist ()">clutter_container_add_valist</a>        (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
  56                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *first_actor</code></em>,
  57                                                          <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);
  58 <span class="returnvalue">void</span>                <a class="link" href="ClutterContainer.html#clutter-container-remove-actor" title="clutter_container_remove_actor ()">clutter_container_remove_actor</a>      (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
  59                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);
  60 <span class="returnvalue">void</span>                <a class="link" href="ClutterContainer.html#clutter-container-remove" title="clutter_container_remove ()">clutter_container_remove</a>            (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
  61                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *first_actor</code></em>,
  62                                                          <em class="parameter"><code>...</code></em>);
  63 <span class="returnvalue">void</span>                <a class="link" href="ClutterContainer.html#clutter-container-remove-valist" title="clutter_container_remove_valist ()">clutter_container_remove_valist</a>     (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
  64                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *first_actor</code></em>,
  65                                                          <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);
  66 <a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="ClutterContainer.html#clutter-container-get-children" title="clutter_container_get_children ()">clutter_container_get_children</a>      (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>);
  67 <span class="returnvalue">void</span>                <a class="link" href="ClutterContainer.html#clutter-container-foreach" title="clutter_container_foreach ()">clutter_container_foreach</a>           (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
  68                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html#ClutterCallback" title="ClutterCallback ()"><span class="type">ClutterCallback</span></a> callback</code></em>,
  69                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
  70 <span class="returnvalue">void</span>                <a class="link" href="ClutterContainer.html#clutter-container-foreach-with-internals" title="clutter_container_foreach_with_internals ()">clutter_container_foreach_with_internals</a>
  71                                                         (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
  72                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html#ClutterCallback" title="ClutterCallback ()"><span class="type">ClutterCallback</span></a> callback</code></em>,
  73                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
  74
  75 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="ClutterContainer.html#clutter-container-find-child-by-name" title="clutter_container_find_child_by_name ()">clutter_container_find_child_by_name</a>
  76                                                         (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
  77                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *child_name</code></em>);
  78 <span class="returnvalue">void</span>                <a class="link" href="ClutterContainer.html#clutter-container-raise-child" title="clutter_container_raise_child ()">clutter_container_raise_child</a>       (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
  79                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
  80                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *sibling</code></em>);
  81 <span class="returnvalue">void</span>                <a class="link" href="ClutterContainer.html#clutter-container-lower-child" title="clutter_container_lower_child ()">clutter_container_lower_child</a>       (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
  82                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
  83                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *sibling</code></em>);
  84 <span class="returnvalue">void</span>                <a class="link" href="ClutterContainer.html#clutter-container-sort-depth-order" title="clutter_container_sort_depth_order ()">clutter_container_sort_depth_order</a>  (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>);
  85
  86 <a href="../gobject/gobject-GParamSpec.html#GParamSpec"><span class="returnvalue">GParamSpec</span></a> *        <a class="link" href="ClutterContainer.html#clutter-container-class-find-child-property" title="clutter_container_class_find_child_property ()">clutter_container_class_find_child_property</a>
  87                                                         (<em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> *klass</code></em>,
  88                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>);
  89 <a href="../gobject/gobject-GParamSpec.html#GParamSpec"><span class="returnvalue">GParamSpec</span></a> **       <a class="link" href="ClutterContainer.html#clutter-container-class-list-child-properties" title="clutter_container_class_list_child_properties ()">clutter_container_class_list_child_properties</a>
  90                                                         (<em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> *klass</code></em>,
  91                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *n_properties</code></em>);
  92 <span class="returnvalue">void</span>                <a class="link" href="ClutterContainer.html#clutter-container-child-set-property" title="clutter_container_child_set_property ()">clutter_container_child_set_property</a>
  93                                                         (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
  94                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *child</code></em>,
  95                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property</code></em>,
  96                                                          <em class="parameter"><code>const <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
  97 <span class="returnvalue">void</span>                <a class="link" href="ClutterContainer.html#clutter-container-child-get-property" title="clutter_container_child_get_property ()">clutter_container_child_get_property</a>
  98                                                         (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
  99                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *child</code></em>,
 100                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property</code></em>,
 101                                                          <em class="parameter"><code><a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
 102 <span class="returnvalue">void</span>                <a class="link" href="ClutterContainer.html#clutter-container-child-set" title="clutter_container_child_set ()">clutter_container_child_set</a>         (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 103                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
 104                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *first_prop</code></em>,
 105                                                          <em class="parameter"><code>...</code></em>);
 106 <span class="returnvalue">void</span>                <a class="link" href="ClutterContainer.html#clutter-container-child-get" title="clutter_container_child_get ()">clutter_container_child_get</a>         (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 107                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
 108                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *first_prop</code></em>,
 109                                                          <em class="parameter"><code>...</code></em>);
 110 <span class="returnvalue">void</span>                <a class="link" href="ClutterContainer.html#clutter-container-child-notify" title="clutter_container_child_notify ()">clutter_container_child_notify</a>      (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 111                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *child</code></em>,
 112                                                          <em class="parameter"><code><a href="../gobject/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> *pspec</code></em>);
 113
 114 <span class="returnvalue">void</span>                <a class="link" href="ClutterContainer.html#clutter-container-create-child-meta" title="clutter_container_create_child_meta ()">clutter_container_create_child_meta</a> (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 115                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);
 116 <span class="returnvalue">void</span>                <a class="link" href="ClutterContainer.html#clutter-container-destroy-child-meta" title="clutter_container_destroy_child_meta ()">clutter_container_destroy_child_meta</a>
 117                                                         (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 118                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);
 119 <a class="link" href="ClutterChildMeta.html" title="ClutterChildMeta"><span class="returnvalue">ClutterChildMeta</span></a> *  <a class="link" href="ClutterContainer.html#clutter-container-get-child-meta" title="clutter_container_get_child_meta ()">clutter_container_get_child_meta</a>    (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 120                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);
 121 </pre>
 122 </div>
 123 <div class="refsect1">
 124 <a name="ClutterContainer.object-hierarchy"></a><h2>Object Hierarchy</h2>
 125 <pre class="synopsis">
 126   GInterface
 127    +----ClutterContainer
 128 </pre>
 129 </div>
 130 <div class="refsect1">
 131 <a name="ClutterContainer.prerequisites"></a><h2>Prerequisites</h2>
 132 <p>
 133 ClutterContainer requires
 134  <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
 135 </div>
 136 <div class="refsect1">
 137 <a name="ClutterContainer.implementations"></a><h2>Known Implementations</h2>
 138 <p>
 139 ClutterContainer is implemented by
 140  <a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>,  <a class="link" href="ClutterBox.html" title="ClutterBox">ClutterBox</a>,  <a class="link" href="ClutterCairoTexture.html" title="ClutterCairoTexture">ClutterCairoTexture</a>,  <a class="link" href="ClutterClone.html" title="ClutterClone">ClutterClone</a>,  <a class="link" href="ClutterGroup.html" title="ClutterGroup">ClutterGroup</a>,  <a class="link" href="ClutterRectangle.html" title="ClutterRectangle">ClutterRectangle</a>,  <a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a>,  <a class="link" href="ClutterText.html" title="ClutterText">ClutterText</a> and  <a class="link" href="ClutterTexture.html" title="ClutterTexture">ClutterTexture</a>.</p>
 141 </div>
 142 <div class="refsect1">
 143 <a name="ClutterContainer.signals"></a><h2>Signals</h2>
 144 <pre class="synopsis">
 145   "<a class="link" href="ClutterContainer.html#ClutterContainer-actor-added" title='The "actor-added" signal'>actor-added</a>"                                    : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
 146   "<a class="link" href="ClutterContainer.html#ClutterContainer-actor-removed" title='The "actor-removed" signal'>actor-removed</a>"                                  : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
 147   "<a class="link" href="ClutterContainer.html#ClutterContainer-child-notify" title='The "child-notify" signal'>child-notify</a>"                                   : <a href="../gobject/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS"><code class="literal">Has Details</code></a>
 148 </pre>
 149 </div>
 150 <div class="refsect1">
 151 <a name="ClutterContainer.description"></a><h2>Description</h2>
 152 <p>
 153 <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> is an interface implemented by <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>, and
 154 it provides some common API for notifying when a child actor is added
 155 or removed, as well as the infrastructure for accessing child properties
 156 through <a class="link" href="ClutterChildMeta.html" title="ClutterChildMeta"><span class="type">ClutterChildMeta</span></a>.
 157 </p>
 158 <p>
 159 Until Clutter 1.10, the <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> interface was also the public
 160 API for implementing container actors; this part of the interface has
 161 been deprecated: <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> has a default implementation which
 162 defers to <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> the child addition and removal, as well as the
 163 iteration. See the documentation of <a class="link" href="ClutterContainer.html#ClutterContainerIface" title="struct ClutterContainerIface"><span class="type">ClutterContainerIface</span></a> for the list
 164 of virtual functions that should be overridden.
 165 </p>
 166 </div>
 167 <div class="refsect1">
 168 <a name="ClutterContainer.details"></a><h2>Details</h2>
 169 <div class="refsect2">
 170 <a name="ClutterContainer-struct"></a><h3>ClutterContainer</h3>
 171 <pre class="programlisting">typedef struct _ClutterContainer ClutterContainer;</pre>
 172 <p>
 173 <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> is an opaque structure whose members cannot be directly
 174 accessed
 175 </p>
 176 <p class="since">Since 0.4</p>
 177 </div>
 178 <hr>
 179 <div class="refsect2">
 180 <a name="ClutterContainerIface"></a><h3>struct ClutterContainerIface</h3>
 181 <pre class="programlisting">struct ClutterContainerIface {
 182   void (* add)              (ClutterContainer *container,
 183                              ClutterActor     *actor);
 184   void (* remove)           (ClutterContainer *container,
 185                              ClutterActor     *actor);
 186   void (* foreach)          (ClutterContainer *container,
 187                              ClutterCallback   callback,
 188                              gpointer          user_data);
 189
 190   void (* foreach_with_internals) (ClutterContainer *container,
 191                                    ClutterCallback   callback,
 192                                    gpointer          user_data);
 193
 194   /* child stacking */
 195   void (* raise)            (ClutterContainer *container,
 196                              ClutterActor     *actor,
 197                              ClutterActor     *sibling);
 198   void (* lower)            (ClutterContainer *container,
 199                              ClutterActor     *actor,
 200                              ClutterActor     *sibling);
 201   void (* sort_depth_order) (ClutterContainer *container);
 202
 203   /* ClutterChildMeta management */
 204   GType                child_meta_type;
 205   void              (* create_child_meta)  (ClutterContainer *container,
 206                                             ClutterActor     *actor);
 207   void              (* destroy_child_meta) (ClutterContainer *container,
 208                                             ClutterActor     *actor);
 209   ClutterChildMeta *(* get_child_meta)     (ClutterContainer *container,
 210                                             ClutterActor     *actor);
 211
 212   /* signals */
 213   void (* actor_added)   (ClutterContainer *container,
 214                           ClutterActor     *actor);
 215   void (* actor_removed) (ClutterContainer *container,
 216                           ClutterActor     *actor);
 217
 218   void (* child_notify)  (ClutterContainer *container,
 219                           ClutterActor     *child,
 220                           GParamSpec       *pspec);
 221 };
 222 </pre>
 223 <p>
 224 Base interface for container actors. The <em class="parameter"><code>add</code></em>, <em class="parameter"><code>remove</code></em> and <em class="parameter"><code>foreach</code></em>
 225 virtual functions must be provided by any implementation; the other
 226 virtual functions are optional.
 227 </p>
 228 <div class="variablelist"><table border="0">
 229 <col align="left" valign="top">
 230 <tbody>
 231 <tr>
 232 <td><p><span class="term"><em class="structfield"><code><a name="ClutterContainerIface.add"></a>add</code></em> ()</span></p></td>
 233 <td>virtual function for adding an actor to the container. This virtual
 234 function is deprecated, and it should not be overridden.</td>
 235 </tr>
 236 <tr>
 237 <td><p><span class="term"><em class="structfield"><code><a name="ClutterContainerIface.remove"></a>remove</code></em> ()</span></p></td>
 238 <td>virtual function for removing an actor from the container. This
 239 virtual function is deprecated, and it should not be overridden.</td>
 240 </tr>
 241 <tr>
 242 <td><p><span class="term"><em class="structfield"><code><a name="ClutterContainerIface.foreach"></a>foreach</code></em> ()</span></p></td>
 243 <td>virtual function for iterating over the container's children.
 244 This virtual function is deprecated, and it should not be overridden.</td>
 245 </tr>
 246 <tr>
 247 <td><p><span class="term"><em class="structfield"><code><a name="ClutterContainerIface.foreach-with-internals"></a>foreach_with_internals</code></em> ()</span></p></td>
 248 <td>virtual functions for iterating over the
 249 container's children, both added using the <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> API
 250 and internal children. The implementation of this virtual function
 251 is required only if the <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> implementation has
 252 internal children. This virtual function is deprecated, and it should
 253 not be overridden.</td>
 254 </tr>
 255 <tr>
 256 <td><p><span class="term"><em class="structfield"><code><a name="ClutterContainerIface.raise"></a>raise</code></em> ()</span></p></td>
 257 <td>virtual function for raising a child. This virtual function is
 258 deprecated and it should not be overridden.</td>
 259 </tr>
 260 <tr>
 261 <td><p><span class="term"><em class="structfield"><code><a name="ClutterContainerIface.lower"></a>lower</code></em> ()</span></p></td>
 262 <td>virtual function for lowering a child. This virtual function is
 263 deprecated and it should not be overridden.</td>
 264 </tr>
 265 <tr>
 266 <td><p><span class="term"><em class="structfield"><code><a name="ClutterContainerIface.sort-depth-order"></a>sort_depth_order</code></em> ()</span></p></td>
 267 <td>virtual function for sorting the children of a
 268 container depending on their depth. This virtual function is deprecated
 269 and it should not be overridden.</td>
 270 </tr>
 271 <tr>
 272 <td><p><span class="term"><a href="../gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> <em class="structfield"><code><a name="ClutterContainerIface.child-meta-type"></a>child_meta_type</code></em>;</span></p></td>
 273 <td>The GType used for storing auxiliary information about
 274 each of the containers children.</td>
 275 </tr>
 276 <tr>
 277 <td><p><span class="term"><em class="structfield"><code><a name="ClutterContainerIface.create-child-meta"></a>create_child_meta</code></em> ()</span></p></td>
 278 <td>virtual function that gets called for each added
 279 child, the function should instantiate an object of type
 280 <span class="type">"child_meta_type"</span>, set the container and actor
 281 fields in the instance and add the record to a data structure for
 282 subsequent access for <span class="type">"get_child_meta"</span>
 283 </td>
 284 </tr>
 285 <tr>
 286 <td><p><span class="term"><em class="structfield"><code><a name="ClutterContainerIface.destroy-child-meta"></a>destroy_child_meta</code></em> ()</span></p></td>
 287 <td>virtual function that gets called when a child is
 288 removed; it shuld release all resources held by the record</td>
 289 </tr>
 290 <tr>
 291 <td><p><span class="term"><em class="structfield"><code><a name="ClutterContainerIface.get-child-meta"></a>get_child_meta</code></em> ()</span></p></td>
 292 <td>return the record for a container child</td>
 293 </tr>
 294 <tr>
 295 <td><p><span class="term"><em class="structfield"><code><a name="ClutterContainerIface.actor-added"></a>actor_added</code></em> ()</span></p></td>
 296 <td>class handler for <a class="link" href="ClutterContainer.html#ClutterContainer-actor-added" title='The "actor-added" signal'><span class="type">"actor-added"</span></a>
 297 </td>
 298 </tr>
 299 <tr>
 300 <td><p><span class="term"><em class="structfield"><code><a name="ClutterContainerIface.actor-removed"></a>actor_removed</code></em> ()</span></p></td>
 301 <td>class handler for <a class="link" href="ClutterContainer.html#ClutterContainer-actor-removed" title='The "actor-removed" signal'><span class="type">"actor-removed"</span></a>
 302 </td>
 303 </tr>
 304 <tr>
 305 <td><p><span class="term"><em class="structfield"><code><a name="ClutterContainerIface.child-notify"></a>child_notify</code></em> ()</span></p></td>
 306 <td>class handler for <a class="link" href="ClutterContainer.html#ClutterContainer-child-notify" title='The "child-notify" signal'><span class="type">"child-notify"</span></a>
 307 </td>
 308 </tr>
 309 </tbody>
 310 </table></div>
 311 <p class="since">Since 0.4</p>
 312 </div>
 313 <hr>
 314 <div class="refsect2">
 315 <a name="clutter-container-add-actor"></a><h3>clutter_container_add_actor ()</h3>
 316 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_container_add_actor         (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 317                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);</pre>
 318 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 319 <h3 class="title">Warning</h3>
 320 <p><code class="literal">clutter_container_add_actor</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>
 321 </div>
 322 <p>
 323 Adds a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to <em class="parameter"><code>container</code></em>. This function will emit the
 324 "actor-added" signal. The actor should be parented to
 325 <em class="parameter"><code>container</code></em>. You cannot add a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to more than one
 326 <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>.
 327 </p>
 328 <p>
 329 This function will call <a class="link" href="ClutterContainer.html#ClutterContainerIface.add"><code class="function">ClutterContainerIface.add()</code></a>, which is a
 330 deprecated virtual function. The default implementation will
 331 call <a class="link" href="ClutterActor.html#clutter-actor-add-child" title="clutter_actor_add_child ()"><code class="function">clutter_actor_add_child()</code></a>.
 332 </p>
 333 <p>
 334 Virtual: add
 335 </p>
 336 <div class="variablelist"><table border="0">
 337 <col align="left" valign="top">
 338 <tbody>
 339 <tr>
 340 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
 341 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
 342 </td>
 343 </tr>
 344 <tr>
 345 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
 346 <td>the first <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to add</td>
 347 </tr>
 348 </tbody>
 349 </table></div>
 350 <p class="since">Since 0.4</p>
 351 </div>
 352 <hr>
 353 <div class="refsect2">
 354 <a name="clutter-container-add"></a><h3>clutter_container_add ()</h3>
 355 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_container_add               (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 356                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *first_actor</code></em>,
 357                                                          <em class="parameter"><code>...</code></em>);</pre>
 358 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 359 <h3 class="title">Warning</h3>
 360 <p><code class="literal">clutter_container_add</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>
 361 </div>
 362 <p>
 363 Adds a list of <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>s to <em class="parameter"><code>container</code></em>. Each time and
 364 actor is added, the "actor-added" signal is emitted. Each actor should
 365 be parented to <em class="parameter"><code>container</code></em>, which takes a reference on the actor. You
 366 cannot add a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to more than one <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>.
 367 </p>
 368 <p>
 369 This function will call <a class="link" href="ClutterContainer.html#ClutterContainerIface.add"><code class="function">ClutterContainerIface.add()</code></a>, which is a
 370 deprecated virtual function. The default implementation will
 371 call <a class="link" href="ClutterActor.html#clutter-actor-add-child" title="clutter_actor_add_child ()"><code class="function">clutter_actor_add_child()</code></a>.
 372 </p>
 373 <div class="variablelist"><table border="0">
 374 <col align="left" valign="top">
 375 <tbody>
 376 <tr>
 377 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
 378 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
 379 </td>
 380 </tr>
 381 <tr>
 382 <td><p><span class="term"><em class="parameter"><code>first_actor</code></em> :</span></p></td>
 383 <td>the first <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to add</td>
 384 </tr>
 385 <tr>
 386 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 387 <td>
 388 <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated list of actors to add</td>
 389 </tr>
 390 </tbody>
 391 </table></div>
 392 <p class="since">Since 0.4</p>
 393 </div>
 394 <hr>
 395 <div class="refsect2">
 396 <a name="clutter-container-add-valist"></a><h3>clutter_container_add_valist ()</h3>
 397 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_container_add_valist        (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 398                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *first_actor</code></em>,
 399                                                          <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);</pre>
 400 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 401 <h3 class="title">Warning</h3>
 402 <p><code class="literal">clutter_container_add_valist</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>
 403 </div>
 404 <p>
 405 Alternative va_list version of <a class="link" href="ClutterContainer.html#clutter-container-add" title="clutter_container_add ()"><code class="function">clutter_container_add()</code></a>.
 406 </p>
 407 <p>
 408 This function will call <a class="link" href="ClutterContainer.html#ClutterContainerIface.add"><code class="function">ClutterContainerIface.add()</code></a>, which is a
 409 deprecated virtual function. The default implementation will
 410 call <a class="link" href="ClutterActor.html#clutter-actor-add-child" title="clutter_actor_add_child ()"><code class="function">clutter_actor_add_child()</code></a>.
 411 </p>
 412 <div class="variablelist"><table border="0">
 413 <col align="left" valign="top">
 414 <tbody>
 415 <tr>
 416 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
 417 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
 418 </td>
 419 </tr>
 420 <tr>
 421 <td><p><span class="term"><em class="parameter"><code>first_actor</code></em> :</span></p></td>
 422 <td>the first <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to add</td>
 423 </tr>
 424 <tr>
 425 <td><p><span class="term"><em class="parameter"><code>var_args</code></em> :</span></p></td>
 426 <td>list of actors to add, followed by <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 427 </td>
 428 </tr>
 429 </tbody>
 430 </table></div>
 431 <p class="since">Since 0.4</p>
 432 </div>
 433 <hr>
 434 <div class="refsect2">
 435 <a name="clutter-container-remove-actor"></a><h3>clutter_container_remove_actor ()</h3>
 436 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_container_remove_actor      (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 437                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);</pre>
 438 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 439 <h3 class="title">Warning</h3>
 440 <p><code class="literal">clutter_container_remove_actor</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-remove-child" title="clutter_actor_remove_child ()"><code class="function">clutter_actor_remove_child()</code></a> instead.</p>
 441 </div>
 442 <p>
 443 Removes <em class="parameter"><code>actor</code></em> from <em class="parameter"><code>container</code></em>. The actor should be unparented, so
 444 if you want to keep it around you must hold a reference to it
 445 yourself, using <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-ref"><code class="function">g_object_ref()</code></a>. When the actor has been removed,
 446 the "actor-removed" signal is emitted by <em class="parameter"><code>container</code></em>.
 447 </p>
 448 <p>
 449 This function will call <a class="link" href="ClutterContainer.html#ClutterContainerIface.remove"><code class="function">ClutterContainerIface.remove()</code></a>, which is a
 450 deprecated virtual function. The default implementation will call
 451 <a class="link" href="ClutterActor.html#clutter-actor-remove-child" title="clutter_actor_remove_child ()"><code class="function">clutter_actor_remove_child()</code></a>.
 452 </p>
 453 <p>
 454 Virtual: remove
 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>container</code></em> :</span></p></td>
 461 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</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 </tbody>
 470 </table></div>
 471 <p class="since">Since 0.4</p>
 472 </div>
 473 <hr>
 474 <div class="refsect2">
 475 <a name="clutter-container-remove"></a><h3>clutter_container_remove ()</h3>
 476 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_container_remove            (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 477                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *first_actor</code></em>,
 478                                                          <em class="parameter"><code>...</code></em>);</pre>
 479 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 480 <h3 class="title">Warning</h3>
 481 <p><code class="literal">clutter_container_remove</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-remove-child" title="clutter_actor_remove_child ()"><code class="function">clutter_actor_remove_child()</code></a> instead.</p>
 482 </div>
 483 <p>
 484 Removes a <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated list of <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>s from
 485 <em class="parameter"><code>container</code></em>. Each actor should be unparented, so if you want to keep it
 486 around you must hold a reference to it yourself, using <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-ref"><code class="function">g_object_ref()</code></a>.
 487 Each time an actor is removed, the "actor-removed" signal is
 488 emitted by <em class="parameter"><code>container</code></em>.
 489 </p>
 490 <p>
 491 This function will call <a class="link" href="ClutterContainer.html#ClutterContainerIface.remove"><code class="function">ClutterContainerIface.remove()</code></a>, which is a
 492 deprecated virtual function. The default implementation will call
 493 <a class="link" href="ClutterActor.html#clutter-actor-remove-child" title="clutter_actor_remove_child ()"><code class="function">clutter_actor_remove_child()</code></a>.
 494 </p>
 495 <div class="variablelist"><table border="0">
 496 <col align="left" valign="top">
 497 <tbody>
 498 <tr>
 499 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
 500 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
 501 </td>
 502 </tr>
 503 <tr>
 504 <td><p><span class="term"><em class="parameter"><code>first_actor</code></em> :</span></p></td>
 505 <td>first <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to remove</td>
 506 </tr>
 507 <tr>
 508 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 509 <td>a <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated list of actors to remove</td>
 510 </tr>
 511 </tbody>
 512 </table></div>
 513 <p class="since">Since 0.4</p>
 514 </div>
 515 <hr>
 516 <div class="refsect2">
 517 <a name="clutter-container-remove-valist"></a><h3>clutter_container_remove_valist ()</h3>
 518 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_container_remove_valist     (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 519                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *first_actor</code></em>,
 520                                                          <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);</pre>
 521 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 522 <h3 class="title">Warning</h3>
 523 <p><code class="literal">clutter_container_remove_valist</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-remove-child" title="clutter_actor_remove_child ()"><code class="function">clutter_actor_remove_child()</code></a> instead.</p>
 524 </div>
 525 <p>
 526 Alternative va_list version of <a class="link" href="ClutterContainer.html#clutter-container-remove" title="clutter_container_remove ()"><code class="function">clutter_container_remove()</code></a>.
 527 </p>
 528 <p>
 529 This function will call <a class="link" href="ClutterContainer.html#ClutterContainerIface.remove"><code class="function">ClutterContainerIface.remove()</code></a>, which is a
 530 deprecated virtual function. The default implementation will call
 531 <a class="link" href="ClutterActor.html#clutter-actor-remove-child" title="clutter_actor_remove_child ()"><code class="function">clutter_actor_remove_child()</code></a>.
 532 </p>
 533 <div class="variablelist"><table border="0">
 534 <col align="left" valign="top">
 535 <tbody>
 536 <tr>
 537 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
 538 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
 539 </td>
 540 </tr>
 541 <tr>
 542 <td><p><span class="term"><em class="parameter"><code>first_actor</code></em> :</span></p></td>
 543 <td>the first <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to add</td>
 544 </tr>
 545 <tr>
 546 <td><p><span class="term"><em class="parameter"><code>var_args</code></em> :</span></p></td>
 547 <td>list of actors to remove, followed by <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 548 </td>
 549 </tr>
 550 </tbody>
 551 </table></div>
 552 <p class="since">Since 0.4</p>
 553 </div>
 554 <hr>
 555 <div class="refsect2">
 556 <a name="clutter-container-get-children"></a><h3>clutter_container_get_children ()</h3>
 557 <pre class="programlisting"><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             clutter_container_get_children      (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>);</pre>
 558 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 559 <h3 class="title">Warning</h3>
 560 <p><code class="literal">clutter_container_get_children</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-children" title="clutter_actor_get_children ()"><code class="function">clutter_actor_get_children()</code></a> instead.</p>
 561 </div>
 562 <p>
 563 Retrieves all the children of <em class="parameter"><code>container</code></em>.
 564 </p>
 565 <div class="variablelist"><table border="0">
 566 <col align="left" valign="top">
 567 <tbody>
 568 <tr>
 569 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
 570 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
 571 </td>
 572 </tr>
 573 <tr>
 574 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 575 <td>a list
 576 of <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>s. Use <a href="../glib/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a> on the returned
 577 list when done. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Clutter.Actor][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span>
 578 </td>
 579 </tr>
 580 </tbody>
 581 </table></div>
 582 <p class="since">Since 0.4</p>
 583 </div>
 584 <hr>
 585 <div class="refsect2">
 586 <a name="clutter-container-foreach"></a><h3>clutter_container_foreach ()</h3>
 587 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_container_foreach           (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 588                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html#ClutterCallback" title="ClutterCallback ()"><span class="type">ClutterCallback</span></a> callback</code></em>,
 589                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
 590 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 591 <h3 class="title">Warning</h3>
 592 <p><code class="literal">clutter_container_foreach</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-first-child" title="clutter_actor_get_first_child ()"><code class="function">clutter_actor_get_first_child()</code></a> or
 593   <a class="link" href="ClutterActor.html#clutter-actor-get-last-child" title="clutter_actor_get_last_child ()"><code class="function">clutter_actor_get_last_child()</code></a> to retrieve the beginning of
 594   the list of children, and <a class="link" href="ClutterActor.html#clutter-actor-get-next-sibling" title="clutter_actor_get_next_sibling ()"><code class="function">clutter_actor_get_next_sibling()</code></a>
 595   and <a class="link" href="ClutterActor.html#clutter-actor-get-previous-sibling" title="clutter_actor_get_previous_sibling ()"><code class="function">clutter_actor_get_previous_sibling()</code></a> to iterate over it;
 596   alternatively, use the <a class="link" href="ClutterActor.html#ClutterActorIter" title="ClutterActorIter"><span class="type">ClutterActorIter</span></a> API.</p>
 597 </div>
 598 <p>
 599 Calls <em class="parameter"><code>callback</code></em> for each child of <em class="parameter"><code>container</code></em> that was added
 600 by the application (with <a class="link" href="ClutterContainer.html#clutter-container-add-actor" title="clutter_container_add_actor ()"><code class="function">clutter_container_add_actor()</code></a>). Does
 601 not iterate over "internal" children that are part of the
 602 container's own implementation, if any.
 603 </p>
 604 <p>
 605 This function calls the <a class="link" href="ClutterContainer.html#ClutterContainerIface.foreach"><code class="function">ClutterContainerIface.foreach()</code></a>
 606 virtual function, which has been deprecated.
 607 </p>
 608 <div class="variablelist"><table border="0">
 609 <col align="left" valign="top">
 610 <tbody>
 611 <tr>
 612 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
 613 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
 614 </td>
 615 </tr>
 616 <tr>
 617 <td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 618 <td>a function to be called for each child. <span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span>
 619 </td>
 620 </tr>
 621 <tr>
 622 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 623 <td>data to be passed to the function, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 624 </td>
 625 </tr>
 626 </tbody>
 627 </table></div>
 628 <p class="since">Since 0.4</p>
 629 </div>
 630 <hr>
 631 <div class="refsect2">
 632 <a name="clutter-container-foreach-with-internals"></a><h3>clutter_container_foreach_with_internals ()</h3>
 633 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_container_foreach_with_internals
 634                                                         (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 635                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html#ClutterCallback" title="ClutterCallback ()"><span class="type">ClutterCallback</span></a> callback</code></em>,
 636                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
 637 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 638 <h3 class="title">Warning</h3>
 639 <p><code class="literal">clutter_container_foreach_with_internals</code> has been deprecated since version 1.10 and should not be used in newly-written code. See <a class="link" href="ClutterContainer.html#clutter-container-foreach" title="clutter_container_foreach ()"><code class="function">clutter_container_foreach()</code></a>.</p>
 640 </div>
 641 <p>
 642 Calls <em class="parameter"><code>callback</code></em> for each child of <em class="parameter"><code>container</code></em>, including "internal"
 643 children built in to the container itself that were never added
 644 by the application.
 645 </p>
 646 <p>
 647 This function calls the <a class="link" href="ClutterContainer.html#ClutterContainerIface.foreach-with-internals"><code class="function">ClutterContainerIface.foreach_with_internals()</code></a>
 648 virtual function, which has been deprecated.
 649 </p>
 650 <div class="variablelist"><table border="0">
 651 <col align="left" valign="top">
 652 <tbody>
 653 <tr>
 654 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
 655 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
 656 </td>
 657 </tr>
 658 <tr>
 659 <td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 660 <td>a function to be called for each child. <span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span>
 661 </td>
 662 </tr>
 663 <tr>
 664 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 665 <td>data to be passed to the function, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 666 </td>
 667 </tr>
 668 </tbody>
 669 </table></div>
 670 <p class="since">Since 1.0</p>
 671 </div>
 672 <hr>
 673 <div class="refsect2">
 674 <a name="clutter-container-find-child-by-name"></a><h3>clutter_container_find_child_by_name ()</h3>
 675 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_container_find_child_by_name
 676                                                         (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 677                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *child_name</code></em>);</pre>
 678 <p>
 679 Finds a child actor of a container by its name. Search recurses
 680 into any child container.
 681 </p>
 682 <div class="variablelist"><table border="0">
 683 <col align="left" valign="top">
 684 <tbody>
 685 <tr>
 686 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
 687 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
 688 </td>
 689 </tr>
 690 <tr>
 691 <td><p><span class="term"><em class="parameter"><code>child_name</code></em> :</span></p></td>
 692 <td>the name of the requested child.</td>
 693 </tr>
 694 <tr>
 695 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 696 <td>The child actor with the requested name,
 697 or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if no actor with that name was found. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 698 </td>
 699 </tr>
 700 </tbody>
 701 </table></div>
 702 <p class="since">Since 0.6</p>
 703 </div>
 704 <hr>
 705 <div class="refsect2">
 706 <a name="clutter-container-raise-child"></a><h3>clutter_container_raise_child ()</h3>
 707 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_container_raise_child       (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 708                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
 709                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *sibling</code></em>);</pre>
 710 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 711 <h3 class="title">Warning</h3>
 712 <p><code class="literal">clutter_container_raise_child</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-child-above-sibling" title="clutter_actor_set_child_above_sibling ()"><code class="function">clutter_actor_set_child_above_sibling()</code></a> instead.</p>
 713 </div>
 714 <p>
 715 Raises <em class="parameter"><code>actor</code></em> to <em class="parameter"><code>sibling</code></em> level, in the depth ordering.
 716 </p>
 717 <p>
 718 This function calls the <a class="link" href="ClutterContainer.html#ClutterContainerIface.raise"><code class="function">ClutterContainerIface.raise()</code></a> virtual function,
 719 which has been deprecated. The default implementation will call
 720 <a class="link" href="ClutterActor.html#clutter-actor-set-child-above-sibling" title="clutter_actor_set_child_above_sibling ()"><code class="function">clutter_actor_set_child_above_sibling()</code></a>.
 721 </p>
 722 <p>
 723 Virtual: raise
 724 </p>
 725 <div class="variablelist"><table border="0">
 726 <col align="left" valign="top">
 727 <tbody>
 728 <tr>
 729 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
 730 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
 731 </td>
 732 </tr>
 733 <tr>
 734 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
 735 <td>the actor to raise</td>
 736 </tr>
 737 <tr>
 738 <td><p><span class="term"><em class="parameter"><code>sibling</code></em> :</span></p></td>
 739 <td>the sibling to raise to, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> to raise
 740 to the top. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 741 </td>
 742 </tr>
 743 </tbody>
 744 </table></div>
 745 <p class="since">Since 0.6</p>
 746 </div>
 747 <hr>
 748 <div class="refsect2">
 749 <a name="clutter-container-lower-child"></a><h3>clutter_container_lower_child ()</h3>
 750 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_container_lower_child       (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 751                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
 752                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *sibling</code></em>);</pre>
 753 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 754 <h3 class="title">Warning</h3>
 755 <p><code class="literal">clutter_container_lower_child</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-child-below-sibling" title="clutter_actor_set_child_below_sibling ()"><code class="function">clutter_actor_set_child_below_sibling()</code></a> instead.</p>
 756 </div>
 757 <p>
 758 Lowers <em class="parameter"><code>actor</code></em> to <em class="parameter"><code>sibling</code></em> level, in the depth ordering.
 759 </p>
 760 <p>
 761 This function calls the <a class="link" href="ClutterContainer.html#ClutterContainerIface.lower"><code class="function">ClutterContainerIface.lower()</code></a> virtual function,
 762 which has been deprecated. The default implementation will call
 763 <a class="link" href="ClutterActor.html#clutter-actor-set-child-below-sibling" title="clutter_actor_set_child_below_sibling ()"><code class="function">clutter_actor_set_child_below_sibling()</code></a>.
 764 </p>
 765 <p>
 766 Virtual: lower
 767 </p>
 768 <div class="variablelist"><table border="0">
 769 <col align="left" valign="top">
 770 <tbody>
 771 <tr>
 772 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
 773 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
 774 </td>
 775 </tr>
 776 <tr>
 777 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
 778 <td>the actor to raise</td>
 779 </tr>
 780 <tr>
 781 <td><p><span class="term"><em class="parameter"><code>sibling</code></em> :</span></p></td>
 782 <td>the sibling to lower to, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> to lower
 783 to the bottom. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 784 </td>
 785 </tr>
 786 </tbody>
 787 </table></div>
 788 <p class="since">Since 0.6</p>
 789 </div>
 790 <hr>
 791 <div class="refsect2">
 792 <a name="clutter-container-sort-depth-order"></a><h3>clutter_container_sort_depth_order ()</h3>
 793 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_container_sort_depth_order  (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>);</pre>
 794 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 795 <h3 class="title">Warning</h3>
 796 <p><code class="literal">clutter_container_sort_depth_order</code> has been deprecated since version 1.10 and should not be used in newly-written code. The <a class="link" href="ClutterContainer.html#ClutterContainerIface.sort-depth-order"><code class="function">ClutterContainerIface.sort_depth_order()</code></a> virtual
 797   function should not be used any more; the default implementation in
 798   <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> does not do anything.</p>
 799 </div>
 800 <p>
 801 Sorts a container's children using their depth. This function should not
 802 be normally used by applications.
 803 </p>
 804 <div class="variablelist"><table border="0">
 805 <col align="left" valign="top">
 806 <tbody><tr>
 807 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
 808 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
 809 </td>
 810 </tr></tbody>
 811 </table></div>
 812 <p class="since">Since 0.6</p>
 813 </div>
 814 <hr>
 815 <div class="refsect2">
 816 <a name="clutter-container-class-find-child-property"></a><h3>clutter_container_class_find_child_property ()</h3>
 817 <pre class="programlisting"><a href="../gobject/gobject-GParamSpec.html#GParamSpec"><span class="returnvalue">GParamSpec</span></a> *        clutter_container_class_find_child_property
 818                                                         (<em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> *klass</code></em>,
 819                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>);</pre>
 820 <p>
 821 Looks up the <a href="../gobject/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> for a child property of <em class="parameter"><code>klass</code></em>.
 822 </p>
 823 <div class="variablelist"><table border="0">
 824 <col align="left" valign="top">
 825 <tbody>
 826 <tr>
 827 <td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
 828 <td>a <a href="../gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> implementing the <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> interface.</td>
 829 </tr>
 830 <tr>
 831 <td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
 832 <td>a property name.</td>
 833 </tr>
 834 <tr>
 835 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 836 <td>The <a href="../gobject/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> for the property or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 837 if no such property exist. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 838 </td>
 839 </tr>
 840 </tbody>
 841 </table></div>
 842 <p class="since">Since 0.8</p>
 843 </div>
 844 <hr>
 845 <div class="refsect2">
 846 <a name="clutter-container-class-list-child-properties"></a><h3>clutter_container_class_list_child_properties ()</h3>
 847 <pre class="programlisting"><a href="../gobject/gobject-GParamSpec.html#GParamSpec"><span class="returnvalue">GParamSpec</span></a> **       clutter_container_class_list_child_properties
 848                                                         (<em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> *klass</code></em>,
 849                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *n_properties</code></em>);</pre>
 850 <p>
 851 Returns an array of <a href="../gobject/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> for all child properties.
 852 </p>
 853 <div class="variablelist"><table border="0">
 854 <col align="left" valign="top">
 855 <tbody>
 856 <tr>
 857 <td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
 858 <td>a <a href="../gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> implementing the <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> interface.</td>
 859 </tr>
 860 <tr>
 861 <td><p><span class="term"><em class="parameter"><code>n_properties</code></em> :</span></p></td>
 862 <td>return location for length of returned array.</td>
 863 </tr>
 864 <tr>
 865 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 866 <td>an array
 867 of <a href="../gobject/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a>s which should be freed after use. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_properties][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 868 </td>
 869 </tr>
 870 </tbody>
 871 </table></div>
 872 <p class="since">Since 0.8</p>
 873 </div>
 874 <hr>
 875 <div class="refsect2">
 876 <a name="clutter-container-child-set-property"></a><h3>clutter_container_child_set_property ()</h3>
 877 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_container_child_set_property
 878                                                         (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 879                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *child</code></em>,
 880                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property</code></em>,
 881                                                          <em class="parameter"><code>const <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
 882 <p>
 883 Sets a container-specific property on a child of <em class="parameter"><code>container</code></em>.
 884 </p>
 885 <div class="variablelist"><table border="0">
 886 <col align="left" valign="top">
 887 <tbody>
 888 <tr>
 889 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
 890 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
 891 </td>
 892 </tr>
 893 <tr>
 894 <td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
 895 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> that is a child of <em class="parameter"><code>container</code></em>.</td>
 896 </tr>
 897 <tr>
 898 <td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
 899 <td>the name of the property to set.</td>
 900 </tr>
 901 <tr>
 902 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 903 <td>the value.</td>
 904 </tr>
 905 </tbody>
 906 </table></div>
 907 <p class="since">Since 0.8</p>
 908 </div>
 909 <hr>
 910 <div class="refsect2">
 911 <a name="clutter-container-child-get-property"></a><h3>clutter_container_child_get_property ()</h3>
 912 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_container_child_get_property
 913                                                         (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 914                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *child</code></em>,
 915                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property</code></em>,
 916                                                          <em class="parameter"><code><a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
 917 <p>
 918 Gets a container specific property of a child of <em class="parameter"><code>container</code></em>, In general,
 919 a copy is made of the property contents and the caller is responsible for
 920 freeing the memory by calling <a href="../gobject/gobject-Generic-values.html#g-value-unset"><code class="function">g_value_unset()</code></a>.
 921 </p>
 922 <p>
 923 Note that <a class="link" href="ClutterContainer.html#clutter-container-child-set-property" title="clutter_container_child_set_property ()"><code class="function">clutter_container_child_set_property()</code></a> is really intended for
 924 language bindings, <a class="link" href="ClutterContainer.html#clutter-container-child-set" title="clutter_container_child_set ()"><code class="function">clutter_container_child_set()</code></a> is much more convenient
 925 for C programming.
 926 </p>
 927 <div class="variablelist"><table border="0">
 928 <col align="left" valign="top">
 929 <tbody>
 930 <tr>
 931 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
 932 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
 933 </td>
 934 </tr>
 935 <tr>
 936 <td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
 937 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> that is a child of <em class="parameter"><code>container</code></em>.</td>
 938 </tr>
 939 <tr>
 940 <td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
 941 <td>the name of the property to set.</td>
 942 </tr>
 943 <tr>
 944 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 945 <td>the value.</td>
 946 </tr>
 947 </tbody>
 948 </table></div>
 949 <p class="since">Since 0.8</p>
 950 </div>
 951 <hr>
 952 <div class="refsect2">
 953 <a name="clutter-container-child-set"></a><h3>clutter_container_child_set ()</h3>
 954 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_container_child_set         (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 955                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
 956                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *first_prop</code></em>,
 957                                                          <em class="parameter"><code>...</code></em>);</pre>
 958 <p>
 959 Sets container specific properties on the child of a container.
 960 </p>
 961 <div class="variablelist"><table border="0">
 962 <col align="left" valign="top">
 963 <tbody>
 964 <tr>
 965 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
 966 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
 967 </td>
 968 </tr>
 969 <tr>
 970 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
 971 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> that is a child of <em class="parameter"><code>container</code></em>.</td>
 972 </tr>
 973 <tr>
 974 <td><p><span class="term"><em class="parameter"><code>first_prop</code></em> :</span></p></td>
 975 <td>name of the first property to be set.</td>
 976 </tr>
 977 <tr>
 978 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 979 <td>value for the first property, followed optionally by more name/value
 980 pairs terminated with NULL.</td>
 981 </tr>
 982 </tbody>
 983 </table></div>
 984 <p class="since">Since 0.8</p>
 985 </div>
 986 <hr>
 987 <div class="refsect2">
 988 <a name="clutter-container-child-get"></a><h3>clutter_container_child_get ()</h3>
 989 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_container_child_get         (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
 990                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
 991                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *first_prop</code></em>,
 992                                                          <em class="parameter"><code>...</code></em>);</pre>
 993 <p>
 994 Gets <em class="parameter"><code>container</code></em> specific properties of an actor.
 995 </p>
 996 <p>
 997 In general, a copy is made of the property contents and the caller is
 998 responsible for freeing the memory in the appropriate manner for the type, for
 999 instance by calling <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> or <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.
1000 </p>
1001 <div class="variablelist"><table border="0">
1002 <col align="left" valign="top">
1003 <tbody>
1004 <tr>
1005 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
1006 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
1007 </td>
1008 </tr>
1009 <tr>
1010 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
1011 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> that is a child of <em class="parameter"><code>container</code></em>.</td>
1012 </tr>
1013 <tr>
1014 <td><p><span class="term"><em class="parameter"><code>first_prop</code></em> :</span></p></td>
1015 <td>name of the first property to be set.</td>
1016 </tr>
1017 <tr>
1018 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1019 <td>value for the first property, followed optionally by more name/value
1020 pairs terminated with NULL.</td>
1021 </tr>
1022 </tbody>
1023 </table></div>
1024 <p class="since">Since 0.8</p>
1025 </div>
1026 <hr>
1027 <div class="refsect2">
1028 <a name="clutter-container-child-notify"></a><h3>clutter_container_child_notify ()</h3>
1029 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_container_child_notify      (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
1030                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *child</code></em>,
1031                                                          <em class="parameter"><code><a href="../gobject/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> *pspec</code></em>);</pre>
1032 <p>
1033 Calls the <a class="link" href="ClutterContainer.html#ClutterContainerIface.child-notify"><code class="function">ClutterContainerIface.child_notify()</code></a> virtual function
1034 of <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>. The default implementation will emit the
1035 <a class="link" href="ClutterContainer.html#ClutterContainer-child-notify" title='The "child-notify" signal'><span class="type">"child-notify"</span></a> signal.
1036 </p>
1037 <div class="variablelist"><table border="0">
1038 <col align="left" valign="top">
1039 <tbody>
1040 <tr>
1041 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
1042 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
1043 </td>
1044 </tr>
1045 <tr>
1046 <td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
1047 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>
1048 </td>
1049 </tr>
1050 <tr>
1051 <td><p><span class="term"><em class="parameter"><code>pspec</code></em> :</span></p></td>
1052 <td>a <a href="../gobject/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a>
1053 </td>
1054 </tr>
1055 </tbody>
1056 </table></div>
1057 <p class="since">Since 1.6</p>
1058 </div>
1059 <hr>
1060 <div class="refsect2">
1061 <a name="clutter-container-create-child-meta"></a><h3>clutter_container_create_child_meta ()</h3>
1062 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_container_create_child_meta (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
1063                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);</pre>
1064 <p>
1065 Creates the <a class="link" href="ClutterChildMeta.html" title="ClutterChildMeta"><span class="type">ClutterChildMeta</span></a> wrapping <em class="parameter"><code>actor</code></em> inside the
1066 <em class="parameter"><code>container</code></em>, if the <span class="type">"child_meta_type"</span>
1067 class member is not set to <a href="../gobject/gobject-Type-Information.html#G-TYPE-INVALID:CAPS"><code class="literal">G_TYPE_INVALID</code></a>.
1068 </p>
1069 <p>
1070 This function is only useful when adding a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to
1071 a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> implementation outside of the
1072 <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>::<code class="function">add()</code> virtual function implementation.
1073 </p>
1074 <p>
1075 Applications should not call this function.
1076 </p>
1077 <div class="variablelist"><table border="0">
1078 <col align="left" valign="top">
1079 <tbody>
1080 <tr>
1081 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
1082 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
1083 </td>
1084 </tr>
1085 <tr>
1086 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
1087 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>
1088 </td>
1089 </tr>
1090 </tbody>
1091 </table></div>
1092 <p class="since">Since 1.2</p>
1093 </div>
1094 <hr>
1095 <div class="refsect2">
1096 <a name="clutter-container-destroy-child-meta"></a><h3>clutter_container_destroy_child_meta ()</h3>
1097 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_container_destroy_child_meta
1098                                                         (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
1099                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);</pre>
1100 <p>
1101 Destroys the <a class="link" href="ClutterChildMeta.html" title="ClutterChildMeta"><span class="type">ClutterChildMeta</span></a> wrapping <em class="parameter"><code>actor</code></em> inside the
1102 <em class="parameter"><code>container</code></em>, if any.
1103 </p>
1104 <p>
1105 This function is only useful when removing a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to
1106 a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> implementation outside of the
1107 <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>::<code class="function">add()</code> virtual function implementation.
1108 </p>
1109 <p>
1110 Applications should not call this function.
1111 </p>
1112 <div class="variablelist"><table border="0">
1113 <col align="left" valign="top">
1114 <tbody>
1115 <tr>
1116 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
1117 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
1118 </td>
1119 </tr>
1120 <tr>
1121 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
1122 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>
1123 </td>
1124 </tr>
1125 </tbody>
1126 </table></div>
1127 <p class="since">Since 1.2</p>
1128 </div>
1129 <hr>
1130 <div class="refsect2">
1131 <a name="clutter-container-get-child-meta"></a><h3>clutter_container_get_child_meta ()</h3>
1132 <pre class="programlisting"><a class="link" href="ClutterChildMeta.html" title="ClutterChildMeta"><span class="returnvalue">ClutterChildMeta</span></a> *  clutter_container_get_child_meta    (<em class="parameter"><code><a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container</code></em>,
1133                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);</pre>
1134 <p>
1135 Retrieves the <a class="link" href="ClutterChildMeta.html" title="ClutterChildMeta"><span class="type">ClutterChildMeta</span></a> which contains the data about the
1136 <em class="parameter"><code>container</code></em> specific state for <em class="parameter"><code>actor</code></em>.
1137 </p>
1138 <div class="variablelist"><table border="0">
1139 <col align="left" valign="top">
1140 <tbody>
1141 <tr>
1142 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
1143 <td>a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
1144 </td>
1145 </tr>
1146 <tr>
1147 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
1148 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> that is a child of <em class="parameter"><code>container</code></em>.</td>
1149 </tr>
1150 <tr>
1151 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1152 <td>the <a class="link" href="ClutterChildMeta.html" title="ClutterChildMeta"><span class="type">ClutterChildMeta</span></a> for the <em class="parameter"><code>actor</code></em> child
1153 of <em class="parameter"><code>container</code></em> or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if the specifiec actor does not exist or the
1154 container is not configured to provide <a class="link" href="ClutterChildMeta.html" title="ClutterChildMeta"><span class="type">ClutterChildMeta</span></a>s. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
1155 </td>
1156 </tr>
1157 </tbody>
1158 </table></div>
1159 <p class="since">Since 0.8</p>
1160 </div>
1161 </div>
1162 <div class="refsect1">
1163 <a name="ClutterContainer.signal-details"></a><h2>Signal Details</h2>
1164 <div class="refsect2">
1165 <a name="ClutterContainer-actor-added"></a><h3>The <code class="literal">"actor-added"</code> signal</h3>
1166 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container,
1167                                                         <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>     *actor,
1168                                                         <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>          user_data)      : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
1169 <p>
1170 The ::actor-added signal is emitted each time an actor
1171 has been added to <em class="parameter"><code>container</code></em>.
1172 </p>
1173 <div class="variablelist"><table border="0">
1174 <col align="left" valign="top">
1175 <tbody>
1176 <tr>
1177 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
1178 <td>the actor which received the signal</td>
1179 </tr>
1180 <tr>
1181 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
1182 <td>the new child that has been added to <em class="parameter"><code>container</code></em>
1183 </td>
1184 </tr>
1185 <tr>
1186 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1187 <td>user data set when the signal handler was connected.</td>
1188 </tr>
1189 </tbody>
1190 </table></div>
1191 <p class="since">Since 0.4</p>
1192 </div>
1193 <hr>
1194 <div class="refsect2">
1195 <a name="ClutterContainer-actor-removed"></a><h3>The <code class="literal">"actor-removed"</code> signal</h3>
1196 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container,
1197                                                         <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>     *actor,
1198                                                         <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>          user_data)      : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
1199 <p>
1200 The ::actor-removed signal is emitted each time an actor
1201 is removed from <em class="parameter"><code>container</code></em>.
1202 </p>
1203 <div class="variablelist"><table border="0">
1204 <col align="left" valign="top">
1205 <tbody>
1206 <tr>
1207 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
1208 <td>the actor which received the signal</td>
1209 </tr>
1210 <tr>
1211 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
1212 <td>the child that has been removed from <em class="parameter"><code>container</code></em>
1213 </td>
1214 </tr>
1215 <tr>
1216 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1217 <td>user data set when the signal handler was connected.</td>
1218 </tr>
1219 </tbody>
1220 </table></div>
1221 <p class="since">Since 0.4</p>
1222 </div>
1223 <hr>
1224 <div class="refsect2">
1225 <a name="ClutterContainer-child-notify"></a><h3>The <code class="literal">"child-notify"</code> signal</h3>
1226 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a> *container,
1227                                                         <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>     *actor,
1228                                                         <a href="../gobject/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a>       *pspec,
1229                                                         <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>          user_data)      : <a href="../gobject/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS"><code class="literal">Has Details</code></a></pre>
1230 <p>
1231 The ::child-notify signal is emitted each time a property is
1232 being set through the <a class="link" href="ClutterContainer.html#clutter-container-child-set" title="clutter_container_child_set ()"><code class="function">clutter_container_child_set()</code></a> and
1233 <a class="link" href="ClutterContainer.html#clutter-container-child-set-property" title="clutter_container_child_set_property ()"><code class="function">clutter_container_child_set_property()</code></a> calls.
1234 </p>
1235 <div class="variablelist"><table border="0">
1236 <col align="left" valign="top">
1237 <tbody>
1238 <tr>
1239 <td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
1240 <td>the container which received the signal</td>
1241 </tr>
1242 <tr>
1243 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
1244 <td>the child that has had a property set</td>
1245 </tr>
1246 <tr>
1247 <td><p><span class="term"><em class="parameter"><code>pspec</code></em> :</span></p></td>
1248 <td>the <a href="../gobject/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> of the property set. <span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GParamSpec]</span>
1249 </td>
1250 </tr>
1251 <tr>
1252 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1253 <td>user data set when the signal handler was connected.</td>
1254 </tr>
1255 </tbody>
1256 </table></div>
1257 <p class="since">Since 0.8</p>
1258 </div>
1259 </div>
1260 </div>
1261 <div class="footer">
1262 <hr>
1263           Generated by GTK-Doc V1.18.1</div>
1264 </body>
1265 </html>