libclutter-1.0-doc 1.24.2-1 / usr / share / gtk-doc / html / clutter / ClutterGroup.html

This file is indexed.

/usr/share/gtk-doc/html/clutter/ClutterGroup.html is in libclutter-1.0-doc 1.24.2-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterGroup: Clutter Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Clutter Reference Manual">
<link rel="up" href="deprecated.html" title="Part X. Deprecated Classes">
<link rel="prev" href="ClutterCairoTexture.html" title="ClutterCairoTexture">
<link rel="next" href="ClutterRectangle.html" title="ClutterRectangle">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#ClutterGroup.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#ClutterGroup.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#ClutterGroup.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="deprecated.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ClutterCairoTexture.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterRectangle.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterGroup"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterGroup.top_of_page"></a>ClutterGroup</span></h2>
<p>ClutterGroup — A fixed layout container</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterGroup.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterGroup.html#clutter-group-new" title="clutter_group_new ()">clutter_group_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterGroup.html#clutter-group-remove-all" title="clutter_group_remove_all ()">clutter_group_remove_all</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterGroup.html#clutter-group-get-n-children" title="clutter_group_get_n_children ()">clutter_group_get_n_children</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterGroup.html#clutter-group-get-nth-child" title="clutter_group_get_nth_child ()">clutter_group_get_nth_child</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterGroup.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterGroup.html#ClutterGroup-struct" title="struct ClutterGroup">ClutterGroup</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterGroup.html#ClutterGroupClass" title="struct ClutterGroupClass">ClutterGroupClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterGroup.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GInitiallyUnowned
        <span class="lineart">╰──</span> <a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
            <span class="lineart">╰──</span> ClutterGroup
                <span class="lineart">╰──</span> <a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a>
</pre>
</div>
<div class="refsect1">
<a name="ClutterGroup.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
ClutterGroup implements
 <a class="link" href="ClutterContainer.html" title="ClutterContainer">ClutterContainer</a>,  <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>,  <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable">ClutterAnimatable</a> and  AtkImplementorIface.</p>
</div>
<div class="refsect1">
<a name="ClutterGroup.description"></a><h2>Description</h2>
<p>A <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> is an Actor which contains multiple child actors positioned
relative to the <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> position. Other operations such as scaling,
rotating and clipping of the group will apply to the child actors.</p>
<p>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;
it will be the smallest non-negative size that covers the right and bottom
edges of all of its children.</p>
<p>Setting the size on a Group using <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> methods like
<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,
however this will not affect the size of the children and they may still
be painted outside of the allocation of the group. One way to constrain
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
explicitly set the size of the <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> and then use the
<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>
<p><a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> as a concrete class has been superceded by <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>
since Clutter 1.10. The type itself is not deprecated as it is used by
<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>. You should instantiate <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> and use its API to
manage child actors.</p>
</div>
<div class="refsect1">
<a name="ClutterGroup.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-group-new"></a><h3>clutter_group_new ()</h3>
<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>
<div class="warning">
<p><code class="literal">clutter_group_new</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterActor.html#clutter-actor-new" title="clutter_actor_new ()"><code class="function">clutter_actor_new()</code></a> instead.</p>
</div>
<p>Create a new  <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a>.</p>
<div class="refsect3">
<a name="id-1.11.14.8.2.6"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> actor</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="clutter-group-remove-all"></a><h3>clutter_group_remove_all ()</h3>
<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>
<div class="warning">
<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.</p>
<p>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>
</div>
<p>Removes all children actors from the <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a>.</p>
<div class="refsect3">
<a name="id-1.11.14.8.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="clutter-group-get-n-children"></a><h3>clutter_group_get_n_children ()</h3>
<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>
<div class="warning">
<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.</p>
<p>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>
</div>
<p>Gets the number of actors held in the group.</p>
<div class="refsect3">
<a name="id-1.11.14.8.4.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.11.14.8.4.8"></a><h4>Returns</h4>
<p> The number of child actors held in the group.</p>
</div>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-group-get-nth-child"></a><h3>clutter_group_get_nth_child ()</h3>
<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>,
                             <em class="parameter"><code><span class="type">gint</span> index_</code></em>);</pre>
<div class="warning">
<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.</p>
<p>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>
</div>
<p>Gets a groups child held at <em class="parameter"><code>index_</code></em>
 in stack.</p>
<div class="refsect3">
<a name="id-1.11.14.8.5.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>index_</p></td>
<td class="parameter_description"><p>the position of the requested actor.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.11.14.8.5.8"></a><h4>Returns</h4>
<p> A Clutter actor, or <code class="literal">NULL</code> if
<em class="parameter"><code>index_</code></em>
is invalid. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterGroup.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterGroup-struct"></a><h3>struct ClutterGroup</h3>
<pre class="programlisting">struct ClutterGroup;</pre>
<p>The <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> structure contains only private data
and should be accessed using the provided API</p>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterGroupClass"></a><h3>struct ClutterGroupClass</h3>
<pre class="programlisting">struct ClutterGroupClass {
};
</pre>
<p>The <a class="link" href="ClutterGroup.html#ClutterGroupClass" title="struct ClutterGroupClass"><span class="type">ClutterGroupClass</span></a> structure contains only private data</p>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.