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

This file is indexed.

/usr/share/gtk-doc/html/clutter/ClutterBehaviourDepth.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
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterBehaviourDepth: 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="ClutterBehaviour.html" title="ClutterBehaviour">
<link rel="next" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse">
<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="#ClutterBehaviourDepth.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#ClutterBehaviourDepth.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#ClutterBehaviourDepth.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#ClutterBehaviourDepth.properties" class="shortcut">Properties</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="ClutterBehaviour.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterBehaviourEllipse.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterBehaviourDepth"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterBehaviourDepth.top_of_page"></a>ClutterBehaviourDepth</span></h2>
<p>ClutterBehaviourDepth — A behaviour controlling the Z position</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterBehaviourDepth.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="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterBehaviourDepth.html#clutter-behaviour-depth-new" title="clutter_behaviour_depth_new ()">clutter_behaviour_depth_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="ClutterBehaviourDepth.html#clutter-behaviour-depth-set-bounds" title="clutter_behaviour_depth_set_bounds ()">clutter_behaviour_depth_set_bounds</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="ClutterBehaviourDepth.html#clutter-behaviour-depth-get-bounds" title="clutter_behaviour_depth_get_bounds ()">clutter_behaviour_depth_get_bounds</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterBehaviourDepth.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterBehaviourDepth.html#ClutterBehaviourDepth--depth-end" title="The “depth-end” property">depth-end</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterBehaviourDepth.html#ClutterBehaviourDepth--depth-start" title="The “depth-start” property">depth-start</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterBehaviourDepth.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="ClutterBehaviourDepth.html#ClutterBehaviourDepth-struct" title="struct ClutterBehaviourDepth">ClutterBehaviourDepth</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterBehaviourDepth.html#ClutterBehaviourDepthClass" title="struct ClutterBehaviourDepthClass">ClutterBehaviourDepthClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterBehaviourDepth.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a>
        <span class="lineart">╰──</span> ClutterBehaviourDepth
</pre>
</div>
<div class="refsect1">
<a name="ClutterBehaviourDepth.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
ClutterBehaviourDepth implements
 <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>.</p>
</div>
<div class="refsect1">
<a name="ClutterBehaviourDepth.description"></a><h2>Description</h2>
<p><a class="link" href="ClutterBehaviourDepth.html" title="ClutterBehaviourDepth"><span class="type">ClutterBehaviourDepth</span></a> is a simple <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a> controlling the
depth of a set of actors between a start and end depth.</p>
<p><a class="link" href="ClutterBehaviourDepth.html" title="ClutterBehaviourDepth"><span class="type">ClutterBehaviourDepth</span></a> is available since Clutter 0.4.</p>
</div>
<div class="refsect1">
<a name="ClutterBehaviourDepth.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-behaviour-depth-new"></a><h3>clutter_behaviour_depth_new ()</h3>
<pre class="programlisting"><a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> *
clutter_behaviour_depth_new (<em class="parameter"><code><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> *alpha</code></em>,
                             <em class="parameter"><code><span class="type">gint</span> depth_start</code></em>,
                             <em class="parameter"><code><span class="type">gint</span> depth_end</code></em>);</pre>
<div class="warning"><p><code class="literal">clutter_behaviour_depth_new</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<p>Creates a new <a class="link" href="ClutterBehaviourDepth.html" title="ClutterBehaviourDepth"><span class="type">ClutterBehaviourDepth</span></a> which can be used to control
the ClutterActor:depth property of a set of <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>s.</p>
<p>If <em class="parameter"><code>alpha</code></em>
 is not <code class="literal">NULL</code>, the <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a> will take ownership
of the <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance. In the case when <em class="parameter"><code>alpha</code></em>
 is <code class="literal">NULL</code>,
it can be set later with <a class="link" href="ClutterBehaviour.html#clutter-behaviour-set-alpha" title="clutter_behaviour_set_alpha ()"><code class="function">clutter_behaviour_set_alpha()</code></a>.</p>
<div class="refsect3">
<a name="id-1.11.6.9.2.8"></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>alpha</p></td>
<td class="parameter_description"><p> a <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>depth_start</p></td>
<td class="parameter_description"><p>initial value of the depth</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>depth_end</p></td>
<td class="parameter_description"><p>final value of the depth</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.11.6.9.2.9"></a><h4>Returns</h4>
<p> the newly created behaviour. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-behaviour-depth-set-bounds"></a><h3>clutter_behaviour_depth_set_bounds ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_behaviour_depth_set_bounds (<em class="parameter"><code><a class="link" href="ClutterBehaviourDepth.html" title="ClutterBehaviourDepth"><span class="type">ClutterBehaviourDepth</span></a> *behaviour</code></em>,
                                    <em class="parameter"><code><span class="type">gint</span> depth_start</code></em>,
                                    <em class="parameter"><code><span class="type">gint</span> depth_end</code></em>);</pre>
<div class="warning"><p><code class="literal">clutter_behaviour_depth_set_bounds</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<p>Sets the boundaries of the <em class="parameter"><code>behaviour</code></em>
.</p>
<div class="refsect3">
<a name="id-1.11.6.9.3.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>behaviour</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourDepth.html" title="ClutterBehaviourDepth"><span class="type">ClutterBehaviourDepth</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>depth_start</p></td>
<td class="parameter_description"><p>initial value of the depth</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>depth_end</p></td>
<td class="parameter_description"><p>final value of the depth</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-behaviour-depth-get-bounds"></a><h3>clutter_behaviour_depth_get_bounds ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_behaviour_depth_get_bounds (<em class="parameter"><code><a class="link" href="ClutterBehaviourDepth.html" title="ClutterBehaviourDepth"><span class="type">ClutterBehaviourDepth</span></a> *behaviour</code></em>,
                                    <em class="parameter"><code><span class="type">gint</span> *depth_start</code></em>,
                                    <em class="parameter"><code><span class="type">gint</span> *depth_end</code></em>);</pre>
<div class="warning"><p><code class="literal">clutter_behaviour_depth_get_bounds</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<p>Gets the boundaries of the <em class="parameter"><code>behaviour</code></em>
</p>
<div class="refsect3">
<a name="id-1.11.6.9.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>behaviour</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourDepth.html" title="ClutterBehaviourDepth"><span class="type">ClutterBehaviourDepth</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>depth_start</p></td>
<td class="parameter_description"><p> return location for the initial depth value, or <code class="literal">NULL</code>. </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>depth_end</p></td>
<td class="parameter_description"><p> return location for the final depth value, or <code class="literal">NULL</code>. </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>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterBehaviourDepth.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterBehaviourDepth-struct"></a><h3>struct ClutterBehaviourDepth</h3>
<pre class="programlisting">struct ClutterBehaviourDepth;</pre>
<div class="warning">
<p><code class="literal">ClutterBehaviourDepth</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="clutter-Implicit-Animations.html#clutter-actor-animate" title="clutter_actor_animate ()"><code class="function">clutter_actor_animate()</code></a> with <a class="link" href="ClutterActor.html#ClutterActor--depth" title="The “depth” property"><span class="type">“depth”</span></a>
  instead.</p>
</div>
<p>The <a class="link" href="ClutterBehaviourDepth.html" title="ClutterBehaviourDepth"><span class="type">ClutterBehaviourDepth</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="ClutterBehaviourDepthClass"></a><h3>struct ClutterBehaviourDepthClass</h3>
<pre class="programlisting">struct ClutterBehaviourDepthClass {
};
</pre>
<div class="warning"><p><code class="literal">ClutterBehaviourDepthClass</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<p>The <a class="link" href="ClutterBehaviourDepth.html#ClutterBehaviourDepthClass" title="struct ClutterBehaviourDepthClass"><span class="type">ClutterBehaviourDepthClass</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 class="refsect1">
<a name="ClutterBehaviourDepth.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterBehaviourDepth--depth-end"></a><h3>The <code class="literal">“depth-end”</code> property</h3>
<pre class="programlisting">  “depth-end”                <span class="type">gint</span></pre>
<p>End depth level to apply to the actors.</p>
<div class="warning"><p><code class="literal">ClutterBehaviourDepth:depth-end</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<p>Flags: Read / Write</p>
<p>Default value: 0</p>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterBehaviourDepth--depth-start"></a><h3>The <code class="literal">“depth-start”</code> property</h3>
<pre class="programlisting">  “depth-start”              <span class="type">gint</span></pre>
<p>Start depth level to apply to the actors.</p>
<div class="warning"><p><code class="literal">ClutterBehaviourDepth:depth-start</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<p>Flags: Read / Write</p>
<p>Default value: 0</p>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.