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>ClutterScore</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="deprecated.html" title="Part X. Deprecated Classes">
9 <link rel="prev" href="deprecated.html" title="Part X. Deprecated Classes">
10 <link rel="next" href="clutter-Shaders.html" title="Shaders">
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="deprecated.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="deprecated.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="clutter-Shaders.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="#ClutterScore.synopsis" class="shortcut">Top</a>
26 <a href="#ClutterScore.description" class="shortcut">Description</a>
28 <a href="#ClutterScore.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#ClutterScore.properties" class="shortcut">Properties</a>
32 <a href="#ClutterScore.signals" class="shortcut">Signals</a>
35 <div class="refentry">
36 <a name="ClutterScore"></a><div class="titlepage"></div>
37 <div class="refnamediv"><table width="100%"><tr>
39 <h2><span class="refentrytitle"><a name="ClutterScore.top_of_page"></a>ClutterScore</span></h2>
40 <p>ClutterScore — Controller for multiple timelines</p>
42 <td valign="top" align="right"></td>
44 <div class="refsynopsisdiv">
45 <a name="ClutterScore.synopsis"></a><h2>Synopsis</h2>
46 <pre class="synopsis">struct <a class="link" href="ClutterScore.html#ClutterScore-struct" title="struct ClutterScore">ClutterScore</a>;
47 struct <a class="link" href="ClutterScore.html#ClutterScoreClass" title="struct ClutterScoreClass">ClutterScoreClass</a>;
48 <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="returnvalue">ClutterScore</span></a> * <a class="link" href="ClutterScore.html#clutter-score-new" title="clutter_score_new ()">clutter_score_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
49 <span class="returnvalue">void</span> <a class="link" href="ClutterScore.html#clutter-score-set-loop" title="clutter_score_set_loop ()">clutter_score_set_loop</a> (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>,
50 <em class="parameter"><code><span class="type">gboolean</span> loop</code></em>);
51 <span class="returnvalue">gboolean</span> <a class="link" href="ClutterScore.html#clutter-score-get-loop" title="clutter_score_get_loop ()">clutter_score_get_loop</a> (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>);
53 <span class="returnvalue">gulong</span> <a class="link" href="ClutterScore.html#clutter-score-append" title="clutter_score_append ()">clutter_score_append</a> (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>,
54 <em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *parent</code></em>,
55 <em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
56 <span class="returnvalue">gulong</span> <a class="link" href="ClutterScore.html#clutter-score-append-at-marker" title="clutter_score_append_at_marker ()">clutter_score_append_at_marker</a> (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>,
57 <em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *parent</code></em>,
58 <em class="parameter"><code>const <span class="type">gchar</span> *marker_name</code></em>,
59 <em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
60 <span class="returnvalue">void</span> <a class="link" href="ClutterScore.html#clutter-score-remove" title="clutter_score_remove ()">clutter_score_remove</a> (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>,
61 <em class="parameter"><code><span class="type">gulong</span> id_</code></em>);
62 <span class="returnvalue">void</span> <a class="link" href="ClutterScore.html#clutter-score-remove-all" title="clutter_score_remove_all ()">clutter_score_remove_all</a> (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>);
63 <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> * <a class="link" href="ClutterScore.html#clutter-score-get-timeline" title="clutter_score_get_timeline ()">clutter_score_get_timeline</a> (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>,
64 <em class="parameter"><code><span class="type">gulong</span> id_</code></em>);
65 <span class="returnvalue">GSList</span> * <a class="link" href="ClutterScore.html#clutter-score-list-timelines" title="clutter_score_list_timelines ()">clutter_score_list_timelines</a> (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>);
67 <span class="returnvalue">void</span> <a class="link" href="ClutterScore.html#clutter-score-start" title="clutter_score_start ()">clutter_score_start</a> (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>);
68 <span class="returnvalue">void</span> <a class="link" href="ClutterScore.html#clutter-score-pause" title="clutter_score_pause ()">clutter_score_pause</a> (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>);
69 <span class="returnvalue">void</span> <a class="link" href="ClutterScore.html#clutter-score-stop" title="clutter_score_stop ()">clutter_score_stop</a> (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>);
70 <span class="returnvalue">gboolean</span> <a class="link" href="ClutterScore.html#clutter-score-is-playing" title="clutter_score_is_playing ()">clutter_score_is_playing</a> (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>);
71 <span class="returnvalue">void</span> <a class="link" href="ClutterScore.html#clutter-score-rewind" title="clutter_score_rewind ()">clutter_score_rewind</a> (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>);
74 <div class="refsect1">
75 <a name="ClutterScore.object-hierarchy"></a><h2>Object Hierarchy</h2>
76 <pre class="synopsis">
81 <div class="refsect1">
82 <a name="ClutterScore.properties"></a><h2>Properties</h2>
83 <pre class="synopsis">
84 "<a class="link" href="ClutterScore.html#ClutterScore--loop" title='The "loop" property'>loop</a>" <span class="type">gboolean</span> : Read / Write
87 <div class="refsect1">
88 <a name="ClutterScore.signals"></a><h2>Signals</h2>
89 <pre class="synopsis">
90 "<a class="link" href="ClutterScore.html#ClutterScore-completed" title='The "completed" signal'>completed</a>" : <code class="literal">Run Last</code>
91 "<a class="link" href="ClutterScore.html#ClutterScore-paused" title='The "paused" signal'>paused</a>" : <code class="literal">Run Last</code>
92 "<a class="link" href="ClutterScore.html#ClutterScore-started" title='The "started" signal'>started</a>" : <code class="literal">Run Last</code>
93 "<a class="link" href="ClutterScore.html#ClutterScore-timeline-completed" title='The "timeline-completed" signal'>timeline-completed</a>" : <code class="literal">Run Last</code>
94 "<a class="link" href="ClutterScore.html#ClutterScore-timeline-started" title='The "timeline-started" signal'>timeline-started</a>" : <code class="literal">Run Last</code>
97 <div class="refsect1">
98 <a name="ClutterScore.description"></a><h2>Description</h2>
100 <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> is a base class for sequencing multiple timelines in order.
101 Using <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> it is possible to start multiple timelines at the
102 same time or launch multiple timelines when a particular timeline has
103 emitted the ClutterTimeline::completed signal.
106 Each time a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> is started and completed, a signal will be
110 For example, this code will start two <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>s after
111 a third timeline terminates:
115 <div class="informalexample">
116 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
119 <td class="listing_lines" align="right"><pre>1
133 <td class="listing_code"><pre class="programlisting"><span class="usertype">ClutterTimeline</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">timeline_1</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">timeline_2</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">timeline_3</span><span class="symbol">;</span>
134 <span class="usertype">ClutterScore</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">score</span><span class="symbol">;</span>
136 <span class="normal">timeline_1 </span><span class="symbol">=</span><span class="normal"> </span><span class="function">clutter_timeline_new_for_duration</span><span class="normal"> </span><span class="symbol">(</span><span class="number">1000</span><span class="symbol">);</span>
137 <span class="normal">timeline_2 </span><span class="symbol">=</span><span class="normal"> </span><span class="function">clutter_timeline_new_for_duration</span><span class="normal"> </span><span class="symbol">(</span><span class="number">500</span><span class="symbol">);</span>
138 <span class="normal">timeline_3 </span><span class="symbol">=</span><span class="normal"> </span><span class="function">clutter_timeline_new_for_duration</span><span class="normal"> </span><span class="symbol">(</span><span class="number">500</span><span class="symbol">);</span>
140 <span class="normal">score </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="ClutterScore.html#clutter-score-new">clutter_score_new</a></span><span class="normal"> </span><span class="symbol">();</span>
142 <span class="function"><a href="ClutterScore.html#clutter-score-append">clutter_score_append</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">score</span><span class="symbol">,</span><span class="normal"> <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> timeline_1</span><span class="symbol">);</span>
143 <span class="function"><a href="ClutterScore.html#clutter-score-append">clutter_score_append</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">score</span><span class="symbol">,</span><span class="normal"> timeline_1</span><span class="symbol">,</span><span class="normal"> timeline_2</span><span class="symbol">);</span>
144 <span class="function"><a href="ClutterScore.html#clutter-score-append">clutter_score_append</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">score</span><span class="symbol">,</span><span class="normal"> timeline_1</span><span class="symbol">,</span><span class="normal"> timeline_3</span><span class="symbol">);</span>
146 <span class="function"><a href="ClutterScore.html#clutter-score-start">clutter_score_start</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">score</span><span class="symbol">);</span></pre></td>
155 A <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> takes a reference on the timelines it manages,
156 so timelines can be safely unreferenced after being appended.
159 New timelines can be appended to the <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> using
160 <a class="link" href="ClutterScore.html#clutter-score-append" title="clutter_score_append ()"><code class="function">clutter_score_append()</code></a> and removed using <a class="link" href="ClutterScore.html#clutter-score-remove" title="clutter_score_remove ()"><code class="function">clutter_score_remove()</code></a>.
163 Timelines can also be appended to a specific marker on the
164 parent timeline, using <a class="link" href="ClutterScore.html#clutter-score-append-at-marker" title="clutter_score_append_at_marker ()"><code class="function">clutter_score_append_at_marker()</code></a>.
167 The score can be cleared using <a class="link" href="ClutterScore.html#clutter-score-remove-all" title="clutter_score_remove_all ()"><code class="function">clutter_score_remove_all()</code></a>.
170 The list of timelines can be retrieved using
171 <a class="link" href="ClutterScore.html#clutter-score-list-timelines" title="clutter_score_list_timelines ()"><code class="function">clutter_score_list_timelines()</code></a>.
174 The score state is controlled using <a class="link" href="ClutterScore.html#clutter-score-start" title="clutter_score_start ()"><code class="function">clutter_score_start()</code></a>,
175 <a class="link" href="ClutterScore.html#clutter-score-pause" title="clutter_score_pause ()"><code class="function">clutter_score_pause()</code></a>, <a class="link" href="ClutterScore.html#clutter-score-stop" title="clutter_score_stop ()"><code class="function">clutter_score_stop()</code></a> and <a class="link" href="ClutterScore.html#clutter-score-rewind" title="clutter_score_rewind ()"><code class="function">clutter_score_rewind()</code></a>.
176 The state can be queried using <a class="link" href="ClutterScore.html#clutter-score-is-playing" title="clutter_score_is_playing ()"><code class="function">clutter_score_is_playing()</code></a>.
179 <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> is available since Clutter 0.6
182 <div class="refsect1">
183 <a name="ClutterScore.details"></a><h2>Details</h2>
184 <div class="refsect2">
185 <a name="ClutterScore-struct"></a><h3>struct ClutterScore</h3>
186 <pre class="programlisting">struct ClutterScore;</pre>
188 The <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> structure contains only private data
189 and should be accessed using the provided API
191 <p class="since">Since 0.6</p>
194 <div class="refsect2">
195 <a name="ClutterScoreClass"></a><h3>struct ClutterScoreClass</h3>
196 <pre class="programlisting">struct ClutterScoreClass {
197 void (* timeline_started) (ClutterScore *score,
198 ClutterTimeline *timeline);
199 void (* timeline_completed) (ClutterScore *score,
200 ClutterTimeline *timeline);
202 void (* started) (ClutterScore *score);
203 void (* completed) (ClutterScore *score);
204 void (* paused) (ClutterScore *score);
208 The <a class="link" href="ClutterScore.html#ClutterScoreClass" title="struct ClutterScoreClass"><span class="type">ClutterScoreClass</span></a> structure contains only private data
210 <div class="variablelist"><table border="0">
211 <col align="left" valign="top">
214 <td><p><span class="term"><em class="structfield"><code><a name="ClutterScoreClass.timeline-started"></a>timeline_started</code></em> ()</span></p></td>
215 <td>handler for the <a class="link" href="ClutterScore.html#ClutterScore-timeline-started" title='The "timeline-started" signal'><span class="type">"timeline-started"</span></a> signal</td>
218 <td><p><span class="term"><em class="structfield"><code><a name="ClutterScoreClass.timeline-completed"></a>timeline_completed</code></em> ()</span></p></td>
219 <td>handler for the <a class="link" href="ClutterScore.html#ClutterScore-timeline-completed" title='The "timeline-completed" signal'><span class="type">"timeline-completed"</span></a>
223 <td><p><span class="term"><em class="structfield"><code><a name="ClutterScoreClass.started"></a>started</code></em> ()</span></p></td>
224 <td>handler for the <a class="link" href="ClutterScore.html#ClutterScore-started" title='The "started" signal'><span class="type">"started"</span></a> signal</td>
227 <td><p><span class="term"><em class="structfield"><code><a name="ClutterScoreClass.completed"></a>completed</code></em> ()</span></p></td>
228 <td>handler for the <a class="link" href="ClutterScore.html#ClutterScore-completed" title='The "completed" signal'><span class="type">"completed"</span></a> signal</td>
231 <td><p><span class="term"><em class="structfield"><code><a name="ClutterScoreClass.paused"></a>paused</code></em> ()</span></p></td>
232 <td>handler for the <a class="link" href="ClutterScore.html#ClutterScore-paused" title='The "paused" signal'><span class="type">"paused"</span></a> signal</td>
236 <p class="since">Since 0.6</p>
239 <div class="refsect2">
240 <a name="clutter-score-new"></a><h3>clutter_score_new ()</h3>
241 <pre class="programlisting"><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="returnvalue">ClutterScore</span></a> * clutter_score_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
243 Creates a new <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a>. A <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> is an object that can
244 hold multiple <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>s in a sequential order.
246 <div class="variablelist"><table border="0">
247 <col align="left" valign="top">
249 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
250 <td>the newly created <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a>. Use <code class="function">g_object_unref()</code>
254 <p class="since">Since 0.6</p>
257 <div class="refsect2">
258 <a name="clutter-score-set-loop"></a><h3>clutter_score_set_loop ()</h3>
259 <pre class="programlisting"><span class="returnvalue">void</span> clutter_score_set_loop (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>,
260 <em class="parameter"><code><span class="type">gboolean</span> loop</code></em>);</pre>
262 Sets whether <em class="parameter"><code>score</code></em> should loop. A looping <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> will start
263 from its initial state after the ::complete signal has been fired.
265 <div class="variablelist"><table border="0">
266 <col align="left" valign="top">
269 <td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
270 <td>a <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a>
274 <td><p><span class="term"><em class="parameter"><code>loop</code></em> :</span></p></td>
276 <code class="literal">TRUE</code> for enable looping</td>
280 <p class="since">Since 0.6</p>
283 <div class="refsect2">
284 <a name="clutter-score-get-loop"></a><h3>clutter_score_get_loop ()</h3>
285 <pre class="programlisting"><span class="returnvalue">gboolean</span> clutter_score_get_loop (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>);</pre>
287 Gets whether <em class="parameter"><code>score</code></em> is looping
289 <div class="variablelist"><table border="0">
290 <col align="left" valign="top">
293 <td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
294 <td>a <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a>
298 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
300 <code class="literal">TRUE</code> if the score is looping</td>
304 <p class="since">Since 0.6</p>
307 <div class="refsect2">
308 <a name="clutter-score-append"></a><h3>clutter_score_append ()</h3>
309 <pre class="programlisting"><span class="returnvalue">gulong</span> clutter_score_append (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>,
310 <em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *parent</code></em>,
311 <em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
313 Appends a timeline to another one existing in the score; the newly
314 appended timeline will be started when <em class="parameter"><code>parent</code></em> is complete.
317 If <em class="parameter"><code>parent</code></em> is <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, the new <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> will be started when
318 <a class="link" href="ClutterScore.html#clutter-score-start" title="clutter_score_start ()"><code class="function">clutter_score_start()</code></a> is called.
321 <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> will take a reference on <em class="parameter"><code>timeline</code></em>.
323 <div class="variablelist"><table border="0">
324 <col align="left" valign="top">
327 <td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
328 <td>a <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a>
332 <td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
333 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> in the score, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
337 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
338 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
342 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
343 <td>the id of the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> inside the score, or
344 0 on failure. The returned id can be used with <a class="link" href="ClutterScore.html#clutter-score-remove" title="clutter_score_remove ()"><code class="function">clutter_score_remove()</code></a>
345 or <a class="link" href="ClutterScore.html#clutter-score-get-timeline" title="clutter_score_get_timeline ()"><code class="function">clutter_score_get_timeline()</code></a>.</td>
349 <p class="since">Since 0.6</p>
352 <div class="refsect2">
353 <a name="clutter-score-append-at-marker"></a><h3>clutter_score_append_at_marker ()</h3>
354 <pre class="programlisting"><span class="returnvalue">gulong</span> clutter_score_append_at_marker (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>,
355 <em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *parent</code></em>,
356 <em class="parameter"><code>const <span class="type">gchar</span> *marker_name</code></em>,
357 <em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
359 Appends <em class="parameter"><code>timeline</code></em> at the given <em class="parameter"><code>marker_name</code></em> on the <em class="parameter"><code>parent</code></em>
360 <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>.
363 If you want to append <em class="parameter"><code>timeline</code></em> at the end of <em class="parameter"><code>parent</code></em>, use
364 <a class="link" href="ClutterScore.html#clutter-score-append" title="clutter_score_append ()"><code class="function">clutter_score_append()</code></a>.
367 The <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> will take a reference on <em class="parameter"><code>timeline</code></em>.
369 <div class="variablelist"><table border="0">
370 <col align="left" valign="top">
373 <td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
374 <td>a <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a>
378 <td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
379 <td>the parent <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
383 <td><p><span class="term"><em class="parameter"><code>marker_name</code></em> :</span></p></td>
384 <td>the name of the marker to use</td>
387 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
388 <td>the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> to append</td>
391 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
392 <td>the id of the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> inside the score, or
393 0 on failure. The returned id can be used with <a class="link" href="ClutterScore.html#clutter-score-remove" title="clutter_score_remove ()"><code class="function">clutter_score_remove()</code></a>
394 or <a class="link" href="ClutterScore.html#clutter-score-get-timeline" title="clutter_score_get_timeline ()"><code class="function">clutter_score_get_timeline()</code></a>.</td>
398 <p class="since">Since 0.8</p>
401 <div class="refsect2">
402 <a name="clutter-score-remove"></a><h3>clutter_score_remove ()</h3>
403 <pre class="programlisting"><span class="returnvalue">void</span> clutter_score_remove (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>,
404 <em class="parameter"><code><span class="type">gulong</span> id_</code></em>);</pre>
406 Removes the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> with the given id inside <em class="parameter"><code>score</code></em>. If
407 the timeline has other timelines attached to it, those are removed
410 <div class="variablelist"><table border="0">
411 <col align="left" valign="top">
414 <td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
415 <td>a <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a>
419 <td><p><span class="term"><em class="parameter"><code>id_</code></em> :</span></p></td>
420 <td>the id of the timeline to remove</td>
424 <p class="since">Since 0.6</p>
427 <div class="refsect2">
428 <a name="clutter-score-remove-all"></a><h3>clutter_score_remove_all ()</h3>
429 <pre class="programlisting"><span class="returnvalue">void</span> clutter_score_remove_all (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>);</pre>
431 Removes all the timelines inside <em class="parameter"><code>score</code></em>.
433 <div class="variablelist"><table border="0">
434 <col align="left" valign="top">
436 <td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
437 <td>a <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a>
441 <p class="since">Since 0.6</p>
444 <div class="refsect2">
445 <a name="clutter-score-get-timeline"></a><h3>clutter_score_get_timeline ()</h3>
446 <pre class="programlisting"><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> * clutter_score_get_timeline (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>,
447 <em class="parameter"><code><span class="type">gulong</span> id_</code></em>);</pre>
449 Retrieves the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> for <em class="parameter"><code>id_</code></em> inside <em class="parameter"><code>score</code></em>.
451 <div class="variablelist"><table border="0">
452 <col align="left" valign="top">
455 <td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
456 <td>a <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a>
460 <td><p><span class="term"><em class="parameter"><code>id_</code></em> :</span></p></td>
461 <td>the id of the timeline</td>
464 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
465 <td>the requested timeline, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. This
466 function does not increase the reference count on the returned
467 <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
472 <p class="since">Since 0.6</p>
475 <div class="refsect2">
476 <a name="clutter-score-list-timelines"></a><h3>clutter_score_list_timelines ()</h3>
477 <pre class="programlisting"><span class="returnvalue">GSList</span> * clutter_score_list_timelines (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>);</pre>
479 Retrieves a list of all the <a href="ClutterTimeline.html"><span class="type">ClutterTimelines</span></a> managed by <em class="parameter"><code>score</code></em>.
481 <div class="variablelist"><table border="0">
482 <col align="left" valign="top">
485 <td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
486 <td>a <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a>
490 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
492 <span class="type">GSList</span> containing all the timelines in the score. This function does
493 not increase the reference count of the returned timelines. Use
494 <code class="function">g_slist_free()</code> on the returned list to deallocate its resources. <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.Timeline]</span>
499 <p class="since">Since 0.6</p>
502 <div class="refsect2">
503 <a name="clutter-score-start"></a><h3>clutter_score_start ()</h3>
504 <pre class="programlisting"><span class="returnvalue">void</span> clutter_score_start (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>);</pre>
508 <div class="variablelist"><table border="0">
509 <col align="left" valign="top">
511 <td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
512 <td>A <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a>
516 <p class="since">Since 0.6</p>
519 <div class="refsect2">
520 <a name="clutter-score-pause"></a><h3>clutter_score_pause ()</h3>
521 <pre class="programlisting"><span class="returnvalue">void</span> clutter_score_pause (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>);</pre>
523 Pauses a playing score <em class="parameter"><code>score</code></em>.
525 <div class="variablelist"><table border="0">
526 <col align="left" valign="top">
528 <td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
529 <td>a <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a>
533 <p class="since">Since 0.6</p>
536 <div class="refsect2">
537 <a name="clutter-score-stop"></a><h3>clutter_score_stop ()</h3>
538 <pre class="programlisting"><span class="returnvalue">void</span> clutter_score_stop (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>);</pre>
540 Stops and rewinds a playing <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> instance.
542 <div class="variablelist"><table border="0">
543 <col align="left" valign="top">
545 <td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
546 <td>A <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a>
550 <p class="since">Since 0.6</p>
553 <div class="refsect2">
554 <a name="clutter-score-is-playing"></a><h3>clutter_score_is_playing ()</h3>
555 <pre class="programlisting"><span class="returnvalue">gboolean</span> clutter_score_is_playing (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>);</pre>
557 Query state of a <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> instance.
559 <div class="variablelist"><table border="0">
560 <col align="left" valign="top">
563 <td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
564 <td>A <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a>
568 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
570 <code class="literal">TRUE</code> if score is currently playing</td>
574 <p class="since">Since 0.6</p>
577 <div class="refsect2">
578 <a name="clutter-score-rewind"></a><h3>clutter_score_rewind ()</h3>
579 <pre class="programlisting"><span class="returnvalue">void</span> clutter_score_rewind (<em class="parameter"><code><a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score</code></em>);</pre>
581 Rewinds a <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> to its initial state.
583 <div class="variablelist"><table border="0">
584 <col align="left" valign="top">
586 <td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
587 <td>A <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a>
591 <p class="since">Since 0.6</p>
594 <div class="refsect1">
595 <a name="ClutterScore.property-details"></a><h2>Property Details</h2>
596 <div class="refsect2">
597 <a name="ClutterScore--loop"></a><h3>The <code class="literal">"loop"</code> property</h3>
598 <pre class="programlisting"> "loop" <span class="type">gboolean</span> : Read / Write</pre>
600 Whether the <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> should restart once finished.
602 <p>Default value: FALSE</p>
603 <p class="since">Since 0.6</p>
606 <div class="refsect1">
607 <a name="ClutterScore.signal-details"></a><h2>Signal Details</h2>
608 <div class="refsect2">
609 <a name="ClutterScore-completed"></a><h3>The <code class="literal">"completed"</code> signal</h3>
610 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score,
611 <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
613 The ::completed signal is emitted each time a <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> terminates.
615 <div class="variablelist"><table border="0">
616 <col align="left" valign="top">
619 <td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
620 <td>the score which received the signal</td>
623 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
624 <td>user data set when the signal handler was connected.</td>
628 <p class="since">Since 0.6</p>
631 <div class="refsect2">
632 <a name="ClutterScore-paused"></a><h3>The <code class="literal">"paused"</code> signal</h3>
633 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score,
634 <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
636 The ::paused signal is emitted each time a <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a>
639 <div class="variablelist"><table border="0">
640 <col align="left" valign="top">
643 <td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
644 <td>the score which received the signal</td>
647 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
648 <td>user data set when the signal handler was connected.</td>
652 <p class="since">Since 0.6</p>
655 <div class="refsect2">
656 <a name="ClutterScore-started"></a><h3>The <code class="literal">"started"</code> signal</h3>
657 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score,
658 <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
660 The ::started signal is emitted each time a <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> starts playing.
662 <div class="variablelist"><table border="0">
663 <col align="left" valign="top">
666 <td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
667 <td>the score which received the signal</td>
670 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
671 <td>user data set when the signal handler was connected.</td>
675 <p class="since">Since 0.6</p>
678 <div class="refsect2">
679 <a name="ClutterScore-timeline-completed"></a><h3>The <code class="literal">"timeline-completed"</code> signal</h3>
680 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score,
681 <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline,
682 <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
684 The ::timeline-completed signal is emitted each time a timeline
685 inside a <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> terminates.
687 <div class="variablelist"><table border="0">
688 <col align="left" valign="top">
691 <td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
692 <td>the score which received the signal</td>
695 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
696 <td>the completed timeline</td>
699 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
700 <td>user data set when the signal handler was connected.</td>
704 <p class="since">Since 0.6</p>
707 <div class="refsect2">
708 <a name="ClutterScore-timeline-started"></a><h3>The <code class="literal">"timeline-started"</code> signal</h3>
709 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> *score,
710 <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline,
711 <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
713 The ::timeline-started signal is emitted each time a new timeline
714 inside a <a class="link" href="ClutterScore.html" title="ClutterScore"><span class="type">ClutterScore</span></a> starts playing.
716 <div class="variablelist"><table border="0">
717 <col align="left" valign="top">
720 <td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
721 <td>the score which received the signal</td>
724 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
725 <td>the current timeline</td>
728 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
729 <td>user data set when the signal handler was connected.</td>
733 <p class="since">Since 0.6</p>
739 Generated by GTK-Doc V1.18.1</div>