1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>Stage Manager</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
<link rel="home" href="index.html" title="Clutter Reference Manual">
8
<link rel="up" href="ch08.html" title="General purpose API">
9
<link rel="prev" href="clutter-Shaders.html" title="Shaders">
10
<link rel="next" href="ClutterInputDevice.html" title="ClutterInputDevice">
11
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="clutter-overview.html" title="Part I. Overview">
14
<link rel="part" href="building-clutter.html" title="Part II. Building Clutter">
15
<link rel="part" href="running-clutter.html" title="Part III. Running Clutter">
16
<link rel="part" href="clutterbase.html" title="Part IV. Clutter Core Reference">
17
<link rel="chapter" href="ch01.html" title="Abstract classes and interfaces">
18
<link rel="chapter" href="ch02.html" title="Base actors">
19
<link rel="chapter" href="ch03.html" title="Container actors">
20
<link rel="chapter" href="ch04.html" title="Layout managers">
21
<link rel="part" href="clutteranimation.html" title="Part V. Clutter Animation Framework">
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">
25
<link rel="part" href="cluttertools.html" title="Part VI. Clutter Tools">
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">
29
<link rel="part" href="clutterbackends.html" title="Part VII. Clutter Backends">
30
<link rel="part" href="additionaldocs.html" title="Part VIII. Additional Documentation">
31
<link rel="chapter" href="clutter-subclassing-ClutterActor.html" title="Implementing a new actor">
32
<link rel="chapter" href="clutter-animations.html" title="Creating Animations with Clutter">
33
<link rel="chapter" href="creating-your-own-behaviours.html" title="Creating You Own Behaviours">
34
<link rel="part" href="migration.html" title="Part IX. Migrating from previous version of Clutter">
35
<link rel="part" href="pt10.html" title="Part I. ">
36
<link rel="chapter" href="migrating-ClutterEffect.html" title="Migrating from ClutterEffect">
37
<link rel="chapter" href="migrating-ClutterPath.html" title="Migrating to ClutterPath">
38
<link rel="part" href="clutterobjects.html" title="Part X. Clutter Actors and Objects">
39
<link rel="chapter" href="clutterobjecthierarchy.html" title="Object Hierarchy">
40
<link rel="chapter" href="clutterobjectindex.html" title="Object Index">
41
<link rel="part" href="clutterglossary.html" title="Part XI. Glossaries">
42
<link rel="glossary" href="go01.html" title="Glossary">
43
<link rel="glossary" href="annotation-glossary.html" title="Annotation Glossary">
44
<link rel="index" href="ix01.html" title="Index of all symbols">
45
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
46
<link rel="index" href="ix03.html" title="Index of new symbols in 0.2">
47
<link rel="index" href="ix04.html" title="Index of new symbols in 0.4">
48
<link rel="index" href="ix05.html" title="Index of new symbols in 0.6">
49
<link rel="index" href="ix06.html" title="Index of new symbols in 0.8">
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">
52
<link rel="appendix" href="license.html" title="Appendix A. License">
54
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
55
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
57
<td><a accesskey="p" href="clutter-Shaders.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
58
<td><a accesskey="u" href="ch08.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
59
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
60
<th width="100%" align="center">Clutter Reference Manual</th>
61
<td><a accesskey="n" href="ClutterInputDevice.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
63
<tr><td colspan="5" class="shortcuts">
64
<a href="#clutter-Stage-Manager.synopsis" class="shortcut">Top</a>
66
<a href="#clutter-Stage-Manager.description" class="shortcut">Description</a>
68
<a href="#clutter-Stage-Manager.object-hierarchy" class="shortcut">Object Hierarchy</a>
70
<a href="#clutter-Stage-Manager.properties" class="shortcut">Properties</a>
72
<a href="#clutter-Stage-Manager.signals" class="shortcut">Signals</a>
75
<div class="refentry" title="Stage Manager">
76
<a name="clutter-Stage-Manager"></a><div class="titlepage"></div>
77
<div class="refnamediv"><table width="100%"><tr>
79
<h2><span class="refentrytitle"><a name="clutter-Stage-Manager.top_of_page"></a>Stage Manager</span></h2>
80
<p>Stage Manager — Maintains the list of stages</p>
82
<td valign="top" align="right"></td>
84
<div class="refsynopsisdiv" title="Synopsis">
85
<a name="clutter-Stage-Manager.synopsis"></a><h2>Synopsis</h2>
86
<a name="ClutterStageManager"></a><pre class="synopsis"> <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager-struct" title="ClutterStageManager">ClutterStageManager</a>;
87
<a class="link" href="clutter-Stage-Manager.html#ClutterStageManagerClass" title="ClutterStageManagerClass">ClutterStageManagerClass</a>;
88
<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="returnvalue">ClutterStageManager</span></a> * <a class="link" href="clutter-Stage-Manager.html#clutter-stage-manager-get-default" title="clutter_stage_manager_get_default ()">clutter_stage_manager_get_default</a> (void);
89
<span class="returnvalue">void</span> <a class="link" href="clutter-Stage-Manager.html#clutter-stage-manager-set-default-stage" title="clutter_stage_manager_set_default_stage ()">clutter_stage_manager_set_default_stage</a>
90
(<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="returnvalue">ClutterStageManager</span></a> *stage_manager,
91
<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);
92
<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> * <a class="link" href="clutter-Stage-Manager.html#clutter-stage-manager-get-default-stage" title="clutter_stage_manager_get_default_stage ()">clutter_stage_manager_get_default_stage</a>
93
(<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="returnvalue">ClutterStageManager</span></a> *stage_manager);
94
<a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * <a class="link" href="clutter-Stage-Manager.html#clutter-stage-manager-list-stages" title="clutter_stage_manager_list_stages ()">clutter_stage_manager_list_stages</a> (<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="returnvalue">ClutterStageManager</span></a> *stage_manager);
95
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * <a class="link" href="clutter-Stage-Manager.html#clutter-stage-manager-peek-stages" title="clutter_stage_manager_peek_stages ()">clutter_stage_manager_peek_stages</a> (<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="returnvalue">ClutterStageManager</span></a> *stage_manager);
98
<div class="refsect1" title="Object Hierarchy">
99
<a name="clutter-Stage-Manager.object-hierarchy"></a><h2>Object Hierarchy</h2>
100
<pre class="synopsis">
101
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
102
+----ClutterStageManager
105
<div class="refsect1" title="Properties">
106
<a name="clutter-Stage-Manager.properties"></a><h2>Properties</h2>
107
<pre class="synopsis">
108
"<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager--default-stage" title='The "default-stage" property'>default-stage</a>" <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>* : Read
111
<div class="refsect1" title="Signals">
112
<a name="clutter-Stage-Manager.signals"></a><h2>Signals</h2>
113
<pre class="synopsis">
114
"<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager-stage-added" title='The "stage-added" signal'>stage-added</a>" : Run Last
115
"<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager-stage-removed" title='The "stage-removed" signal'>stage-removed</a>" : Run Last
118
<div class="refsect1" title="Description">
119
<a name="clutter-Stage-Manager.description"></a><h2>Description</h2>
121
<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> is a singleton object, owned by Clutter, which
122
maintains the list of currently active stages
125
Every newly-created <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> will cause the emission of the
126
<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager-stage-added" title='The "stage-added" signal'><span class="type">"stage-added"</span></a> signal; once a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> has
127
been destroyed, the <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager-stage-removed" title='The "stage-removed" signal'><span class="type">"stage-removed"</span></a> signal will
131
<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> is available since Clutter 0.8</p>
133
<div class="refsect1" title="Details">
134
<a name="clutter-Stage-Manager.details"></a><h2>Details</h2>
135
<div class="refsect2" title="ClutterStageManager">
136
<a name="ClutterStageManager-struct"></a><h3>ClutterStageManager</h3>
137
<pre class="programlisting">typedef struct _ClutterStageManager ClutterStageManager;</pre>
139
The <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> structure is private.</p>
140
<p class="since">Since 1.0</p>
143
<div class="refsect2" title="ClutterStageManagerClass">
144
<a name="ClutterStageManagerClass"></a><h3>ClutterStageManagerClass</h3>
145
<pre class="programlisting">typedef struct {
146
} ClutterStageManagerClass;
149
The <a class="link" href="clutter-Stage-Manager.html#ClutterStageManagerClass" title="ClutterStageManagerClass"><span class="type">ClutterStageManagerClass</span></a> structure contains only private data
150
and should be accessed using the provided API</p>
151
<div class="variablelist"><table border="0">
152
<col align="left" valign="top">
155
<p class="since">Since 1.0</p>
158
<div class="refsect2" title="clutter_stage_manager_get_default ()">
159
<a name="clutter-stage-manager-get-default"></a><h3>clutter_stage_manager_get_default ()</h3>
160
<pre class="programlisting"><a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="returnvalue">ClutterStageManager</span></a> * clutter_stage_manager_get_default (void);</pre>
162
Returns the default <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a>.</p>
163
<div class="variablelist"><table border="0">
164
<col align="left" valign="top">
166
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
167
<td>transfer none. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
170
<p class="since">Since 0.8</p>
173
<div class="refsect2" title="clutter_stage_manager_set_default_stage ()">
174
<a name="clutter-stage-manager-set-default-stage"></a><h3>clutter_stage_manager_set_default_stage ()</h3>
175
<pre class="programlisting"><span class="returnvalue">void</span> clutter_stage_manager_set_default_stage
176
(<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="returnvalue">ClutterStageManager</span></a> *stage_manager,
177
<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);</pre>
178
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
179
<h3 class="title">Warning</h3>
180
<p><code class="literal">clutter_stage_manager_set_default_stage</code> has been deprecated since version 1.2 and should not be used in newly-written code. Calling this function has no effect</p>
183
Sets <em class="parameter"><code>stage</code></em> as the default stage.</p>
184
<div class="variablelist"><table border="0">
185
<col align="left" valign="top">
188
<td><p><span class="term"><em class="parameter"><code>stage_manager</code></em> :</span></p></td>
189
<td> a <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a>
193
<td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
194
<td> a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
199
<p class="since">Since 0.8</p>
202
<div class="refsect2" title="clutter_stage_manager_get_default_stage ()">
203
<a name="clutter-stage-manager-get-default-stage"></a><h3>clutter_stage_manager_get_default_stage ()</h3>
204
<pre class="programlisting"><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> * clutter_stage_manager_get_default_stage
205
(<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="returnvalue">ClutterStageManager</span></a> *stage_manager);</pre>
207
Returns the default <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>.</p>
208
<div class="variablelist"><table border="0">
209
<col align="left" valign="top">
212
<td><p><span class="term"><em class="parameter"><code>stage_manager</code></em> :</span></p></td>
213
<td> a <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a>
217
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
218
<td>transfer none. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
222
<p class="since">Since 0.8</p>
225
<div class="refsect2" title="clutter_stage_manager_list_stages ()">
226
<a name="clutter-stage-manager-list-stages"></a><h3>clutter_stage_manager_list_stages ()</h3>
227
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * clutter_stage_manager_list_stages (<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="returnvalue">ClutterStageManager</span></a> *stage_manager);</pre>
229
Lists all currently used stages.</p>
230
<div class="variablelist"><table border="0">
231
<col align="left" valign="top">
234
<td><p><span class="term"><em class="parameter"><code>stage_manager</code></em> :</span></p></td>
235
<td> a <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a>
239
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
240
<td>transfer container) (element-type ClutterStage. <acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>. <acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> ClutterStage. </td>
244
<p class="since">Since 0.8</p>
247
<div class="refsect2" title="clutter_stage_manager_peek_stages ()">
248
<a name="clutter-stage-manager-peek-stages"></a><h3>clutter_stage_manager_peek_stages ()</h3>
249
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * clutter_stage_manager_peek_stages (<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="returnvalue">ClutterStageManager</span></a> *stage_manager);</pre>
251
Lists all currently used stages.</p>
252
<div class="variablelist"><table border="0">
253
<col align="left" valign="top">
256
<td><p><span class="term"><em class="parameter"><code>stage_manager</code></em> :</span></p></td>
257
<td> a <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a>
261
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
262
<td>transfer none) (element-type ClutterStage. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. <acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> ClutterStage. </td>
266
<p class="since">Since 1.0</p>
269
<div class="refsect1" title="Property Details">
270
<a name="clutter-Stage-Manager.property-details"></a><h2>Property Details</h2>
271
<div class="refsect2" title='The "default-stage" property'>
272
<a name="ClutterStageManager--default-stage"></a><h3>The <code class="literal">"default-stage"</code> property</h3>
273
<pre class="programlisting"> "default-stage" <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>* : Read</pre>
275
The default stage used by Clutter.</p>
276
<p class="since">Since 0.8</p>
279
<div class="refsect1" title="Signal Details">
280
<a name="clutter-Stage-Manager.signal-details"></a><h2>Signal Details</h2>
281
<div class="refsect2" title='The "stage-added" signal'>
282
<a name="ClutterStageManager-stage-added"></a><h3>The <code class="literal">"stage-added"</code> signal</h3>
283
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> *stage_manager,
284
<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage,
285
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre>
287
The ::stage-added signal is emitted each time a new <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
288
has been added to the stage manager.</p>
289
<div class="variablelist"><table border="0">
290
<col align="left" valign="top">
293
<td><p><span class="term"><em class="parameter"><code>stage_manager</code></em> :</span></p></td>
294
<td> the object which received the signal
298
<td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
303
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
304
<td>user data set when the signal handler was connected.</td>
308
<p class="since">Since 0.8</p>
311
<div class="refsect2" title='The "stage-removed" signal'>
312
<a name="ClutterStageManager-stage-removed"></a><h3>The <code class="literal">"stage-removed"</code> signal</h3>
313
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> *stage_manager,
314
<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage,
315
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre>
317
The ::stage-removed signal is emitted each time a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
318
has been removed from the stage manager.</p>
319
<div class="variablelist"><table border="0">
320
<col align="left" valign="top">
323
<td><p><span class="term"><em class="parameter"><code>stage_manager</code></em> :</span></p></td>
324
<td> the object which received the signal
328
<td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
329
<td> the removed stage
333
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
334
<td>user data set when the signal handler was connected.</td>
338
<p class="since">Since 0.8</p>
344
Generated by GTK-Doc V1.13</div>
b'\\ No newline at end of file'
added
removed
doc/reference/clutter/html/clutter-Stage-Manager.html
