doc/reference/clutter/html/ClutterGroup.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>ClutterGroup</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="Clutter Reference Manual">
   8 <link rel="up" href="deprecated.html" title="Part X. Deprecated Classes">
   9 <link rel="prev" href="ClutterBehaviourScale.html" title="ClutterBehaviourScale">
  10 <link rel="next" href="ClutterBox.html" title="ClutterBox">
  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="ClutterBehaviourScale.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="deprecated.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">Clutter Reference Manual</th>
  21 <td><a accesskey="n" href="ClutterBox.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="#ClutterGroup.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterGroup.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterGroup.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterGroup.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="ClutterGroup"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="ClutterGroup.top_of_page"></a>ClutterGroup</span></h2>
  38 <p>ClutterGroup — A fixed layout container</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="ClutterGroup.synopsis"></a><h2>Synopsis</h2>
  44 <pre class="synopsis">struct              <a class="link" href="ClutterGroup.html#ClutterGroup-struct" title="struct ClutterGroup">ClutterGroup</a>;
  45 struct              <a class="link" href="ClutterGroup.html#ClutterGroupClass" title="struct ClutterGroupClass">ClutterGroupClass</a>;
  46 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="ClutterGroup.html#clutter-group-new" title="clutter_group_new ()">clutter_group_new</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
  47 <span class="returnvalue">void</span>                <a class="link" href="ClutterGroup.html#clutter-group-remove-all" title="clutter_group_remove_all ()">clutter_group_remove_all</a>            (<em class="parameter"><code><a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> *self</code></em>);
  48 <span class="returnvalue">gint</span>                <a class="link" href="ClutterGroup.html#clutter-group-get-n-children" title="clutter_group_get_n_children ()">clutter_group_get_n_children</a>        (<em class="parameter"><code><a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> *self</code></em>);
  49 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="ClutterGroup.html#clutter-group-get-nth-child" title="clutter_group_get_nth_child ()">clutter_group_get_nth_child</a>         (<em class="parameter"><code><a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> *self</code></em>,
  50                                                          <em class="parameter"><code><span class="type">gint</span> index_</code></em>);
  51 </pre>
  52 </div>
  53 <div class="refsect1">
  54 <a name="ClutterGroup.object-hierarchy"></a><h2>Object Hierarchy</h2>
  55 <pre class="synopsis">
  56   GObject
  57    +----GInitiallyUnowned
  58          +----<a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
  59                +----ClutterGroup
  60                      +----<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a>
  61 </pre>
  62 </div>
  63 <div class="refsect1">
  64 <a name="ClutterGroup.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  65 <p>
  66 ClutterGroup implements
  67  <a class="link" href="ClutterContainer.html" title="ClutterContainer">ClutterContainer</a>,  <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>,  <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable">ClutterAnimatable</a> and  AtkImplementorIface.</p>
  68 </div>
  69 <div class="refsect1">
  70 <a name="ClutterGroup.description"></a><h2>Description</h2>
  71 <p>
  72 A <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> is an Actor which contains multiple child actors positioned
  73 relative to the <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> position. Other operations such as scaling,
  74 rotating and clipping of the group will apply to the child actors.
  75 </p>
  76 <p>
  77 A <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a>'s size is defined by the size and position of its children;
  78 it will be the smallest non-negative size that covers the right and bottom
  79 edges of all of its children.
  80 </p>
  81 <p>
  82 Setting the size on a Group using <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> methods like
  83 <a class="link" href="ClutterActor.html#clutter-actor-set-size" title="clutter_actor_set_size ()"><code class="function">clutter_actor_set_size()</code></a> will override the natural size of the Group,
  84 however this will not affect the size of the children and they may still
  85 be painted outside of the allocation of the group. One way to constrain
  86 the visible area of a <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> to a specified allocation is to
  87 explicitly set the size of the <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> and then use the
  88 <a class="link" href="ClutterActor.html#ClutterActor--clip-to-allocation" title='The "clip-to-allocation" property'><span class="type">"clip-to-allocation"</span></a> property.
  89 </p>
  90 </div>
  91 <div class="refsect1">
  92 <a name="ClutterGroup.details"></a><h2>Details</h2>
  93 <div class="refsect2">
  94 <a name="ClutterGroup-struct"></a><h3>struct ClutterGroup</h3>
  95 <pre class="programlisting">struct ClutterGroup;</pre>
  96 <p>
  97 The <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> structure contains only private data
  98 and should be accessed using the provided API
  99 </p>
 100 <p class="since">Since 0.1</p>
 101 </div>
 102 <hr>
 103 <div class="refsect2">
 104 <a name="ClutterGroupClass"></a><h3>struct ClutterGroupClass</h3>
 105 <pre class="programlisting">struct ClutterGroupClass {
 106 };
 107 </pre>
 108 <p>
 109 The <a class="link" href="ClutterGroup.html#ClutterGroupClass" title="struct ClutterGroupClass"><span class="type">ClutterGroupClass</span></a> structure contains only private data
 110 </p>
 111 <p class="since">Since 0.1</p>
 112 </div>
 113 <hr>
 114 <div class="refsect2">
 115 <a name="clutter-group-new"></a><h3>clutter_group_new ()</h3>
 116 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_group_new                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 117 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 118 <h3 class="title">Warning</h3>
 119 <p><code class="literal">clutter_group_new</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use <a class="link" href="ClutterActor.html#clutter-actor-new" title="clutter_actor_new ()"><code class="function">clutter_actor_new()</code></a> instead.</p>
 120 </div>
 121 <p>
 122 Create a new  <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a>.
 123 </p>
 124 <div class="variablelist"><table border="0">
 125 <col align="left" valign="top">
 126 <tbody><tr>
 127 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 128 <td>the newly created <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> actor</td>
 129 </tr></tbody>
 130 </table></div>
 131 </div>
 132 <hr>
 133 <div class="refsect2">
 134 <a name="clutter-group-remove-all"></a><h3>clutter_group_remove_all ()</h3>
 135 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_group_remove_all            (<em class="parameter"><code><a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> *self</code></em>);</pre>
 136 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 137 <h3 class="title">Warning</h3>
 138 <p><code class="literal">clutter_group_remove_all</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-all-children" title="clutter_actor_remove_all_children ()"><code class="function">clutter_actor_remove_all_children()</code></a> instead.</p>
 139 </div>
 140 <p>
 141 Removes all children actors from the <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a>.
 142 </p>
 143 <div class="variablelist"><table border="0">
 144 <col align="left" valign="top">
 145 <tbody><tr>
 146 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 147 <td>A <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a>
 148 </td>
 149 </tr></tbody>
 150 </table></div>
 151 </div>
 152 <hr>
 153 <div class="refsect2">
 154 <a name="clutter-group-get-n-children"></a><h3>clutter_group_get_n_children ()</h3>
 155 <pre class="programlisting"><span class="returnvalue">gint</span>                clutter_group_get_n_children        (<em class="parameter"><code><a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> *self</code></em>);</pre>
 156 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 157 <h3 class="title">Warning</h3>
 158 <p><code class="literal">clutter_group_get_n_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-n-children" title="clutter_actor_get_n_children ()"><code class="function">clutter_actor_get_n_children()</code></a> instead.</p>
 159 </div>
 160 <p>
 161 Gets the number of actors held in the group.
 162 </p>
 163 <div class="variablelist"><table border="0">
 164 <col align="left" valign="top">
 165 <tbody>
 166 <tr>
 167 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 168 <td>A <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a>
 169 </td>
 170 </tr>
 171 <tr>
 172 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 173 <td>The number of child actors held in the group.</td>
 174 </tr>
 175 </tbody>
 176 </table></div>
 177 <p class="since">Since 0.2</p>
 178 </div>
 179 <hr>
 180 <div class="refsect2">
 181 <a name="clutter-group-get-nth-child"></a><h3>clutter_group_get_nth_child ()</h3>
 182 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_group_get_nth_child         (<em class="parameter"><code><a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> *self</code></em>,
 183                                                          <em class="parameter"><code><span class="type">gint</span> index_</code></em>);</pre>
 184 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 185 <h3 class="title">Warning</h3>
 186 <p><code class="literal">clutter_group_get_nth_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-get-child-at-index" title="clutter_actor_get_child_at_index ()"><code class="function">clutter_actor_get_child_at_index()</code></a> instead.</p>
 187 </div>
 188 <p>
 189 Gets a groups child held at <em class="parameter"><code>index_</code></em> in stack.
 190 </p>
 191 <div class="variablelist"><table border="0">
 192 <col align="left" valign="top">
 193 <tbody>
 194 <tr>
 195 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 196 <td>A <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a>
 197 </td>
 198 </tr>
 199 <tr>
 200 <td><p><span class="term"><em class="parameter"><code>index_</code></em> :</span></p></td>
 201 <td>the position of the requested actor.</td>
 202 </tr>
 203 <tr>
 204 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 205 <td>A Clutter actor, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if
 206 <em class="parameter"><code>index_</code></em> is invalid. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 207 </td>
 208 </tr>
 209 </tbody>
 210 </table></div>
 211 <p class="since">Since 0.2</p>
 212 </div>
 213 </div>
 214 </div>
 215 <div class="footer">
 216 <hr>
 217           Generated by GTK-Doc V1.18.1</div>
 218 </body>
 219 </html>