libclutter-1.0-doc 1.20.0-1 / usr / share / gtk-doc / html / clutter / ClutterContent.html

This file is indexed.

/usr/share/gtk-doc/html/clutter/ClutterContent.html is in libclutter-1.0-doc 1.20.0-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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Clutter Reference Manual: ClutterContent</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="ch01.html" title="Abstract classes and interfaces">
<link rel="prev" href="ClutterEffect.html" title="ClutterEffect">
<link rel="next" href="ch02.html" title="Base actors">
<meta name="generator" content="GTK-Doc V1.21 (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="#ClutterContent.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#ClutterContent.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites">  <span class="dim">|</span> 
                  <a href="#ClutterContent.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations">  <span class="dim">|</span> 
                  <a href="#ClutterContent.implementations" class="shortcut">Known Implementations</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#ClutterContent.signals" class="shortcut">Signals</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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ClutterEffect.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterContent"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterContent.top_of_page"></a>ClutterContent</span></h2>
<p>ClutterContent — Delegate for painting the content of an actor</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterContent.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">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterContent.html#clutter-content-get-preferred-size" title="clutter_content_get_preferred_size ()">clutter_content_get_preferred_size</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="ClutterContent.html#clutter-content-invalidate" title="clutter_content_invalidate ()">clutter_content_invalidate</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterContent.signals"></a><h2>Signals</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterContent.html#ClutterContent-attached" title="The “attached” signal">attached</a></td>
<td class="signal_flags">Run First</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterContent.html#ClutterContent-detached" title="The “detached” signal">detached</a></td>
<td class="signal_flags">Run First</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterContent.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"> </td>
<td class="function_name"><a class="link" href="ClutterContent.html#ClutterContent-struct" title="ClutterContent">ClutterContent</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterContent.html#ClutterContentIface" title="struct ClutterContentIface">ClutterContentIface</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterContent.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GInterface
    <span class="lineart">╰──</span> ClutterContent
</pre>
</div>
<div class="refsect1">
<a name="ClutterContent.prerequisites"></a><h2>Prerequisites</h2>
<p>
ClutterContent requires
 GObject.</p>
</div>
<div class="refsect1">
<a name="ClutterContent.implementations"></a><h2>Known Implementations</h2>
<p>
ClutterContent is implemented by
 <a class="link" href="ClutterCanvas.html" title="ClutterCanvas">ClutterCanvas</a> and  <a class="link" href="ClutterImage.html" title="ClutterImage">ClutterImage</a>.</p>
</div>
<div class="refsect1">
<a name="ClutterContent.description"></a><h2>Description</h2>
<p><a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> is an interface to implement types responsible for
painting the content of a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>.</p>
<p>Multiple actors can use the same <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> instance, in order
to share the resources associated with painting the same content.</p>
<p><a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> is available since Clutter 1.10.</p>
</div>
<div class="refsect1">
<a name="ClutterContent.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-content-get-preferred-size"></a><h3>clutter_content_get_preferred_size ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_content_get_preferred_size (<em class="parameter"><code><a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> *content</code></em>,
                                    <em class="parameter"><code><span class="type">gfloat</span> *width</code></em>,
                                    <em class="parameter"><code><span class="type">gfloat</span> *height</code></em>);</pre>
<p>Retrieves the natural size of the <em class="parameter"><code>content</code></em>
, if any.</p>
<p>The natural size of a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> is defined as the size the content
would have regardless of the allocation of the actor that is painting it,
for instance the size of an image data.</p>
<div class="refsect3">
<a name="id-1.5.2.12.10.2.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>content</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p> return location for the natural width of the content. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p> return location for the natural height of the content. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.12.10.2.7"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the content has a preferred size, and <code class="literal">FALSE</code>
otherwise</p>
<p></p>
</div>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-content-invalidate"></a><h3>clutter_content_invalidate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_content_invalidate (<em class="parameter"><code><a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> *content</code></em>);</pre>
<p>Invalidates a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a>.</p>
<p>This function should be called by <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> implementations when
they change the way a the content should be painted regardless of the
actor state.</p>
<div class="refsect3">
<a name="id-1.5.2.12.10.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>content</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since 1.10</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterContent.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterContent-struct"></a><h3>ClutterContent</h3>
<pre class="programlisting">typedef struct _ClutterContent ClutterContent;</pre>
<p>The <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> structure is an opaque type
whose members cannot be acccessed directly.</p>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterContentIface"></a><h3>struct ClutterContentIface</h3>
<pre class="programlisting">struct ClutterContentIface {
  gboolean      (* get_preferred_size)  (ClutterContent   *content,
                                         gfloat           *width,
                                         gfloat           *height);
  void          (* paint_content)       (ClutterContent   *content,
                                         ClutterActor     *actor,
                                         ClutterPaintNode *node);

  void          (* attached)            (ClutterContent   *content,
                                         ClutterActor     *actor);
  void          (* detached)            (ClutterContent   *content,
                                         ClutterActor     *actor);

  void          (* invalidate)          (ClutterContent   *content);
};
</pre>
<p>The <a class="link" href="ClutterContent.html#ClutterContentIface" title="struct ClutterContentIface"><span class="type">ClutterContentIface</span></a> structure contains only
private data.</p>
<div class="refsect3">
<a name="id-1.5.2.12.11.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterContentIface.get-preferred-size"></a>get_preferred_size</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual function; should be overridden by subclasses
of <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> that have a natural size</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterContentIface.paint-content"></a>paint_content</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual function; called each time the content needs to
paint itself</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterContentIface.attached"></a>attached</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual function; called each time a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> is attached
to a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterContentIface.detached"></a>detached</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual function; called each time a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> is detached
from a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterContentIface.invalidate"></a>invalidate</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual function; called each time a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> state
is changed.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.10</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterContent.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="ClutterContent-attached"></a><h3>The <code class="literal">“attached”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> *content,
               <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>   *actor,
               <span class="type">gpointer</span>        user_data)</pre>
<p>This signal is emitted each time a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> implementation is
assigned to a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>.</p>
<div class="refsect3">
<a name="id-1.5.2.12.12.2.5"></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>content</p></td>
<td class="parameter_description"><p>the object that emitted the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>actor</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterContent-detached"></a><h3>The <code class="literal">“detached”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> *content,
               <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>   *actor,
               <span class="type">gpointer</span>        user_data)</pre>
<p>This signal is emitted each time a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> implementation is
removed from a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>.</p>
<div class="refsect3">
<a name="id-1.5.2.12.12.3.5"></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>content</p></td>
<td class="parameter_description"><p>the object that emitted the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>actor</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
<p class="since">Since 1.10</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.21</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.