<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Stage Manager: Clutter Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Clutter Reference Manual">
<link rel="up" href="ch10.html" title="General purpose API">
<link rel="prev" href="ClutterSettings.html" title="ClutterSettings">
<link rel="next" href="ClutterTextBuffer.html" title="ClutterTextBuffer">
<meta name="generator" content="GTK-Doc V1.25.1 (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="#clutter-Stage-Manager.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#clutter-Stage-Manager.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#clutter-Stage-Manager.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#clutter-Stage-Manager.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="ch10.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ClutterSettings.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterTextBuffer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="clutter-Stage-Manager"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="clutter-Stage-Manager.top_of_page"></a>Stage Manager</span></h2>
<p>Stage Manager — Maintains the list of stages</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="clutter-Stage-Manager.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" 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="clutter-Stage-Manager.html#ClutterStageManager"><span class="returnvalue">ClutterStageManager</span></a> *
</td>
<td class="function_name">
<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> <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="clutter-Stage-Manager.html#clutter-stage-manager-set-default-stage" title="clutter_stage_manager_set_default_stage ()">clutter_stage_manager_set_default_stage</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GSList</span> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">GSList</span> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="clutter-Stage-Manager.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" 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">
<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *</td>
<td class="property_name"><a class="link" href="clutter-Stage-Manager.html#ClutterStageManager--default-stage" title="The “default-stage” property">default-stage</a></td>
<td class="property_flags">Read</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="clutter-Stage-Manager.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" 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="clutter-Stage-Manager.html#ClutterStageManager-stage-added" title="The “stage-added” signal">stage-added</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="clutter-Stage-Manager.html#ClutterStageManager-stage-removed" title="The “stage-removed” signal">stage-removed</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<a name="ClutterStageManager"></a><div class="refsect1">
<a name="clutter-Stage-Manager.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" 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="clutter-Stage-Manager.html#ClutterStageManager-struct" title="ClutterStageManager">ClutterStageManager</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="clutter-Stage-Manager.html#ClutterStageManagerClass" title="struct ClutterStageManagerClass">ClutterStageManagerClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="clutter-Stage-Manager.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> ClutterStageManager
</pre>
</div>
<div class="refsect1">
<a name="clutter-Stage-Manager.description"></a><h2>Description</h2>
<p><a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> is a singleton object, owned by Clutter, which
maintains the list of currently active stages</p>
<p>Every newly-created <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> will cause the emission of the
<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
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
be emitted</p>
<p><a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> is available since Clutter 0.8</p>
</div>
<div class="refsect1">
<a name="clutter-Stage-Manager.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-stage-manager-get-default"></a><h3>clutter_stage_manager_get_default ()</h3>
<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>
<p>Returns the default <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a>.</p>
<div class="refsect3">
<a name="clutter-stage-manager-get-default.returns"></a><h4>Returns</h4>
<p> the default stage manager instance. The returned
object is owned by Clutter and you should not reference or unreference it. </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="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-manager-set-default-stage"></a><h3>clutter_stage_manager_set_default_stage ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_manager_set_default_stage
(<em class="parameter"><code><a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> *stage_manager</code></em>,
<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<div class="warning">
<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.</p>
<p>Calling this function has no effect</p>
</div>
<p>Sets <em class="parameter"><code>stage</code></em>
as the default stage.</p>
<div class="refsect3">
<a name="clutter-stage-manager-set-default-stage.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>stage_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-manager-get-default-stage"></a><h3>clutter_stage_manager_get_default_stage ()</h3>
<pre class="programlisting"><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *
clutter_stage_manager_get_default_stage
(<em class="parameter"><code><a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> *stage_manager</code></em>);</pre>
<p>Returns the default <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>.</p>
<div class="refsect3">
<a name="clutter-stage-manager-get-default-stage.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>stage_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-stage-manager-get-default-stage.returns"></a><h4>Returns</h4>
<p> the default stage. The returned object
is owned by Clutter and you should never reference or unreference it. </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="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-manager-list-stages"></a><h3>clutter_stage_manager_list_stages ()</h3>
<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>
<p>Lists all currently used stages.</p>
<div class="refsect3">
<a name="clutter-stage-manager-list-stages.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>stage_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-stage-manager-list-stages.returns"></a><h4>Returns</h4>
<p> a newly
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
deallocate it when done. </p>
<p><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></p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-manager-peek-stages"></a><h3>clutter_stage_manager_peek_stages ()</h3>
<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>
<p>Lists all currently used stages.</p>
<div class="refsect3">
<a name="clutter-stage-manager-peek-stages.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>stage_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-stage-manager-peek-stages.returns"></a><h4>Returns</h4>
<p> a pointer
to the internal list of <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> objects. The returned list
is owned by the <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> and should never be modified
or freed. </p>
<p><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></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="clutter-Stage-Manager.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterStageManager-struct"></a><h3>ClutterStageManager</h3>
<pre class="programlisting">typedef struct _ClutterStageManager ClutterStageManager;</pre>
<p>The <a class="link" href="clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a> structure is private.</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStageManagerClass"></a><h3>struct ClutterStageManagerClass</h3>
<pre class="programlisting">struct ClutterStageManagerClass {
};
</pre>
<p>The <a class="link" href="clutter-Stage-Manager.html#ClutterStageManagerClass" title="struct ClutterStageManagerClass"><span class="type">ClutterStageManagerClass</span></a> structure contains only private data
and should be accessed using the provided API</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="clutter-Stage-Manager.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterStageManager--default-stage"></a><h3>The <code class="literal">“default-stage”</code> property</h3>
<pre class="programlisting"> “default-stage” <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *</pre>
<p>The default stage used by Clutter.</p>
<p>Flags: Read</p>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
</div>
<div class="refsect1">
<a name="clutter-Stage-Manager.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="ClutterStageManager-stage-added"></a><h3>The <code class="literal">“stage-added”</code> signal</h3>
<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,
<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::stage-added signal is emitted each time a new <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
has been added to the stage manager.</p>
<div class="refsect3">
<a name="ClutterStageManager-stage-added.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>stage_manager</p></td>
<td class="parameter_description"><p>the object which received the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>the added stage</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 Last</p>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStageManager-stage-removed"></a><h3>The <code class="literal">“stage-removed”</code> signal</h3>
<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,
<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::stage-removed signal is emitted each time a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
has been removed from the stage manager.</p>
<div class="refsect3">
<a name="ClutterStageManager-stage-removed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>stage_manager</p></td>
<td class="parameter_description"><p>the object which received the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>the removed stage</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 Last</p>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>