~oem-solutions-group/unity-2d/clutter-1.0

« back to all changes in this revision

Viewing changes to doc/reference/clutter/html/ClutterGroup.html

  • Committer: Bazaar Package Importer
  • Author(s): Emilio Pozuelo Monfort
  • Date: 2010-03-21 13:27:56 UTC
  • mto: (2.1.3 experimental)
  • mto: This revision was merged to the branch mainline in revision 8.
  • Revision ID: james.westby@ubuntu.com-20100321132756-nf8yd30yxo3zzwcm
Tags: upstream-1.2.2
Import upstream version 1.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="ch03.html" title="Container actors">
9
9
<link rel="prev" href="ch03.html" title="Container actors">
10
10
<link rel="next" href="ClutterStage.html" title="ClutterStage">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="clutter-overview.html" title="Part I. Overview">
14
14
<link rel="part" href="building-clutter.html" title="Part II. Building Clutter">
17
17
<link rel="chapter" href="ch01.html" title="Abstract classes and interfaces">
18
18
<link rel="chapter" href="ch02.html" title="Base actors">
19
19
<link rel="chapter" href="ch03.html" title="Container actors">
 
20
<link rel="chapter" href="ch04.html" title="Layout managers">
20
21
<link rel="part" href="clutteranimation.html" title="Part V. Clutter Animation Framework">
21
 
<link rel="chapter" href="ch04.html" title="Base classes">
22
 
<link rel="chapter" href="ch05.html" title="Behaviours">
23
 
<link rel="chapter" href="ch06.html" title="High Level API">
 
22
<link rel="chapter" href="ch05.html" title="Base classes">
 
23
<link rel="chapter" href="ch06.html" title="Behaviours">
 
24
<link rel="chapter" href="ch07.html" title="High Level API">
24
25
<link rel="part" href="cluttertools.html" title="Part VI. Clutter Tools">
25
 
<link rel="chapter" href="ch07.html" title="General purpose API">
26
 
<link rel="chapter" href="ch08.html" title="User interface definition">
27
 
<link rel="chapter" href="ch09.html" title="Generic list model">
 
26
<link rel="chapter" href="ch08.html" title="General purpose API">
 
27
<link rel="chapter" href="ch09.html" title="User interface definition">
 
28
<link rel="chapter" href="ch10.html" title="Generic list model">
28
29
<link rel="part" href="clutterbackends.html" title="Part VII. Clutter Backends">
29
30
<link rel="part" href="additionaldocs.html" title="Part VIII. Additional Documentation">
30
31
<link rel="chapter" href="clutter-subclassing-ClutterActor.html" title="Implementing a new actor">
47
48
<link rel="index" href="ix05.html" title="Index of new symbols in 0.6">
48
49
<link rel="index" href="ix06.html" title="Index of new symbols in 0.8">
49
50
<link rel="index" href="ix07.html" title="Index of new symbols in 1.0">
 
51
<link rel="index" href="ix08.html" title="Index of new symbols in 1.2">
50
52
<link rel="appendix" href="license.html" title="Appendix A. License">
51
53
</head>
52
54
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
60
62
</tr>
61
63
<tr><td colspan="5" class="shortcuts">
62
64
<a href="#ClutterGroup.synopsis" class="shortcut">Top</a>
63
 
                 | 
64
 
                <a href="#ClutterGroup.description" class="shortcut">Description</a>
65
 
                 | 
66
 
                <a href="#ClutterGroup.object-hierarchy" class="shortcut">Object Hierarchy</a>
67
 
                 | 
68
 
                <a href="#ClutterGroup.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
65
                   | 
 
66
                  <a href="#ClutterGroup.description" class="shortcut">Description</a>
 
67
                   | 
 
68
                  <a href="#ClutterGroup.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
69
                   | 
 
70
                  <a href="#ClutterGroup.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
69
71
</td></tr>
70
72
</table>
71
73
<div class="refentry" title="ClutterGroup">
73
75
<div class="refnamediv"><table width="100%"><tr>
74
76
<td valign="top">
75
77
<h2><span class="refentrytitle"><a name="ClutterGroup.top_of_page"></a>ClutterGroup</span></h2>
76
 
<p>ClutterGroup — Actor class containing multiple children.
77
 
actors.</p>
 
78
<p>ClutterGroup — A fixed layout container</p>
78
79
</td>
79
80
<td valign="top" align="right"></td>
80
81
</tr></table></div>
81
82
<div class="refsynopsisdiv" title="Synopsis">
82
83
<a name="ClutterGroup.synopsis"></a><h2>Synopsis</h2>
83
 
<pre class="synopsis">
84
 
                    <a class="link" href="ClutterGroup.html#ClutterGroup-struct" title="ClutterGroup">ClutterGroup</a>;
 
84
<pre class="synopsis">                    <a class="link" href="ClutterGroup.html#ClutterGroup-struct" title="ClutterGroup">ClutterGroup</a>;
85
85
                    <a class="link" href="ClutterGroup.html#ClutterGroupClass" title="ClutterGroupClass">ClutterGroupClass</a>;
86
 
<a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a> *      <a class="link" href="ClutterGroup.html#clutter-group-new" title="clutter_group_new ()">clutter_group_new</a>                   (void);
87
 
void                <a class="link" href="ClutterGroup.html#clutter-group-remove-all" title="clutter_group_remove_all ()">clutter_group_remove_all</a>            (<a class="link" href="ClutterGroup.html" title="ClutterGroup">ClutterGroup</a> *group);
88
 
<a
89
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
90
 
>gint</a>                <a class="link" href="ClutterGroup.html#clutter-group-get-n-children" title="clutter_group_get_n_children ()">clutter_group_get_n_children</a>        (<a class="link" href="ClutterGroup.html" title="ClutterGroup">ClutterGroup</a> *self);
91
 
<a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a> *      <a class="link" href="ClutterGroup.html#clutter-group-get-nth-child" title="clutter_group_get_nth_child ()">clutter_group_get_nth_child</a>         (<a class="link" href="ClutterGroup.html" title="ClutterGroup">ClutterGroup</a> *self,
92
 
                                                         <a
93
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
94
 
>gint</a> index_);
 
86
<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>                   (void);
 
87
<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>            (<a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="returnvalue">ClutterGroup</span></a> *group);
 
88
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="ClutterGroup.html#clutter-group-get-n-children" title="clutter_group_get_n_children ()">clutter_group_get_n_children</a>        (<a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="returnvalue">ClutterGroup</span></a> *self);
 
89
<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>         (<a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="returnvalue">ClutterGroup</span></a> *self,
 
90
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> index_);
95
91
</pre>
96
92
</div>
97
93
<div class="refsect1" title="Object Hierarchy">
98
94
<a name="ClutterGroup.object-hierarchy"></a><h2>Object Hierarchy</h2>
99
95
<pre class="synopsis">
100
 
  <a
101
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
102
 
>GObject</a>
103
 
   +----<a
104
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
105
 
>GInitiallyUnowned</a>
 
96
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
97
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
106
98
         +----<a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
107
99
               +----ClutterGroup
108
100
                     +----<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a>
122
114
rotating and clipping of the group will apply to the child actors.
123
115
</p>
124
116
<p>
125
 
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.
126
 
Resize requests via the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> API will be ignored.</p>
 
117
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;
 
118
it will be the smallest non-negative size that covers the right and bottom
 
119
edges of all of its children.
 
120
</p>
127
121
<p>
128
 
</p>
 
122
Setting the size on a Group using <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> methods like
 
123
<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,
 
124
however this will not affect the size of the children and they may still
 
125
be painted outside of the allocation of the group. One way to constrain
 
126
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
 
127
explicitly set the size of the <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> and then use the
 
128
<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.</p>
129
129
</div>
130
130
<div class="refsect1" title="Details">
131
131
<a name="ClutterGroup.details"></a><h2>Details</h2>
135
135
<p>
136
136
The <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> structure contains only private data
137
137
and should be accessed using the provided API</p>
138
 
<p>
139
 
</p>
140
138
<p class="since">Since 0.1</p>
141
139
</div>
142
140
<hr>
147
145
</pre>
148
146
<p>
149
147
The <a class="link" href="ClutterGroup.html#ClutterGroupClass" title="ClutterGroupClass"><span class="type">ClutterGroupClass</span></a> structure contains only private data</p>
150
 
<p>
151
 
</p>
152
148
<p class="since">Since 0.1</p>
153
149
</div>
154
150
<hr>
155
151
<div class="refsect2" title="clutter_group_new ()">
156
152
<a name="clutter-group-new"></a><h3>clutter_group_new ()</h3>
157
 
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a> *      clutter_group_new                   (void);</pre>
 
153
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_group_new                   (void);</pre>
158
154
<p>
159
155
Create a new  <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a>.</p>
160
 
<p>
161
 
</p>
162
156
<div class="variablelist"><table border="0">
163
157
<col align="left" valign="top">
164
158
<tbody><tr>
171
165
<hr>
172
166
<div class="refsect2" title="clutter_group_remove_all ()">
173
167
<a name="clutter-group-remove-all"></a><h3>clutter_group_remove_all ()</h3>
174
 
<pre class="programlisting">void                clutter_group_remove_all            (<a class="link" href="ClutterGroup.html" title="ClutterGroup">ClutterGroup</a> *group);</pre>
 
168
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_group_remove_all            (<a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="returnvalue">ClutterGroup</span></a> *group);</pre>
175
169
<p>
176
170
Removes all children actors from the <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a>.</p>
177
 
<p>
178
 
</p>
179
171
<div class="variablelist"><table border="0">
180
172
<col align="left" valign="top">
181
173
<tbody><tr>
188
180
<hr>
189
181
<div class="refsect2" title="clutter_group_get_n_children ()">
190
182
<a name="clutter-group-get-n-children"></a><h3>clutter_group_get_n_children ()</h3>
191
 
<pre class="programlisting"><a
192
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
193
 
>gint</a>                clutter_group_get_n_children        (<a class="link" href="ClutterGroup.html" title="ClutterGroup">ClutterGroup</a> *self);</pre>
 
183
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                clutter_group_get_n_children        (<a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="returnvalue">ClutterGroup</span></a> *self);</pre>
194
184
<p>
195
185
Gets the number of actors held in the group.</p>
196
 
<p>
197
 
</p>
198
186
<div class="variablelist"><table border="0">
199
187
<col align="left" valign="top">
200
188
<tbody>
216
204
<hr>
217
205
<div class="refsect2" title="clutter_group_get_nth_child ()">
218
206
<a name="clutter-group-get-nth-child"></a><h3>clutter_group_get_nth_child ()</h3>
219
 
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a> *      clutter_group_get_nth_child         (<a class="link" href="ClutterGroup.html" title="ClutterGroup">ClutterGroup</a> *self,
220
 
                                                         <a
221
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
222
 
>gint</a> index_);</pre>
 
207
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_group_get_nth_child         (<a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="returnvalue">ClutterGroup</span></a> *self,
 
208
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> index_);</pre>
223
209
<p>
224
210
Gets a groups child held at <em class="parameter"><code>index_</code></em> in stack.</p>
225
 
<p>
226
 
</p>
227
211
<div class="variablelist"><table border="0">
228
212
<col align="left" valign="top">
229
213
<tbody>
239
223
</tr>
240
224
<tr>
241
225
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
242
 
<td>transfer none. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=transfer"><span class="acronym">transfer</span></a> none. </td>
 
226
<td>transfer none. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
243
227
</tr>
244
228
</tbody>
245
229
</table></div>
249
233
</div>
250
234
<div class="footer">
251
235
<hr>
252
 
          Generated by GTK-Doc V1.11</div>
 
236
          Generated by GTK-Doc V1.13</div>
253
237
</body>
254
 
</html>
 
238
</html>
 
 
b'\\ No newline at end of file'