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.76.1">
7 <link rel="home" href="index.html" title="Clutter Reference Manual">
8 <link rel="up" href="ch11.html" title="General purpose API">
9 <link rel="prev" href="ClutterSettings.html" title="ClutterSettings">
10 <link rel="next" href="ClutterTextBuffer.html" title="ClutterTextBuffer">
11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="ClutterSettings.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch11.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">Clutter Reference Manual</th>
21 <td><a accesskey="n" href="ClutterTextBuffer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#clutter-Stage-Manager.synopsis" class="shortcut">Top</a>
26 <a href="#clutter-Stage-Manager.description" class="shortcut">Description</a>
28 <a href="#clutter-Stage-Manager.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#clutter-Stage-Manager.properties" class="shortcut">Properties</a>
32 <a href="#clutter-Stage-Manager.signals" class="shortcut">Signals</a>
35 <div class="refentry">
36 <a name="clutter-Stage-Manager"></a><div class="titlepage"></div>
37 <div class="refnamediv"><table width="100%"><tr>
39 <h2><span class="refentrytitle"><a name="clutter-Stage-Manager.top_of_page"></a>Stage Manager</span></h2>
40 <p>Stage Manager — Maintains the list of stages</p>
42 <td valign="top" align="right"></td>
44 <div class="refsynopsisdiv">
45 <a name="clutter-Stage-Manager.synopsis"></a><h2>Synopsis</h2>
46 <a name="ClutterStageManager"></a><pre class="synopsis"> <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager-struct" title="ClutterStageManager">ClutterStageManager</a>;
47 struct <a class="link" href="clutter-Stage-Manager.html#ClutterStageManagerClass" title="struct ClutterStageManagerClass">ClutterStageManagerClass</a>;
48 <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> (<em class="parameter"><code><span class="type">void</span></code></em>);
49 <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>
50 (<em class="parameter"><code><a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> *stage_manager</code></em>,
51 <em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
52 <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>
53 (<em class="parameter"><code><a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> *stage_manager</code></em>);
54 <span class="returnvalue">GSList</span> * <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> (<em class="parameter"><code><a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> *stage_manager</code></em>);
55 const <span class="returnvalue">GSList</span> * <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> (<em class="parameter"><code><a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> *stage_manager</code></em>);
58 <div class="refsect1">
59 <a name="clutter-Stage-Manager.object-hierarchy"></a><h2>Object Hierarchy</h2>
60 <pre class="synopsis">
62 +----ClutterStageManager
65 <div class="refsect1">
66 <a name="clutter-Stage-Manager.properties"></a><h2>Properties</h2>
67 <pre class="synopsis">
68 "<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
71 <div class="refsect1">
72 <a name="clutter-Stage-Manager.signals"></a><h2>Signals</h2>
73 <pre class="synopsis">
74 "<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager-stage-added" title='The "stage-added" signal'>stage-added</a>" : <code class="literal">Run Last</code>
75 "<a class="link" href="clutter-Stage-Manager.html#ClutterStageManager-stage-removed" title='The "stage-removed" signal'>stage-removed</a>" : <code class="literal">Run Last</code>
78 <div class="refsect1">
79 <a name="clutter-Stage-Manager.description"></a><h2>Description</h2>
81 <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> is a singleton object, owned by Clutter, which
82 maintains the list of currently active stages
85 Every newly-created <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> will cause the emission of the
86 <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
87 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
91 <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> is available since Clutter 0.8
94 <div class="refsect1">
95 <a name="clutter-Stage-Manager.details"></a><h2>Details</h2>
96 <div class="refsect2">
97 <a name="ClutterStageManager-struct"></a><h3>ClutterStageManager</h3>
98 <pre class="programlisting">typedef struct _ClutterStageManager ClutterStageManager;</pre>
100 The <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> structure is private.
102 <p class="since">Since 1.0</p>
105 <div class="refsect2">
106 <a name="ClutterStageManagerClass"></a><h3>struct ClutterStageManagerClass</h3>
107 <pre class="programlisting">struct ClutterStageManagerClass {
111 The <a class="link" href="clutter-Stage-Manager.html#ClutterStageManagerClass" title="struct ClutterStageManagerClass"><span class="type">ClutterStageManagerClass</span></a> structure contains only private data
112 and should be accessed using the provided API
114 <p class="since">Since 1.0</p>
117 <div class="refsect2">
118 <a name="clutter-stage-manager-get-default"></a><h3>clutter_stage_manager_get_default ()</h3>
119 <pre class="programlisting"><a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="returnvalue">ClutterStageManager</span></a> * clutter_stage_manager_get_default (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
121 Returns the default <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a>.
123 <div class="variablelist"><table border="0">
124 <col align="left" valign="top">
126 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
127 <td>the default stage manager instance. The returned
128 object is owned by Clutter and you should not reference or unreference it. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
132 <p class="since">Since 0.8</p>
135 <div class="refsect2">
136 <a name="clutter-stage-manager-set-default-stage"></a><h3>clutter_stage_manager_set_default_stage ()</h3>
137 <pre class="programlisting"><span class="returnvalue">void</span> clutter_stage_manager_set_default_stage
138 (<em class="parameter"><code><a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> *stage_manager</code></em>,
139 <em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
140 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
141 <h3 class="title">Warning</h3>
142 <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>
145 Sets <em class="parameter"><code>stage</code></em> as the default stage.
147 <div class="variablelist"><table border="0">
148 <col align="left" valign="top">
151 <td><p><span class="term"><em class="parameter"><code>stage_manager</code></em> :</span></p></td>
152 <td>a <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a>
156 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
157 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
162 <p class="since">Since 0.8</p>
165 <div class="refsect2">
166 <a name="clutter-stage-manager-get-default-stage"></a><h3>clutter_stage_manager_get_default_stage ()</h3>
167 <pre class="programlisting"><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> * clutter_stage_manager_get_default_stage
168 (<em class="parameter"><code><a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> *stage_manager</code></em>);</pre>
170 Returns the default <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>.
172 <div class="variablelist"><table border="0">
173 <col align="left" valign="top">
176 <td><p><span class="term"><em class="parameter"><code>stage_manager</code></em> :</span></p></td>
177 <td>a <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a>
181 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
182 <td>the default stage. The returned object
183 is owned by Clutter and you should never reference or unreference it. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
188 <p class="since">Since 0.8</p>
191 <div class="refsect2">
192 <a name="clutter-stage-manager-list-stages"></a><h3>clutter_stage_manager_list_stages ()</h3>
193 <pre class="programlisting"><span class="returnvalue">GSList</span> * clutter_stage_manager_list_stages (<em class="parameter"><code><a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> *stage_manager</code></em>);</pre>
195 Lists all currently used stages.
197 <div class="variablelist"><table border="0">
198 <col align="left" valign="top">
201 <td><p><span class="term"><em class="parameter"><code>stage_manager</code></em> :</span></p></td>
202 <td>a <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a>
206 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
208 allocated list of <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> objects. Use <code class="function">g_slist_free()</code> to
209 deallocate it when done. <span class="annotation">[<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> Clutter.Stage]</span>
214 <p class="since">Since 0.8</p>
217 <div class="refsect2">
218 <a name="clutter-stage-manager-peek-stages"></a><h3>clutter_stage_manager_peek_stages ()</h3>
219 <pre class="programlisting">const <span class="returnvalue">GSList</span> * clutter_stage_manager_peek_stages (<em class="parameter"><code><a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> *stage_manager</code></em>);</pre>
221 Lists all currently used stages.
223 <div class="variablelist"><table border="0">
224 <col align="left" valign="top">
227 <td><p><span class="term"><em class="parameter"><code>stage_manager</code></em> :</span></p></td>
228 <td>a <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a>
232 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
234 to the internal list of <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> objects. The returned list
235 is owned by the <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> and should never be modified
236 or freed. <span class="annotation">[<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> Clutter.Stage]</span>
241 <p class="since">Since 1.0</p>
244 <div class="refsect1">
245 <a name="clutter-Stage-Manager.property-details"></a><h2>Property Details</h2>
246 <div class="refsect2">
247 <a name="ClutterStageManager--default-stage"></a><h3>The <code class="literal">"default-stage"</code> property</h3>
248 <pre class="programlisting"> "default-stage" <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>* : Read</pre>
250 The default stage used by Clutter.
252 <p class="since">Since 0.8</p>
255 <div class="refsect1">
256 <a name="clutter-Stage-Manager.signal-details"></a><h2>Signal Details</h2>
257 <div class="refsect2">
258 <a name="ClutterStageManager-stage-added"></a><h3>The <code class="literal">"stage-added"</code> signal</h3>
259 <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,
260 <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage,
261 <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
263 The ::stage-added signal is emitted each time a new <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
264 has been added to the stage manager.
266 <div class="variablelist"><table border="0">
267 <col align="left" valign="top">
270 <td><p><span class="term"><em class="parameter"><code>stage_manager</code></em> :</span></p></td>
271 <td>the object which received the signal</td>
274 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
275 <td>the added stage</td>
278 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
279 <td>user data set when the signal handler was connected.</td>
283 <p class="since">Since 0.8</p>
286 <div class="refsect2">
287 <a name="ClutterStageManager-stage-removed"></a><h3>The <code class="literal">"stage-removed"</code> signal</h3>
288 <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,
289 <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage,
290 <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
292 The ::stage-removed signal is emitted each time a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
293 has been removed from the stage manager.
295 <div class="variablelist"><table border="0">
296 <col align="left" valign="top">
299 <td><p><span class="term"><em class="parameter"><code>stage_manager</code></em> :</span></p></td>
300 <td>the object which received the signal</td>
303 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
304 <td>the removed stage</td>
307 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
308 <td>user data set when the signal handler was connected.</td>
312 <p class="since">Since 0.8</p>
318 Generated by GTK-Doc V1.18.1</div>