update to 1.10.4
[profile/ivi/clutter.git] / doc / reference / clutter / html / ClutterTimeline.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>ClutterTimeline</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="ch09.html" title="Base classes">
9 <link rel="prev" href="ch09.html" title="Base classes">
10 <link rel="next" href="ClutterAlpha.html" title="ClutterAlpha">
11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
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">
16 <tr valign="middle">
17 <td><a accesskey="p" href="ch09.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch09.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="ClutterAlpha.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#ClutterTimeline.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#ClutterTimeline.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#ClutterTimeline.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#ClutterTimeline.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
31                    | 
32                   <a href="#ClutterTimeline.properties" class="shortcut">Properties</a>
33                    | 
34                   <a href="#ClutterTimeline.signals" class="shortcut">Signals</a>
35 </td></tr>
36 </table>
37 <div class="refentry">
38 <a name="ClutterTimeline"></a><div class="titlepage"></div>
39 <div class="refnamediv"><table width="100%"><tr>
40 <td valign="top">
41 <h2><span class="refentrytitle"><a name="ClutterTimeline.top_of_page"></a>ClutterTimeline</span></h2>
42 <p>ClutterTimeline — A class for time-based events</p>
43 </td>
44 <td valign="top" align="right"></td>
45 </tr></table></div>
46 <div class="refsynopsisdiv">
47 <a name="ClutterTimeline.synopsis"></a><h2>Synopsis</h2>
48 <pre class="synopsis">                    <a class="link" href="ClutterTimeline.html#ClutterTimeline-struct" title="ClutterTimeline">ClutterTimeline</a>;
49 struct              <a class="link" href="ClutterTimeline.html#ClutterTimelineClass" title="struct ClutterTimelineClass">ClutterTimelineClass</a>;
50 <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *   <a class="link" href="ClutterTimeline.html#clutter-timeline-new" title="clutter_timeline_new ()">clutter_timeline_new</a>                (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> msecs</code></em>);
51 <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *   <a class="link" href="ClutterTimeline.html#clutter-timeline-clone" title="clutter_timeline_clone ()">clutter_timeline_clone</a>              (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
52
53 <span class="returnvalue">void</span>                <a class="link" href="ClutterTimeline.html#clutter-timeline-set-duration" title="clutter_timeline_set_duration ()">clutter_timeline_set_duration</a>       (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
54                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> msecs</code></em>);
55 <a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="ClutterTimeline.html#clutter-timeline-get-duration" title="clutter_timeline_get_duration ()">clutter_timeline_get_duration</a>       (<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">void</span>                <a class="link" href="ClutterTimeline.html#clutter-timeline-set-repeat-count" title="clutter_timeline_set_repeat_count ()">clutter_timeline_set_repeat_count</a>   (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
57                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> count</code></em>);
58 <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="ClutterTimeline.html#clutter-timeline-get-repeat-count" title="clutter_timeline_get_repeat_count ()">clutter_timeline_get_repeat_count</a>   (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
59 <span class="returnvalue">void</span>                <a class="link" href="ClutterTimeline.html#clutter-timeline-set-delay" title="clutter_timeline_set_delay ()">clutter_timeline_set_delay</a>          (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
60                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> msecs</code></em>);
61 <a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="ClutterTimeline.html#clutter-timeline-get-delay" title="clutter_timeline_get_delay ()">clutter_timeline_get_delay</a>          (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
62 enum                <a class="link" href="ClutterTimeline.html#ClutterTimelineDirection" title="enum ClutterTimelineDirection">ClutterTimelineDirection</a>;
63 <span class="returnvalue">void</span>                <a class="link" href="ClutterTimeline.html#clutter-timeline-set-direction" title="clutter_timeline_set_direction ()">clutter_timeline_set_direction</a>      (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
64                                                          <em class="parameter"><code><a class="link" href="ClutterTimeline.html#ClutterTimelineDirection" title="enum ClutterTimelineDirection"><span class="type">ClutterTimelineDirection</span></a> direction</code></em>);
65 <a class="link" href="ClutterTimeline.html#ClutterTimelineDirection" title="enum ClutterTimelineDirection"><span class="returnvalue">ClutterTimelineDirection</span></a> <a class="link" href="ClutterTimeline.html#clutter-timeline-get-direction" title="clutter_timeline_get_direction ()">clutter_timeline_get_direction</a> (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
66 <span class="returnvalue">void</span>                <a class="link" href="ClutterTimeline.html#clutter-timeline-set-auto-reverse" title="clutter_timeline_set_auto_reverse ()">clutter_timeline_set_auto_reverse</a>   (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
67                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> reverse</code></em>);
68 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterTimeline.html#clutter-timeline-get-auto-reverse" title="clutter_timeline_get_auto_reverse ()">clutter_timeline_get_auto_reverse</a>   (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
69 <span class="returnvalue">void</span>                <a class="link" href="ClutterTimeline.html#clutter-timeline-set-progress-mode" title="clutter_timeline_set_progress_mode ()">clutter_timeline_set_progress_mode</a>  (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
70                                                          <em class="parameter"><code><a class="link" href="clutter-Implicit-Animations.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a> mode</code></em>);
71 <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="returnvalue">ClutterAnimationMode</span></a> <a class="link" href="ClutterTimeline.html#clutter-timeline-get-progress-mode" title="clutter_timeline_get_progress_mode ()">clutter_timeline_get_progress_mode</a> (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
72 <a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             (<a class="link" href="ClutterTimeline.html#ClutterTimelineProgressFunc" title="ClutterTimelineProgressFunc ()">*ClutterTimelineProgressFunc</a>)      (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
73                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> elapsed</code></em>,
74                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> total</code></em>,
75                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
76 <span class="returnvalue">void</span>                <a class="link" href="ClutterTimeline.html#clutter-timeline-set-progress-func" title="clutter_timeline_set_progress_func ()">clutter_timeline_set_progress_func</a>  (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
77                                                          <em class="parameter"><code><a class="link" href="ClutterTimeline.html#ClutterTimelineProgressFunc" title="ClutterTimelineProgressFunc ()"><span class="type">ClutterTimelineProgressFunc</span></a> func</code></em>,
78                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
79                                                          <em class="parameter"><code><a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);
80 <a href="../glib/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a>              <a class="link" href="ClutterTimeline.html#clutter-timeline-get-duration-hint" title="clutter_timeline_get_duration_hint ()">clutter_timeline_get_duration_hint</a>  (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
81 <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="ClutterTimeline.html#clutter-timeline-get-current-repeat" title="clutter_timeline_get_current_repeat ()">clutter_timeline_get_current_repeat</a> (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
82 <span class="returnvalue">void</span>                <a class="link" href="ClutterTimeline.html#clutter-timeline-set-loop" title="clutter_timeline_set_loop ()">clutter_timeline_set_loop</a>           (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
83                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> loop</code></em>);
84 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterTimeline.html#clutter-timeline-get-loop" title="clutter_timeline_get_loop ()">clutter_timeline_get_loop</a>           (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
85
86 <span class="returnvalue">void</span>                <a class="link" href="ClutterTimeline.html#clutter-timeline-start" title="clutter_timeline_start ()">clutter_timeline_start</a>              (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
87 <span class="returnvalue">void</span>                <a class="link" href="ClutterTimeline.html#clutter-timeline-pause" title="clutter_timeline_pause ()">clutter_timeline_pause</a>              (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
88 <span class="returnvalue">void</span>                <a class="link" href="ClutterTimeline.html#clutter-timeline-stop" title="clutter_timeline_stop ()">clutter_timeline_stop</a>               (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
89 <span class="returnvalue">void</span>                <a class="link" href="ClutterTimeline.html#clutter-timeline-rewind" title="clutter_timeline_rewind ()">clutter_timeline_rewind</a>             (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
90 <span class="returnvalue">void</span>                <a class="link" href="ClutterTimeline.html#clutter-timeline-skip" title="clutter_timeline_skip ()">clutter_timeline_skip</a>               (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
91                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> msecs</code></em>);
92 <span class="returnvalue">void</span>                <a class="link" href="ClutterTimeline.html#clutter-timeline-advance" title="clutter_timeline_advance ()">clutter_timeline_advance</a>            (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
93                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> msecs</code></em>);
94 <a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="ClutterTimeline.html#clutter-timeline-get-elapsed-time" title="clutter_timeline_get_elapsed_time ()">clutter_timeline_get_elapsed_time</a>   (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
95 <a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="ClutterTimeline.html#clutter-timeline-get-delta" title="clutter_timeline_get_delta ()">clutter_timeline_get_delta</a>          (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
96 <a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <a class="link" href="ClutterTimeline.html#clutter-timeline-get-progress" title="clutter_timeline_get_progress ()">clutter_timeline_get_progress</a>       (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
97 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterTimeline.html#clutter-timeline-is-playing" title="clutter_timeline_is_playing ()">clutter_timeline_is_playing</a>         (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
98
99 <span class="returnvalue">void</span>                <a class="link" href="ClutterTimeline.html#clutter-timeline-add-marker-at-time" title="clutter_timeline_add_marker_at_time ()">clutter_timeline_add_marker_at_time</a> (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
100                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *marker_name</code></em>,
101                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> msecs</code></em>);
102 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterTimeline.html#clutter-timeline-has-marker" title="clutter_timeline_has_marker ()">clutter_timeline_has_marker</a>         (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
103                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *marker_name</code></em>);
104 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **            <a class="link" href="ClutterTimeline.html#clutter-timeline-list-markers" title="clutter_timeline_list_markers ()">clutter_timeline_list_markers</a>       (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
105                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> msecs</code></em>,
106                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> *n_markers</code></em>);
107 <span class="returnvalue">void</span>                <a class="link" href="ClutterTimeline.html#clutter-timeline-remove-marker" title="clutter_timeline_remove_marker ()">clutter_timeline_remove_marker</a>      (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
108                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *marker_name</code></em>);
109 <span class="returnvalue">void</span>                <a class="link" href="ClutterTimeline.html#clutter-timeline-advance-to-marker" title="clutter_timeline_advance_to_marker ()">clutter_timeline_advance_to_marker</a>  (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
110                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *marker_name</code></em>);
111 </pre>
112 </div>
113 <div class="refsect1">
114 <a name="ClutterTimeline.object-hierarchy"></a><h2>Object Hierarchy</h2>
115 <pre class="synopsis">
116   <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
117    +----ClutterTimeline
118          +----<a class="link" href="ClutterTransition.html" title="ClutterTransition">ClutterTransition</a>
119 </pre>
120 </div>
121 <div class="refsect1">
122 <a name="ClutterTimeline.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
123 <p>
124 ClutterTimeline implements
125  <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>.</p>
126 </div>
127 <div class="refsect1">
128 <a name="ClutterTimeline.properties"></a><h2>Properties</h2>
129 <pre class="synopsis">
130   "<a class="link" href="ClutterTimeline.html#ClutterTimeline--auto-reverse" title='The "auto-reverse" property'>auto-reverse</a>"             <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
131   "<a class="link" href="ClutterTimeline.html#ClutterTimeline--delay" title='The "delay" property'>delay</a>"                    <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
132   "<a class="link" href="ClutterTimeline.html#ClutterTimeline--direction" title='The "direction" property'>direction</a>"                <a class="link" href="ClutterTimeline.html#ClutterTimelineDirection" title="enum ClutterTimelineDirection"><span class="type">ClutterTimelineDirection</span></a>  : Read / Write
133   "<a class="link" href="ClutterTimeline.html#ClutterTimeline--duration" title='The "duration" property'>duration</a>"                 <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
134   "<a class="link" href="ClutterTimeline.html#ClutterTimeline--loop" title='The "loop" property'>loop</a>"                     <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
135   "<a class="link" href="ClutterTimeline.html#ClutterTimeline--progress-mode" title='The "progress-mode" property'>progress-mode</a>"            <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a>  : Read / Write
136   "<a class="link" href="ClutterTimeline.html#ClutterTimeline--repeat-count" title='The "repeat-count" property'>repeat-count</a>"             <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
137 </pre>
138 </div>
139 <div class="refsect1">
140 <a name="ClutterTimeline.signals"></a><h2>Signals</h2>
141 <pre class="synopsis">
142   "<a class="link" href="ClutterTimeline.html#ClutterTimeline-completed" title='The "completed" signal'>completed</a>"                                      : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
143   "<a class="link" href="ClutterTimeline.html#ClutterTimeline-marker-reached" title='The "marker-reached" signal'>marker-reached</a>"                                 : <a href="../gobject/gobject-Signals.html#G-SIGNAL-NO-HOOKS:CAPS"><code class="literal">No Hooks</code></a>
144   "<a class="link" href="ClutterTimeline.html#ClutterTimeline-new-frame" title='The "new-frame" signal'>new-frame</a>"                                      : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
145   "<a class="link" href="ClutterTimeline.html#ClutterTimeline-paused" title='The "paused" signal'>paused</a>"                                         : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
146   "<a class="link" href="ClutterTimeline.html#ClutterTimeline-started" title='The "started" signal'>started</a>"                                        : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
147 </pre>
148 </div>
149 <div class="refsect1">
150 <a name="ClutterTimeline.description"></a><h2>Description</h2>
151 <p>
152 <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> is a base class for managing time-based event that cause
153 Clutter to redraw a stage, such as animations.
154 </p>
155 <p>
156 Each <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> instance has a duration: once a timeline has been
157 started, using <a class="link" href="ClutterTimeline.html#clutter-timeline-start" title="clutter_timeline_start ()"><code class="function">clutter_timeline_start()</code></a>, it will emit a signal that can
158 be used to update the state of the actors.
159 </p>
160 <p>
161 It is important to note that <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> is not a generic API for
162 calling closures after an interval; each Timeline is tied into the master
163 clock used to drive the frame cycle. If you need to schedule a closure
164 after an interval, see <a class="link" href="clutter-General.html#clutter-threads-add-timeout" title="clutter_threads_add_timeout ()"><code class="function">clutter_threads_add_timeout()</code></a> instead.
165 </p>
166 <p>
167 Users of <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> should connect to the <a class="link" href="ClutterTimeline.html#ClutterTimeline-new-frame" title='The "new-frame" signal'><span class="type">"new-frame"</span></a>
168 signal, which is emitted each time a timeline is advanced during the maste
169 clock iteration. The <a class="link" href="ClutterTimeline.html#ClutterTimeline-new-frame" title='The "new-frame" signal'><span class="type">"new-frame"</span></a> signal provides the time
170 elapsed since the beginning of the timeline, in milliseconds. A normalized
171 progress value can be obtained by calling <a class="link" href="ClutterTimeline.html#clutter-timeline-get-progress" title="clutter_timeline_get_progress ()"><code class="function">clutter_timeline_get_progress()</code></a>.
172 By using <a class="link" href="ClutterTimeline.html#clutter-timeline-get-delta" title="clutter_timeline_get_delta ()"><code class="function">clutter_timeline_get_delta()</code></a> it is possible to obtain the wallclock
173 time elapsed since the last emission of the <a class="link" href="ClutterTimeline.html#ClutterTimeline-new-frame" title='The "new-frame" signal'><span class="type">"new-frame"</span></a>
174 signal.
175 </p>
176 <p>
177 Initial state can be set up by using the <a class="link" href="ClutterTimeline.html#ClutterTimeline-started" title='The "started" signal'><span class="type">"started"</span></a> signal,
178 while final state can be set up by using the <a class="link" href="ClutterTimeline.html#ClutterTimeline-completed" title='The "completed" signal'><span class="type">"completed"</span></a>
179 signal. The <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> guarantees the emission of at least a single
180 <a class="link" href="ClutterTimeline.html#ClutterTimeline-new-frame" title='The "new-frame" signal'><span class="type">"new-frame"</span></a> signal, as well as the emission of the
181 <a class="link" href="ClutterTimeline.html#ClutterTimeline-completed" title='The "completed" signal'><span class="type">"completed"</span></a> signal.
182 </p>
183 <p>
184 It is possible to connect to specific points in the timeline progress by
185 adding <span class="emphasis"><em>markers</em></span> using <a class="link" href="ClutterTimeline.html#clutter-timeline-add-marker-at-time" title="clutter_timeline_add_marker_at_time ()"><code class="function">clutter_timeline_add_marker_at_time()</code></a>
186 and connecting to the <a class="link" href="ClutterTimeline.html#ClutterTimeline-marker-reached" title='The "marker-reached" signal'><span class="type">"marker-reached"</span></a> signal.
187 </p>
188 <p>
189 Timelines can be made to loop once they reach the end of their duration, by
190 using <a class="link" href="ClutterTimeline.html#clutter-timeline-set-repeat-count" title="clutter_timeline_set_repeat_count ()"><code class="function">clutter_timeline_set_repeat_count()</code></a>; a looping timeline will still
191 emit the <a class="link" href="ClutterTimeline.html#ClutterTimeline-completed" title='The "completed" signal'><span class="type">"completed"</span></a> signal once it reaches the end of its
192 duration.
193 </p>
194 <p>
195 Timelines have a <a class="link" href="ClutterTimeline.html#ClutterTimeline--direction" title='The "direction" property'><span class="type">"direction"</span></a>: the default direction is
196 <a class="link" href="ClutterTimeline.html#CLUTTER-TIMELINE-FORWARD:CAPS"><code class="literal">CLUTTER_TIMELINE_FORWARD</code></a>, and goes from 0 to the duration; it is possible
197 to change the direction to <a class="link" href="ClutterTimeline.html#CLUTTER-TIMELINE-BACKWARD:CAPS"><code class="literal">CLUTTER_TIMELINE_BACKWARD</code></a>, and have the timeline
198 go from the duration to 0. The direction can be automatically reversed
199 when reaching completion by using the <a class="link" href="ClutterTimeline.html#ClutterTimeline--auto-reverse" title='The "auto-reverse" property'><span class="type">"auto-reverse"</span></a> property.
200 </p>
201 <p>
202 Timelines are used in the Clutter animation framework by classes like
203 <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a>, <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>, and <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>.
204 </p>
205 <p>
206 </p>
207 <div class="refsect2">
208 <a name="timeline-script"></a><h3>Defining Timelines in ClutterScript</h3>
209 <p>A <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> can be described in <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> like any
210  other object. Additionally, it is possible to define markers directly
211  inside the JSON definition by using the <span class="emphasis"><em>markers</em></span>
212  JSON object member, such as:</p>
213 <div class="informalexample">
214   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
215     <tbody>
216       <tr>
217         <td class="listing_lines" align="right"><pre>1
218 2
219 3
220 4
221 5
222 6
223 7
224 8
225 9</pre></td>
226         <td class="listing_code"><pre class="programlisting"><span class="cbracket">{</span>
227 <span class="normal">  </span><span class="string">"type"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"ClutterTimeline"</span><span class="symbol">,</span>
228 <span class="normal">  </span><span class="string">"duration"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="number">1000</span><span class="symbol">,</span>
229 <span class="normal">  </span><span class="string">"markers"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="symbol">[</span>
230 <span class="normal">    </span><span class="cbracket">{</span><span class="normal"> </span><span class="string">"name"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"quarter"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"time"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="number">250</span><span class="normal"> </span><span class="cbracket">}</span><span class="symbol">,</span>
231 <span class="normal">    </span><span class="cbracket">{</span><span class="normal"> </span><span class="string">"name"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"half-time"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"time"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="number">500</span><span class="normal"> </span><span class="cbracket">}</span><span class="symbol">,</span>
232 <span class="normal">    </span><span class="cbracket">{</span><span class="normal"> </span><span class="string">"name"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"three-quarters"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"time"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="number">750</span><span class="normal"> </span><span class="cbracket">}</span>
233 <span class="normal">  </span><span class="symbol">]</span>
234 <span class="cbracket">}</span></pre></td>
235       </tr>
236     </tbody>
237   </table>
238 </div>
239
240 </div>
241 <p>
242 </p>
243 </div>
244 <div class="refsect1">
245 <a name="ClutterTimeline.details"></a><h2>Details</h2>
246 <div class="refsect2">
247 <a name="ClutterTimeline-struct"></a><h3>ClutterTimeline</h3>
248 <pre class="programlisting">typedef struct _ClutterTimeline ClutterTimeline;</pre>
249 <p>
250 The <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> structure contains only private data
251 and should be accessed using the provided API
252 </p>
253 <p class="since">Since 0.2</p>
254 </div>
255 <hr>
256 <div class="refsect2">
257 <a name="ClutterTimelineClass"></a><h3>struct ClutterTimelineClass</h3>
258 <pre class="programlisting">struct ClutterTimelineClass {
259   void (*started)        (ClutterTimeline *timeline);
260   void (*completed)      (ClutterTimeline *timeline);
261   void (*paused)         (ClutterTimeline *timeline);
262   
263   void (*new_frame)      (ClutterTimeline *timeline,
264                           gint             msecs);
265
266   void (*marker_reached) (ClutterTimeline *timeline,
267                           const gchar     *marker_name,
268                           gint             msecs);
269 };
270 </pre>
271 <p>
272 The <a class="link" href="ClutterTimeline.html#ClutterTimelineClass" title="struct ClutterTimelineClass"><span class="type">ClutterTimelineClass</span></a> structure contains only private data
273 </p>
274 <div class="variablelist"><table border="0">
275 <col align="left" valign="top">
276 <tbody>
277 <tr>
278 <td><p><span class="term"><em class="structfield"><code><a name="ClutterTimelineClass.started"></a>started</code></em> ()</span></p></td>
279 <td>handler for the <a class="link" href="ClutterTimeline.html#ClutterTimeline-started" title='The "started" signal'><span class="type">"started"</span></a> signal</td>
280 </tr>
281 <tr>
282 <td><p><span class="term"><em class="structfield"><code><a name="ClutterTimelineClass.completed"></a>completed</code></em> ()</span></p></td>
283 <td>handler for the <a class="link" href="ClutterTimeline.html#ClutterTimeline-completed" title='The "completed" signal'><span class="type">"completed"</span></a> signal</td>
284 </tr>
285 <tr>
286 <td><p><span class="term"><em class="structfield"><code><a name="ClutterTimelineClass.paused"></a>paused</code></em> ()</span></p></td>
287 <td>handler for the <a class="link" href="ClutterTimeline.html#ClutterTimeline-paused" title='The "paused" signal'><span class="type">"paused"</span></a> signal</td>
288 </tr>
289 <tr>
290 <td><p><span class="term"><em class="structfield"><code><a name="ClutterTimelineClass.new-frame"></a>new_frame</code></em> ()</span></p></td>
291 <td>handler for the <a class="link" href="ClutterTimeline.html#ClutterTimeline-new-frame" title='The "new-frame" signal'><span class="type">"new-frame"</span></a> signal</td>
292 </tr>
293 <tr>
294 <td><p><span class="term"><em class="structfield"><code><a name="ClutterTimelineClass.marker-reached"></a>marker_reached</code></em> ()</span></p></td>
295 <td>handler for the <a class="link" href="ClutterTimeline.html#ClutterTimeline-marker-reached" title='The "marker-reached" signal'><span class="type">"marker-reached"</span></a> signal</td>
296 </tr>
297 </tbody>
298 </table></div>
299 <p class="since">Since 0.2</p>
300 </div>
301 <hr>
302 <div class="refsect2">
303 <a name="clutter-timeline-new"></a><h3>clutter_timeline_new ()</h3>
304 <pre class="programlisting"><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *   clutter_timeline_new                (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> msecs</code></em>);</pre>
305 <p>
306 Creates a new <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> with a duration of <em class="parameter"><code>msecs</code></em>.
307 </p>
308 <div class="variablelist"><table border="0">
309 <col align="left" valign="top">
310 <tbody>
311 <tr>
312 <td><p><span class="term"><em class="parameter"><code>msecs</code></em> :</span></p></td>
313 <td>Duration of the timeline in milliseconds</td>
314 </tr>
315 <tr>
316 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
317 <td>the newly created <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> instance. Use
318 <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when done using it</td>
319 </tr>
320 </tbody>
321 </table></div>
322 <p class="since">Since 0.6</p>
323 </div>
324 <hr>
325 <div class="refsect2">
326 <a name="clutter-timeline-clone"></a><h3>clutter_timeline_clone ()</h3>
327 <pre class="programlisting"><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *   clutter_timeline_clone              (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
328 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
329 <h3 class="title">Warning</h3>
330 <p><code class="literal">clutter_timeline_clone</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use <a class="link" href="ClutterTimeline.html#clutter-timeline-new" title="clutter_timeline_new ()"><code class="function">clutter_timeline_new()</code></a> or <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-new"><code class="function">g_object_new()</code></a>
331   instead</p>
332 </div>
333 <p>
334 Create a new <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> instance which has property values
335 matching that of supplied timeline. The cloned timeline will not
336 be started and will not be positioned to the current position of
337 the original <em class="parameter"><code>timeline</code></em>: you will have to start it with <a class="link" href="ClutterTimeline.html#clutter-timeline-start" title="clutter_timeline_start ()"><code class="function">clutter_timeline_start()</code></a>.
338 </p>
339 <p>
340 </p>
341 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
342 <h3 class="title">Note</h3>
343 <p>The only cloned properties are:</p>
344 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
345 <li class="listitem"><a class="link" href="ClutterTimeline.html#ClutterTimeline--duration" title='The "duration" property'><span class="type">"duration"</span></a></li>
346 <li class="listitem"><a class="link" href="ClutterTimeline.html#ClutterTimeline--loop" title='The "loop" property'><span class="type">"loop"</span></a></li>
347 <li class="listitem"><a class="link" href="ClutterTimeline.html#ClutterTimeline--delay" title='The "delay" property'><span class="type">"delay"</span></a></li>
348 <li class="listitem"><a class="link" href="ClutterTimeline.html#ClutterTimeline--direction" title='The "direction" property'><span class="type">"direction"</span></a></li>
349 </ul></div>
350 </div>
351 <p>
352 </p>
353 <div class="variablelist"><table border="0">
354 <col align="left" valign="top">
355 <tbody>
356 <tr>
357 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
358 <td>
359 <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> to duplicate.</td>
360 </tr>
361 <tr>
362 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
363 <td>a new <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>, cloned
364 from <em class="parameter"><code>timeline</code></em>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
365 </td>
366 </tr>
367 </tbody>
368 </table></div>
369 <p class="since">Since 0.4</p>
370 </div>
371 <hr>
372 <div class="refsect2">
373 <a name="clutter-timeline-set-duration"></a><h3>clutter_timeline_set_duration ()</h3>
374 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_timeline_set_duration       (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
375                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> msecs</code></em>);</pre>
376 <p>
377 Sets the duration of the timeline, in milliseconds. The speed
378 of the timeline depends on the ClutterTimeline:fps setting.
379 </p>
380 <div class="variablelist"><table border="0">
381 <col align="left" valign="top">
382 <tbody>
383 <tr>
384 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
385 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
386 </td>
387 </tr>
388 <tr>
389 <td><p><span class="term"><em class="parameter"><code>msecs</code></em> :</span></p></td>
390 <td>duration of the timeline in milliseconds</td>
391 </tr>
392 </tbody>
393 </table></div>
394 <p class="since">Since 0.6</p>
395 </div>
396 <hr>
397 <div class="refsect2">
398 <a name="clutter-timeline-get-duration"></a><h3>clutter_timeline_get_duration ()</h3>
399 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               clutter_timeline_get_duration       (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
400 <p>
401 Retrieves the duration of a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> in milliseconds.
402 See <a class="link" href="ClutterTimeline.html#clutter-timeline-set-duration" title="clutter_timeline_set_duration ()"><code class="function">clutter_timeline_set_duration()</code></a>.
403 </p>
404 <div class="variablelist"><table border="0">
405 <col align="left" valign="top">
406 <tbody>
407 <tr>
408 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
409 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
410 </td>
411 </tr>
412 <tr>
413 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
414 <td>the duration of the timeline, in milliseconds.</td>
415 </tr>
416 </tbody>
417 </table></div>
418 <p class="since">Since 0.6</p>
419 </div>
420 <hr>
421 <div class="refsect2">
422 <a name="clutter-timeline-set-repeat-count"></a><h3>clutter_timeline_set_repeat_count ()</h3>
423 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_timeline_set_repeat_count   (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
424                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> count</code></em>);</pre>
425 <p>
426 Sets the number of times the <em class="parameter"><code>timeline</code></em> should repeat.
427 </p>
428 <p>
429 If <em class="parameter"><code>count</code></em> is 0, the timeline never repeats.
430 </p>
431 <p>
432 If <em class="parameter"><code>count</code></em> is -1, the timeline will always repeat until
433 it's stopped.
434 </p>
435 <div class="variablelist"><table border="0">
436 <col align="left" valign="top">
437 <tbody>
438 <tr>
439 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
440 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
441 </td>
442 </tr>
443 <tr>
444 <td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
445 <td>the number of times the timeline should repeat</td>
446 </tr>
447 </tbody>
448 </table></div>
449 <p class="since">Since 1.10</p>
450 </div>
451 <hr>
452 <div class="refsect2">
453 <a name="clutter-timeline-get-repeat-count"></a><h3>clutter_timeline_get_repeat_count ()</h3>
454 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                clutter_timeline_get_repeat_count   (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
455 <p>
456 Retrieves the number set using <a class="link" href="ClutterTimeline.html#clutter-timeline-set-repeat-count" title="clutter_timeline_set_repeat_count ()"><code class="function">clutter_timeline_set_repeat_count()</code></a>.
457 </p>
458 <div class="variablelist"><table border="0">
459 <col align="left" valign="top">
460 <tbody>
461 <tr>
462 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
463 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
464 </td>
465 </tr>
466 <tr>
467 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
468 <td>the number of repeats</td>
469 </tr>
470 </tbody>
471 </table></div>
472 <p class="since">Since 1.10</p>
473 </div>
474 <hr>
475 <div class="refsect2">
476 <a name="clutter-timeline-set-delay"></a><h3>clutter_timeline_set_delay ()</h3>
477 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_timeline_set_delay          (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
478                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> msecs</code></em>);</pre>
479 <p>
480 Sets the delay, in milliseconds, before <em class="parameter"><code>timeline</code></em> should start.
481 </p>
482 <div class="variablelist"><table border="0">
483 <col align="left" valign="top">
484 <tbody>
485 <tr>
486 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
487 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
488 </td>
489 </tr>
490 <tr>
491 <td><p><span class="term"><em class="parameter"><code>msecs</code></em> :</span></p></td>
492 <td>delay in milliseconds</td>
493 </tr>
494 </tbody>
495 </table></div>
496 <p class="since">Since 0.4</p>
497 </div>
498 <hr>
499 <div class="refsect2">
500 <a name="clutter-timeline-get-delay"></a><h3>clutter_timeline_get_delay ()</h3>
501 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               clutter_timeline_get_delay          (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
502 <p>
503 Retrieves the delay set using <a class="link" href="ClutterTimeline.html#clutter-timeline-set-delay" title="clutter_timeline_set_delay ()"><code class="function">clutter_timeline_set_delay()</code></a>.
504 </p>
505 <div class="variablelist"><table border="0">
506 <col align="left" valign="top">
507 <tbody>
508 <tr>
509 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
510 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
511 </td>
512 </tr>
513 <tr>
514 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
515 <td>the delay in milliseconds.</td>
516 </tr>
517 </tbody>
518 </table></div>
519 <p class="since">Since 0.4</p>
520 </div>
521 <hr>
522 <div class="refsect2">
523 <a name="ClutterTimelineDirection"></a><h3>enum ClutterTimelineDirection</h3>
524 <pre class="programlisting">typedef enum {
525   CLUTTER_TIMELINE_FORWARD,
526   CLUTTER_TIMELINE_BACKWARD
527 } ClutterTimelineDirection;
528 </pre>
529 <p>
530 The direction of a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
531 </p>
532 <div class="variablelist"><table border="0">
533 <col align="left" valign="top">
534 <tbody>
535 <tr>
536 <td><p><a name="CLUTTER-TIMELINE-FORWARD:CAPS"></a><span class="term"><code class="literal">CLUTTER_TIMELINE_FORWARD</code></span></p></td>
537 <td>forward direction for a timeline
538 </td>
539 </tr>
540 <tr>
541 <td><p><a name="CLUTTER-TIMELINE-BACKWARD:CAPS"></a><span class="term"><code class="literal">CLUTTER_TIMELINE_BACKWARD</code></span></p></td>
542 <td>backward direction for a timeline
543 </td>
544 </tr>
545 </tbody>
546 </table></div>
547 <p class="since">Since 0.6</p>
548 </div>
549 <hr>
550 <div class="refsect2">
551 <a name="clutter-timeline-set-direction"></a><h3>clutter_timeline_set_direction ()</h3>
552 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_timeline_set_direction      (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
553                                                          <em class="parameter"><code><a class="link" href="ClutterTimeline.html#ClutterTimelineDirection" title="enum ClutterTimelineDirection"><span class="type">ClutterTimelineDirection</span></a> direction</code></em>);</pre>
554 <p>
555 Sets the direction of <em class="parameter"><code>timeline</code></em>, either <a class="link" href="ClutterTimeline.html#CLUTTER-TIMELINE-FORWARD:CAPS"><code class="literal">CLUTTER_TIMELINE_FORWARD</code></a> or
556 <a class="link" href="ClutterTimeline.html#CLUTTER-TIMELINE-BACKWARD:CAPS"><code class="literal">CLUTTER_TIMELINE_BACKWARD</code></a>.
557 </p>
558 <div class="variablelist"><table border="0">
559 <col align="left" valign="top">
560 <tbody>
561 <tr>
562 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
563 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
564 </td>
565 </tr>
566 <tr>
567 <td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
568 <td>the direction of the timeline</td>
569 </tr>
570 </tbody>
571 </table></div>
572 <p class="since">Since 0.6</p>
573 </div>
574 <hr>
575 <div class="refsect2">
576 <a name="clutter-timeline-get-direction"></a><h3>clutter_timeline_get_direction ()</h3>
577 <pre class="programlisting"><a class="link" href="ClutterTimeline.html#ClutterTimelineDirection" title="enum ClutterTimelineDirection"><span class="returnvalue">ClutterTimelineDirection</span></a> clutter_timeline_get_direction (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
578 <p>
579 Retrieves the direction of the timeline set with
580 <a class="link" href="ClutterTimeline.html#clutter-timeline-set-direction" title="clutter_timeline_set_direction ()"><code class="function">clutter_timeline_set_direction()</code></a>.
581 </p>
582 <div class="variablelist"><table border="0">
583 <col align="left" valign="top">
584 <tbody>
585 <tr>
586 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
587 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
588 </td>
589 </tr>
590 <tr>
591 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
592 <td>the direction of the timeline</td>
593 </tr>
594 </tbody>
595 </table></div>
596 <p class="since">Since 0.6</p>
597 </div>
598 <hr>
599 <div class="refsect2">
600 <a name="clutter-timeline-set-auto-reverse"></a><h3>clutter_timeline_set_auto_reverse ()</h3>
601 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_timeline_set_auto_reverse   (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
602                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> reverse</code></em>);</pre>
603 <p>
604 Sets whether <em class="parameter"><code>timeline</code></em> should reverse the direction after the
605 emission of the <a class="link" href="ClutterTimeline.html#ClutterTimeline-completed" title='The "completed" signal'><span class="type">"completed"</span></a> signal.
606 </p>
607 <p>
608 Setting the <a class="link" href="ClutterTimeline.html#ClutterTimeline--auto-reverse" title='The "auto-reverse" property'><span class="type">"auto-reverse"</span></a> property to <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is the
609 equivalent of connecting a callback to the <a class="link" href="ClutterTimeline.html#ClutterTimeline-completed" title='The "completed" signal'><span class="type">"completed"</span></a>
610 signal and changing the direction of the timeline from that callback;
611 for instance, this code:
612 </p>
613 <p>
614 </p>
615 <div class="informalexample">
616   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
617     <tbody>
618       <tr>
619         <td class="listing_lines" align="right"><pre>1
620 2
621 3
622 4
623 5
624 6
625 7
626 8
627 9
628 10
629 11
630 12
631 13
632 14
633 15
634 16
635 17
636 18</pre></td>
637         <td class="listing_code"><pre class="programlisting"><span class="keyword">static</span><span class="normal"> </span><span class="type">void</span>
638 <span class="function">reverse_timeline</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">ClutterTimeline</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">timeline</span><span class="symbol">)</span>
639 <span class="cbracket">{</span>
640 <span class="normal">  </span><span class="usertype">ClutterTimelineDirection</span><span class="normal"> dir </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="ClutterTimeline.html#clutter-timeline-get-direction">clutter_timeline_get_direction</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">timeline</span><span class="symbol">);</span>
641
642 <span class="normal">  </span><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">dir </span><span class="symbol">==</span><span class="normal"> <a href="ClutterTimeline.html#CLUTTER-TIMELINE-FORWARD:CAPS">CLUTTER_TIMELINE_FORWARD</a></span><span class="symbol">)</span>
643 <span class="normal">    dir </span><span class="symbol">=</span><span class="normal"> <a href="ClutterTimeline.html#CLUTTER-TIMELINE-BACKWARD:CAPS">CLUTTER_TIMELINE_BACKWARD</a></span><span class="symbol">;</span>
644 <span class="normal">  </span><span class="keyword">else</span>
645 <span class="normal">    dir </span><span class="symbol">=</span><span class="normal"> <a href="ClutterTimeline.html#CLUTTER-TIMELINE-FORWARD:CAPS">CLUTTER_TIMELINE_FORWARD</a></span><span class="symbol">;</span>
646
647 <span class="normal">  </span><span class="function"><a href="ClutterTimeline.html#clutter-timeline-set-direction">clutter_timeline_set_direction</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">timeline</span><span class="symbol">,</span><span class="normal"> dir</span><span class="symbol">);</span>
648 <span class="cbracket">}</span>
649 <span class="symbol">...</span>
650 <span class="normal">  timeline </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="ClutterTimeline.html#clutter-timeline-new">clutter_timeline_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="number">1000</span><span class="symbol">);</span>
651 <span class="normal">  </span><span class="function"><a href="ClutterTimeline.html#clutter-timeline-set-repeat-count">clutter_timeline_set_repeat_count</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">timeline</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">-</span><span class="number">1</span><span class="symbol">);</span>
652 <span class="normal">  </span><span class="function"><a href="../gobject/gobject-Signals.html#g-signal-connect">g_signal_connect</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">timeline</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"completed"</span><span class="symbol">,</span>
653 <span class="normal">                    </span><span class="function"><a href="../gobject/gobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">reverse_timeline</span><span class="symbol">),</span>
654 <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></pre></td>
655       </tr>
656     </tbody>
657   </table>
658 </div>
659
660 <p>
661 </p>
662 <p>
663 can be effectively replaced by:
664 </p>
665 <p>
666 </p>
667 <div class="informalexample">
668   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
669     <tbody>
670       <tr>
671         <td class="listing_lines" align="right"><pre>1
672 2
673 3</pre></td>
674         <td class="listing_code"><pre class="programlisting"><span class="normal">timeline </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="ClutterTimeline.html#clutter-timeline-new">clutter_timeline_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="number">1000</span><span class="symbol">);</span>
675 <span class="function"><a href="ClutterTimeline.html#clutter-timeline-set-repeat-count">clutter_timeline_set_repeat_count</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">timeline</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">-</span><span class="number">1</span><span class="symbol">);</span>
676 <span class="function"><a href="ClutterTimeline.html#clutter-timeline-set-auto-reverse">clutter_timeline_set_auto_reverse</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">timeline</span><span class="symbol">);</span></pre></td>
677       </tr>
678     </tbody>
679   </table>
680 </div>
681
682 <p>
683 </p>
684 <div class="variablelist"><table border="0">
685 <col align="left" valign="top">
686 <tbody>
687 <tr>
688 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
689 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
690 </td>
691 </tr>
692 <tr>
693 <td><p><span class="term"><em class="parameter"><code>reverse</code></em> :</span></p></td>
694 <td>
695 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <em class="parameter"><code>timeline</code></em> should reverse the direction</td>
696 </tr>
697 </tbody>
698 </table></div>
699 <p class="since">Since 1.6</p>
700 </div>
701 <hr>
702 <div class="refsect2">
703 <a name="clutter-timeline-get-auto-reverse"></a><h3>clutter_timeline_get_auto_reverse ()</h3>
704 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_timeline_get_auto_reverse   (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
705 <p>
706 Retrieves the value set by <a class="link" href="ClutterTimeline.html#clutter-timeline-set-auto-reverse" title="clutter_timeline_set_auto_reverse ()"><code class="function">clutter_timeline_set_auto_reverse()</code></a>.
707 </p>
708 <div class="variablelist"><table border="0">
709 <col align="left" valign="top">
710 <tbody>
711 <tr>
712 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
713 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
714 </td>
715 </tr>
716 <tr>
717 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
718 <td>
719 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the timeline should automatically reverse, and
720 <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
721 </tr>
722 </tbody>
723 </table></div>
724 <p class="since">Since 1.6</p>
725 </div>
726 <hr>
727 <div class="refsect2">
728 <a name="clutter-timeline-set-progress-mode"></a><h3>clutter_timeline_set_progress_mode ()</h3>
729 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_timeline_set_progress_mode  (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
730                                                          <em class="parameter"><code><a class="link" href="clutter-Implicit-Animations.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a> mode</code></em>);</pre>
731 <p>
732 Sets the progress function using a value from the <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a>
733 enumeration. The <em class="parameter"><code>mode</code></em> cannot be <a class="link" href="clutter-Implicit-Animations.html#CLUTTER-CUSTOM-MODE:CAPS"><code class="literal">CLUTTER_CUSTOM_MODE</code></a> or bigger than
734 <a class="link" href="clutter-Implicit-Animations.html#CLUTTER-ANIMATION-LAST:CAPS"><code class="literal">CLUTTER_ANIMATION_LAST</code></a>.
735 </p>
736 <div class="variablelist"><table border="0">
737 <col align="left" valign="top">
738 <tbody>
739 <tr>
740 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
741 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
742 </td>
743 </tr>
744 <tr>
745 <td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
746 <td>the progress mode, as a <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a>
747 </td>
748 </tr>
749 </tbody>
750 </table></div>
751 <p class="since">Since 1.10</p>
752 </div>
753 <hr>
754 <div class="refsect2">
755 <a name="clutter-timeline-get-progress-mode"></a><h3>clutter_timeline_get_progress_mode ()</h3>
756 <pre class="programlisting"><a class="link" href="clutter-Implicit-Animations.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="returnvalue">ClutterAnimationMode</span></a> clutter_timeline_get_progress_mode (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
757 <p>
758 Retrieves the progress mode set using <a class="link" href="ClutterTimeline.html#clutter-timeline-set-progress-mode" title="clutter_timeline_set_progress_mode ()"><code class="function">clutter_timeline_set_progress_mode()</code></a>
759 or <a class="link" href="ClutterTimeline.html#clutter-timeline-set-progress-func" title="clutter_timeline_set_progress_func ()"><code class="function">clutter_timeline_set_progress_func()</code></a>.
760 </p>
761 <div class="variablelist"><table border="0">
762 <col align="left" valign="top">
763 <tbody>
764 <tr>
765 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
766 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
767 </td>
768 </tr>
769 <tr>
770 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
771 <td>a <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a>
772 </td>
773 </tr>
774 </tbody>
775 </table></div>
776 <p class="since">Since 1.10</p>
777 </div>
778 <hr>
779 <div class="refsect2">
780 <a name="ClutterTimelineProgressFunc"></a><h3>ClutterTimelineProgressFunc ()</h3>
781 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             (*ClutterTimelineProgressFunc)      (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
782                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> elapsed</code></em>,
783                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> total</code></em>,
784                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
785 <p>
786 A function for defining a custom progress.
787 </p>
788 <div class="variablelist"><table border="0">
789 <col align="left" valign="top">
790 <tbody>
791 <tr>
792 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
793 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
794 </td>
795 </tr>
796 <tr>
797 <td><p><span class="term"><em class="parameter"><code>elapsed</code></em> :</span></p></td>
798 <td>the elapsed time, in milliseconds</td>
799 </tr>
800 <tr>
801 <td><p><span class="term"><em class="parameter"><code>total</code></em> :</span></p></td>
802 <td>the total duration of the timeline, in milliseconds,</td>
803 </tr>
804 <tr>
805 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
806 <td>data passed to the function</td>
807 </tr>
808 <tr>
809 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
810 <td>the progress, as a floating point value between -1.0 and 2.0.</td>
811 </tr>
812 </tbody>
813 </table></div>
814 <p class="since">Since 1.10</p>
815 </div>
816 <hr>
817 <div class="refsect2">
818 <a name="clutter-timeline-set-progress-func"></a><h3>clutter_timeline_set_progress_func ()</h3>
819 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_timeline_set_progress_func  (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
820                                                          <em class="parameter"><code><a class="link" href="ClutterTimeline.html#ClutterTimelineProgressFunc" title="ClutterTimelineProgressFunc ()"><span class="type">ClutterTimelineProgressFunc</span></a> func</code></em>,
821                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
822                                                          <em class="parameter"><code><a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);</pre>
823 <p>
824 Sets a custom progress function for <em class="parameter"><code>timeline</code></em>. The progress function will
825 be called by <a class="link" href="ClutterTimeline.html#clutter-timeline-get-progress" title="clutter_timeline_get_progress ()"><code class="function">clutter_timeline_get_progress()</code></a> and will be used to compute
826 the progress value based on the elapsed time and the total duration of the
827 timeline.
828 </p>
829 <p>
830 If <em class="parameter"><code>func</code></em> is not <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, the <a class="link" href="ClutterTimeline.html#ClutterTimeline--progress-mode" title='The "progress-mode" property'><span class="type">"progress-mode"</span></a> property will
831 be set to <a class="link" href="clutter-Implicit-Animations.html#CLUTTER-CUSTOM-MODE:CAPS"><code class="literal">CLUTTER_CUSTOM_MODE</code></a>.
832 </p>
833 <p>
834 If <em class="parameter"><code>func</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>, any previously set progress function will be unset, and
835 the <a class="link" href="ClutterTimeline.html#ClutterTimeline--progress-mode" title='The "progress-mode" property'><span class="type">"progress-mode"</span></a> property will be set to <a class="link" href="clutter-Implicit-Animations.html#CLUTTER-LINEAR:CAPS"><code class="literal">CLUTTER_LINEAR</code></a>.
836 </p>
837 <div class="variablelist"><table border="0">
838 <col align="left" valign="top">
839 <tbody>
840 <tr>
841 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
842 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
843 </td>
844 </tr>
845 <tr>
846 <td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
847 <td>a progress function, 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="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
848 </td>
849 </tr>
850 <tr>
851 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
852 <td>data to pass to <em class="parameter"><code>func</code></em>. <span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span>
853 </td>
854 </tr>
855 <tr>
856 <td><p><span class="term"><em class="parameter"><code>notify</code></em> :</span></p></td>
857 <td>a function to be called when the progress function is removed
858 or the timeline is disposed</td>
859 </tr>
860 </tbody>
861 </table></div>
862 <p class="since">Since 1.10</p>
863 </div>
864 <hr>
865 <div class="refsect2">
866 <a name="clutter-timeline-get-duration-hint"></a><h3>clutter_timeline_get_duration_hint ()</h3>
867 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a>              clutter_timeline_get_duration_hint  (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
868 <p>
869 Retrieves the full duration of the <em class="parameter"><code>timeline</code></em>, taking into account the
870 current value of the <a class="link" href="ClutterTimeline.html#ClutterTimeline--repeat-count" title='The "repeat-count" property'><span class="type">"repeat-count"</span></a> property.
871 </p>
872 <p>
873 If the <a class="link" href="ClutterTimeline.html#ClutterTimeline--repeat-count" title='The "repeat-count" property'><span class="type">"repeat-count"</span></a> property is set to -1, this function
874 will return <a href="../glib/glib-Basic-Types.html#G-MAXINT64:CAPS"><code class="literal">G_MAXINT64</code></a>.
875 </p>
876 <p>
877 The returned value is to be considered a hint, and it's only valid
878 as long as the <em class="parameter"><code>timeline</code></em> hasn't been changed.
879 </p>
880 <div class="variablelist"><table border="0">
881 <col align="left" valign="top">
882 <tbody>
883 <tr>
884 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
885 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
886 </td>
887 </tr>
888 <tr>
889 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
890 <td>the full duration of the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
891 </td>
892 </tr>
893 </tbody>
894 </table></div>
895 <p class="since">Since 1.10</p>
896 </div>
897 <hr>
898 <div class="refsect2">
899 <a name="clutter-timeline-get-current-repeat"></a><h3>clutter_timeline_get_current_repeat ()</h3>
900 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                clutter_timeline_get_current_repeat (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
901 <p>
902 Retrieves the current repeat for a timeline.
903 </p>
904 <p>
905 Repeats start at 0.
906 </p>
907 <div class="variablelist"><table border="0">
908 <col align="left" valign="top">
909 <tbody>
910 <tr>
911 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
912 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
913 </td>
914 </tr>
915 <tr>
916 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
917 <td>the current repeat</td>
918 </tr>
919 </tbody>
920 </table></div>
921 <p class="since">Since 1.10</p>
922 </div>
923 <hr>
924 <div class="refsect2">
925 <a name="clutter-timeline-set-loop"></a><h3>clutter_timeline_set_loop ()</h3>
926 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_timeline_set_loop           (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
927                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> loop</code></em>);</pre>
928 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
929 <h3 class="title">Warning</h3>
930 <p><code class="literal">clutter_timeline_set_loop</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use <a class="link" href="ClutterTimeline.html#clutter-timeline-set-repeat-count" title="clutter_timeline_set_repeat_count ()"><code class="function">clutter_timeline_set_repeat_count()</code></a> instead.</p>
931 </div>
932 <p>
933 Sets whether <em class="parameter"><code>timeline</code></em> should loop.
934 </p>
935 <p>
936 This function is equivalent to calling <a class="link" href="ClutterTimeline.html#clutter-timeline-set-repeat-count" title="clutter_timeline_set_repeat_count ()"><code class="function">clutter_timeline_set_repeat_count()</code></a>
937 with -1 if <em class="parameter"><code>loop</code></em> is <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, and with 0 if <em class="parameter"><code>loop</code></em> is <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
938 </p>
939 <div class="variablelist"><table border="0">
940 <col align="left" valign="top">
941 <tbody>
942 <tr>
943 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
944 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
945 </td>
946 </tr>
947 <tr>
948 <td><p><span class="term"><em class="parameter"><code>loop</code></em> :</span></p></td>
949 <td>
950 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for enable looping</td>
951 </tr>
952 </tbody>
953 </table></div>
954 </div>
955 <hr>
956 <div class="refsect2">
957 <a name="clutter-timeline-get-loop"></a><h3>clutter_timeline_get_loop ()</h3>
958 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_timeline_get_loop           (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
959 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
960 <h3 class="title">Warning</h3>
961 <p><code class="literal">clutter_timeline_get_loop</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use <a class="link" href="ClutterTimeline.html#clutter-timeline-get-repeat-count" title="clutter_timeline_get_repeat_count ()"><code class="function">clutter_timeline_get_repeat_count()</code></a> instead.</p>
962 </div>
963 <p>
964 Gets whether <em class="parameter"><code>timeline</code></em> is looping
965 </p>
966 <div class="variablelist"><table border="0">
967 <col align="left" valign="top">
968 <tbody>
969 <tr>
970 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
971 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
972 </td>
973 </tr>
974 <tr>
975 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
976 <td>
977 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the timeline is looping</td>
978 </tr>
979 </tbody>
980 </table></div>
981 </div>
982 <hr>
983 <div class="refsect2">
984 <a name="clutter-timeline-start"></a><h3>clutter_timeline_start ()</h3>
985 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_timeline_start              (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
986 <p>
987 Starts the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> playing.
988 </p>
989 <div class="variablelist"><table border="0">
990 <col align="left" valign="top">
991 <tbody><tr>
992 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
993 <td>A <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
994 </td>
995 </tr></tbody>
996 </table></div>
997 </div>
998 <hr>
999 <div class="refsect2">
1000 <a name="clutter-timeline-pause"></a><h3>clutter_timeline_pause ()</h3>
1001 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_timeline_pause              (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
1002 <p>
1003 Pauses the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> on current frame
1004 </p>
1005 <div class="variablelist"><table border="0">
1006 <col align="left" valign="top">
1007 <tbody><tr>
1008 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1009 <td>A <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
1010 </td>
1011 </tr></tbody>
1012 </table></div>
1013 </div>
1014 <hr>
1015 <div class="refsect2">
1016 <a name="clutter-timeline-stop"></a><h3>clutter_timeline_stop ()</h3>
1017 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_timeline_stop               (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
1018 <p>
1019 Stops the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> and moves to frame 0
1020 </p>
1021 <div class="variablelist"><table border="0">
1022 <col align="left" valign="top">
1023 <tbody><tr>
1024 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1025 <td>A <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
1026 </td>
1027 </tr></tbody>
1028 </table></div>
1029 </div>
1030 <hr>
1031 <div class="refsect2">
1032 <a name="clutter-timeline-rewind"></a><h3>clutter_timeline_rewind ()</h3>
1033 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_timeline_rewind             (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
1034 <p>
1035 Rewinds <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> to the first frame if its direction is
1036 <a class="link" href="ClutterTimeline.html#CLUTTER-TIMELINE-FORWARD:CAPS"><code class="literal">CLUTTER_TIMELINE_FORWARD</code></a> and the last frame if it is
1037 <a class="link" href="ClutterTimeline.html#CLUTTER-TIMELINE-BACKWARD:CAPS"><code class="literal">CLUTTER_TIMELINE_BACKWARD</code></a>.
1038 </p>
1039 <div class="variablelist"><table border="0">
1040 <col align="left" valign="top">
1041 <tbody><tr>
1042 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1043 <td>A <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
1044 </td>
1045 </tr></tbody>
1046 </table></div>
1047 </div>
1048 <hr>
1049 <div class="refsect2">
1050 <a name="clutter-timeline-skip"></a><h3>clutter_timeline_skip ()</h3>
1051 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_timeline_skip               (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
1052                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> msecs</code></em>);</pre>
1053 <p>
1054 Advance timeline by the requested time in milliseconds
1055 </p>
1056 <div class="variablelist"><table border="0">
1057 <col align="left" valign="top">
1058 <tbody>
1059 <tr>
1060 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1061 <td>A <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
1062 </td>
1063 </tr>
1064 <tr>
1065 <td><p><span class="term"><em class="parameter"><code>msecs</code></em> :</span></p></td>
1066 <td>Amount of time to skip</td>
1067 </tr>
1068 </tbody>
1069 </table></div>
1070 </div>
1071 <hr>
1072 <div class="refsect2">
1073 <a name="clutter-timeline-advance"></a><h3>clutter_timeline_advance ()</h3>
1074 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_timeline_advance            (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
1075                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> msecs</code></em>);</pre>
1076 <p>
1077 Advance timeline to the requested point. The point is given as a
1078 time in milliseconds since the timeline started.
1079 </p>
1080 <p>
1081 </p>
1082 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1083 <h3 class="title">Note</h3>
1084 <p>The <em class="parameter"><code>timeline</code></em> will not emit the <a class="link" href="ClutterTimeline.html#ClutterTimeline-new-frame" title='The "new-frame" signal'><span class="type">"new-frame"</span></a>
1085 signal for the given time. The first ::new-frame signal after the call to
1086 <a class="link" href="ClutterTimeline.html#clutter-timeline-advance" title="clutter_timeline_advance ()"><code class="function">clutter_timeline_advance()</code></a> will be emit the skipped markers.
1087 </p>
1088 </div>
1089 <p>
1090 </p>
1091 <div class="variablelist"><table border="0">
1092 <col align="left" valign="top">
1093 <tbody>
1094 <tr>
1095 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1096 <td>A <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
1097 </td>
1098 </tr>
1099 <tr>
1100 <td><p><span class="term"><em class="parameter"><code>msecs</code></em> :</span></p></td>
1101 <td>Time to advance to</td>
1102 </tr>
1103 </tbody>
1104 </table></div>
1105 </div>
1106 <hr>
1107 <div class="refsect2">
1108 <a name="clutter-timeline-get-elapsed-time"></a><h3>clutter_timeline_get_elapsed_time ()</h3>
1109 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               clutter_timeline_get_elapsed_time   (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
1110 <p>
1111 Request the current time position of the timeline.
1112 </p>
1113 <div class="variablelist"><table border="0">
1114 <col align="left" valign="top">
1115 <tbody>
1116 <tr>
1117 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1118 <td>A <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
1119 </td>
1120 </tr>
1121 <tr>
1122 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1123 <td>current elapsed time in milliseconds.</td>
1124 </tr>
1125 </tbody>
1126 </table></div>
1127 </div>
1128 <hr>
1129 <div class="refsect2">
1130 <a name="clutter-timeline-get-delta"></a><h3>clutter_timeline_get_delta ()</h3>
1131 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               clutter_timeline_get_delta          (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
1132 <p>
1133 Retrieves the amount of time elapsed since the last
1134 ClutterTimeline::new-frame signal.
1135 </p>
1136 <p>
1137 This function is only useful inside handlers for the ::new-frame
1138 signal, and its behaviour is undefined if the timeline is not
1139 playing.
1140 </p>
1141 <div class="variablelist"><table border="0">
1142 <col align="left" valign="top">
1143 <tbody>
1144 <tr>
1145 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1146 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
1147 </td>
1148 </tr>
1149 <tr>
1150 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1151 <td>the amount of time in milliseconds elapsed since the
1152 last frame</td>
1153 </tr>
1154 </tbody>
1155 </table></div>
1156 <p class="since">Since 0.6</p>
1157 </div>
1158 <hr>
1159 <div class="refsect2">
1160 <a name="clutter-timeline-get-progress"></a><h3>clutter_timeline_get_progress ()</h3>
1161 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             clutter_timeline_get_progress       (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
1162 <p>
1163 The position of the timeline in a normalized [-1, 2] interval.
1164 </p>
1165 <p>
1166 The return value of this function is determined by the progress
1167 mode set using <a class="link" href="ClutterTimeline.html#clutter-timeline-set-progress-mode" title="clutter_timeline_set_progress_mode ()"><code class="function">clutter_timeline_set_progress_mode()</code></a>, or by the
1168 progress function set using <a class="link" href="ClutterTimeline.html#clutter-timeline-set-progress-func" title="clutter_timeline_set_progress_func ()"><code class="function">clutter_timeline_set_progress_func()</code></a>.
1169 </p>
1170 <div class="variablelist"><table border="0">
1171 <col align="left" valign="top">
1172 <tbody>
1173 <tr>
1174 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1175 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
1176 </td>
1177 </tr>
1178 <tr>
1179 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1180 <td>the normalized current position in the timeline.</td>
1181 </tr>
1182 </tbody>
1183 </table></div>
1184 <p class="since">Since 0.6</p>
1185 </div>
1186 <hr>
1187 <div class="refsect2">
1188 <a name="clutter-timeline-is-playing"></a><h3>clutter_timeline_is_playing ()</h3>
1189 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_timeline_is_playing         (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
1190 <p>
1191 Queries state of a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>.
1192 </p>
1193 <div class="variablelist"><table border="0">
1194 <col align="left" valign="top">
1195 <tbody>
1196 <tr>
1197 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1198 <td>A <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
1199 </td>
1200 </tr>
1201 <tr>
1202 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1203 <td>
1204 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if timeline is currently playing</td>
1205 </tr>
1206 </tbody>
1207 </table></div>
1208 </div>
1209 <hr>
1210 <div class="refsect2">
1211 <a name="clutter-timeline-add-marker-at-time"></a><h3>clutter_timeline_add_marker_at_time ()</h3>
1212 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_timeline_add_marker_at_time (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
1213                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *marker_name</code></em>,
1214                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> msecs</code></em>);</pre>
1215 <p>
1216 Adds a named marker that will be hit when the timeline has been
1217 running for <em class="parameter"><code>msecs</code></em> milliseconds. Markers are unique string
1218 identifiers for a given time. Once <em class="parameter"><code>timeline</code></em> reaches
1219 <em class="parameter"><code>msecs</code></em>, it will emit a ::marker-reached signal for each marker
1220 attached to that time.
1221 </p>
1222 <p>
1223 A marker can be removed with <a class="link" href="ClutterTimeline.html#clutter-timeline-remove-marker" title="clutter_timeline_remove_marker ()"><code class="function">clutter_timeline_remove_marker()</code></a>. The
1224 timeline can be advanced to a marker using
1225 <a class="link" href="ClutterTimeline.html#clutter-timeline-advance-to-marker" title="clutter_timeline_advance_to_marker ()"><code class="function">clutter_timeline_advance_to_marker()</code></a>.
1226 </p>
1227 <div class="variablelist"><table border="0">
1228 <col align="left" valign="top">
1229 <tbody>
1230 <tr>
1231 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1232 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
1233 </td>
1234 </tr>
1235 <tr>
1236 <td><p><span class="term"><em class="parameter"><code>marker_name</code></em> :</span></p></td>
1237 <td>the unique name for this marker</td>
1238 </tr>
1239 <tr>
1240 <td><p><span class="term"><em class="parameter"><code>msecs</code></em> :</span></p></td>
1241 <td>position of the marker in milliseconds</td>
1242 </tr>
1243 </tbody>
1244 </table></div>
1245 <p class="since">Since 0.8</p>
1246 </div>
1247 <hr>
1248 <div class="refsect2">
1249 <a name="clutter-timeline-has-marker"></a><h3>clutter_timeline_has_marker ()</h3>
1250 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_timeline_has_marker         (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
1251                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *marker_name</code></em>);</pre>
1252 <p>
1253 Checks whether <em class="parameter"><code>timeline</code></em> has a marker set with the given name.
1254 </p>
1255 <div class="variablelist"><table border="0">
1256 <col align="left" valign="top">
1257 <tbody>
1258 <tr>
1259 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1260 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
1261 </td>
1262 </tr>
1263 <tr>
1264 <td><p><span class="term"><em class="parameter"><code>marker_name</code></em> :</span></p></td>
1265 <td>the name of the marker</td>
1266 </tr>
1267 <tr>
1268 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1269 <td>
1270 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the marker was found</td>
1271 </tr>
1272 </tbody>
1273 </table></div>
1274 <p class="since">Since 0.8</p>
1275 </div>
1276 <hr>
1277 <div class="refsect2">
1278 <a name="clutter-timeline-list-markers"></a><h3>clutter_timeline_list_markers ()</h3>
1279 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **            clutter_timeline_list_markers       (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
1280                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> msecs</code></em>,
1281                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> *n_markers</code></em>);</pre>
1282 <p>
1283 Retrieves the list of markers at time <em class="parameter"><code>msecs</code></em>. If <em class="parameter"><code>msecs</code></em> is a
1284 negative integer, all the markers attached to <em class="parameter"><code>timeline</code></em> will be
1285 returned.
1286 </p>
1287 <div class="variablelist"><table border="0">
1288 <col align="left" valign="top">
1289 <tbody>
1290 <tr>
1291 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1292 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
1293 </td>
1294 </tr>
1295 <tr>
1296 <td><p><span class="term"><em class="parameter"><code>msecs</code></em> :</span></p></td>
1297 <td>the time to check, or -1</td>
1298 </tr>
1299 <tr>
1300 <td><p><span class="term"><em class="parameter"><code>n_markers</code></em> :</span></p></td>
1301 <td>the number of markers returned</td>
1302 </tr>
1303 <tr>
1304 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1305 <td>a newly allocated, <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated string array containing the names
1306 of the markers. Use <a href="../glib/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a> when done. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1 length=n_markers]</span>
1307 </td>
1308 </tr>
1309 </tbody>
1310 </table></div>
1311 <p class="since">Since 0.8</p>
1312 </div>
1313 <hr>
1314 <div class="refsect2">
1315 <a name="clutter-timeline-remove-marker"></a><h3>clutter_timeline_remove_marker ()</h3>
1316 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_timeline_remove_marker      (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
1317                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *marker_name</code></em>);</pre>
1318 <p>
1319 Removes <em class="parameter"><code>marker_name</code></em>, if found, from <em class="parameter"><code>timeline</code></em>.
1320 </p>
1321 <div class="variablelist"><table border="0">
1322 <col align="left" valign="top">
1323 <tbody>
1324 <tr>
1325 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1326 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
1327 </td>
1328 </tr>
1329 <tr>
1330 <td><p><span class="term"><em class="parameter"><code>marker_name</code></em> :</span></p></td>
1331 <td>the name of the marker to remove</td>
1332 </tr>
1333 </tbody>
1334 </table></div>
1335 <p class="since">Since 0.8</p>
1336 </div>
1337 <hr>
1338 <div class="refsect2">
1339 <a name="clutter-timeline-advance-to-marker"></a><h3>clutter_timeline_advance_to_marker ()</h3>
1340 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_timeline_advance_to_marker  (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
1341                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *marker_name</code></em>);</pre>
1342 <p>
1343 Advances <em class="parameter"><code>timeline</code></em> to the time of the given <em class="parameter"><code>marker_name</code></em>.
1344 </p>
1345 <p>
1346 </p>
1347 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1348 <h3 class="title">Note</h3>
1349 <p>Like <a class="link" href="ClutterTimeline.html#clutter-timeline-advance" title="clutter_timeline_advance ()"><code class="function">clutter_timeline_advance()</code></a>, this function will not
1350 emit the <a class="link" href="ClutterTimeline.html#ClutterTimeline-new-frame" title='The "new-frame" signal'><span class="type">"new-frame"</span></a> for the time where <em class="parameter"><code>marker_name</code></em>
1351 is set, nor it will emit <a class="link" href="ClutterTimeline.html#ClutterTimeline-marker-reached" title='The "marker-reached" signal'><span class="type">"marker-reached"</span></a> for
1352 <em class="parameter"><code>marker_name</code></em>.</p>
1353 </div>
1354 <p>
1355 </p>
1356 <div class="variablelist"><table border="0">
1357 <col align="left" valign="top">
1358 <tbody>
1359 <tr>
1360 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1361 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
1362 </td>
1363 </tr>
1364 <tr>
1365 <td><p><span class="term"><em class="parameter"><code>marker_name</code></em> :</span></p></td>
1366 <td>the name of the marker</td>
1367 </tr>
1368 </tbody>
1369 </table></div>
1370 <p class="since">Since 0.8</p>
1371 </div>
1372 </div>
1373 <div class="refsect1">
1374 <a name="ClutterTimeline.property-details"></a><h2>Property Details</h2>
1375 <div class="refsect2">
1376 <a name="ClutterTimeline--auto-reverse"></a><h3>The <code class="literal">"auto-reverse"</code> property</h3>
1377 <pre class="programlisting">  "auto-reverse"             <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
1378 <p>
1379 If the direction of the timeline should be automatically reversed
1380 when reaching the end.
1381 </p>
1382 <p>Default value: FALSE</p>
1383 <p class="since">Since 1.6</p>
1384 </div>
1385 <hr>
1386 <div class="refsect2">
1387 <a name="ClutterTimeline--delay"></a><h3>The <code class="literal">"delay"</code> property</h3>
1388 <pre class="programlisting">  "delay"                    <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
1389 <p>
1390 A delay, in milliseconds, that should be observed by the
1391 timeline before actually starting.
1392 </p>
1393 <p>Default value: 0</p>
1394 <p class="since">Since 0.4</p>
1395 </div>
1396 <hr>
1397 <div class="refsect2">
1398 <a name="ClutterTimeline--direction"></a><h3>The <code class="literal">"direction"</code> property</h3>
1399 <pre class="programlisting">  "direction"                <a class="link" href="ClutterTimeline.html#ClutterTimelineDirection" title="enum ClutterTimelineDirection"><span class="type">ClutterTimelineDirection</span></a>  : Read / Write</pre>
1400 <p>
1401 The direction of the timeline, either <a class="link" href="ClutterTimeline.html#CLUTTER-TIMELINE-FORWARD:CAPS"><code class="literal">CLUTTER_TIMELINE_FORWARD</code></a> or
1402 <a class="link" href="ClutterTimeline.html#CLUTTER-TIMELINE-BACKWARD:CAPS"><code class="literal">CLUTTER_TIMELINE_BACKWARD</code></a>.
1403 </p>
1404 <p>Default value: CLUTTER_TIMELINE_FORWARD</p>
1405 <p class="since">Since 0.6</p>
1406 </div>
1407 <hr>
1408 <div class="refsect2">
1409 <a name="ClutterTimeline--duration"></a><h3>The <code class="literal">"duration"</code> property</h3>
1410 <pre class="programlisting">  "duration"                 <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
1411 <p>
1412 Duration of the timeline in milliseconds, depending on the
1413 ClutterTimeline:fps value.
1414 </p>
1415 <p>Default value: 1000</p>
1416 <p class="since">Since 0.6</p>
1417 </div>
1418 <hr>
1419 <div class="refsect2">
1420 <a name="ClutterTimeline--loop"></a><h3>The <code class="literal">"loop"</code> property</h3>
1421 <pre class="programlisting">  "loop"                     <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
1422 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1423 <h3 class="title">Warning</h3>
1424 <p><code class="literal">ClutterTimeline:loop</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use the <a class="link" href="ClutterTimeline.html#ClutterTimeline--repeat-count" title='The "repeat-count" property'><span class="type">"repeat-count"</span></a> property instead.</p>
1425 </div>
1426 <p>
1427 Whether the timeline should automatically rewind and restart.
1428 </p>
1429 <p>
1430 As a side effect, setting this property to <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> will set the
1431 <a class="link" href="ClutterTimeline.html#ClutterTimeline--repeat-count" title='The "repeat-count" property'><span class="type">"repeat-count"</span></a> property to -1, while setting this
1432 property to <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> will set the <a class="link" href="ClutterTimeline.html#ClutterTimeline--repeat-count" title='The "repeat-count" property'><span class="type">"repeat-count"</span></a>
1433 property to 0.
1434 </p>
1435 <p>Default value: FALSE</p>
1436 </div>
1437 <hr>
1438 <div class="refsect2">
1439 <a name="ClutterTimeline--progress-mode"></a><h3>The <code class="literal">"progress-mode"</code> property</h3>
1440 <pre class="programlisting">  "progress-mode"            <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a>  : Read / Write</pre>
1441 <p>
1442 Controls the way a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> computes the normalized progress.
1443 </p>
1444 <p>Default value: CLUTTER_LINEAR</p>
1445 <p class="since">Since 1.10</p>
1446 </div>
1447 <hr>
1448 <div class="refsect2">
1449 <a name="ClutterTimeline--repeat-count"></a><h3>The <code class="literal">"repeat-count"</code> property</h3>
1450 <pre class="programlisting">  "repeat-count"             <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
1451 <p>
1452 Defines how many times the timeline should repeat.
1453 </p>
1454 <p>
1455 If the repeat count is 0, the timeline does not repeat.
1456 </p>
1457 <p>
1458 If the repeat count is set to -1, the timeline will repeat until it is
1459 stopped.
1460 </p>
1461 <p>Allowed values: &gt;= G_MAXULONG</p>
1462 <p>Default value: 0</p>
1463 <p class="since">Since 1.10</p>
1464 </div>
1465 </div>
1466 <div class="refsect1">
1467 <a name="ClutterTimeline.signal-details"></a><h2>Signal Details</h2>
1468 <div class="refsect2">
1469 <a name="ClutterTimeline-completed"></a><h3>The <code class="literal">"completed"</code> signal</h3>
1470 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline,
1471                                                         <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)      : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1472 <p>
1473 The <a class="link" href="ClutterTimeline.html#ClutterTimeline-completed" title='The "completed" signal'><span class="type">"completed"</span></a> signal is emitted when the timeline's
1474 elapsed time reaches the value of the <a class="link" href="ClutterTimeline.html#ClutterTimeline--duration" title='The "duration" property'><span class="type">"duration"</span></a>
1475 property.
1476 </p>
1477 <p>
1478 This signal will be emitted even if the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> is set to be
1479 repeating.
1480 </p>
1481 <div class="variablelist"><table border="0">
1482 <col align="left" valign="top">
1483 <tbody>
1484 <tr>
1485 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1486 <td>the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> which received the signal</td>
1487 </tr>
1488 <tr>
1489 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1490 <td>user data set when the signal handler was connected.</td>
1491 </tr>
1492 </tbody>
1493 </table></div>
1494 </div>
1495 <hr>
1496 <div class="refsect2">
1497 <a name="ClutterTimeline-marker-reached"></a><h3>The <code class="literal">"marker-reached"</code> signal</h3>
1498 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline,
1499                                                         <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>           *marker_name,
1500                                                         <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>             msecs,
1501                                                         <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)        : <a href="../gobject/gobject-Signals.html#G-SIGNAL-NO-HOOKS:CAPS"><code class="literal">No Hooks</code></a></pre>
1502 <p>
1503 The ::marker-reached signal is emitted each time a timeline
1504 reaches a marker set with
1505 <a class="link" href="ClutterTimeline.html#clutter-timeline-add-marker-at-time" title="clutter_timeline_add_marker_at_time ()"><code class="function">clutter_timeline_add_marker_at_time()</code></a>. This signal is detailed
1506 with the name of the marker as well, so it is possible to connect
1507 a callback to the ::marker-reached signal for a specific marker
1508 with:
1509 </p>
1510 <p>
1511 </p>
1512 <div class="informalexample">
1513   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
1514     <tbody>
1515       <tr>
1516         <td class="listing_lines" align="right"><pre>1
1517 2
1518 3
1519 4
1520 5
1521 6
1522 7
1523 8</pre></td>
1524         <td class="listing_code"><pre class="programlisting"><span class="function"><a href="ClutterTimeline.html#clutter-timeline-add-marker-at-time">clutter_timeline_add_marker_at_time</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">timeline</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"foo"</span><span class="symbol">,</span><span class="normal"> </span><span class="number">500</span><span class="symbol">);</span>
1525 <span class="function"><a href="ClutterTimeline.html#clutter-timeline-add-marker-at-time">clutter_timeline_add_marker_at_time</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">timeline</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"bar"</span><span class="symbol">,</span><span class="normal"> </span><span class="number">750</span><span class="symbol">);</span>
1526 <span class="function"><a href="../gobject/gobject-Signals.html#g-signal-connect">g_signal_connect</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">timeline</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"marker-reached"</span><span class="symbol">,</span>
1527 <span class="normal">                  </span><span class="function"><a href="../gobject/gobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">each_marker_reached</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>
1528 <span class="function"><a href="../gobject/gobject-Signals.html#g-signal-connect">g_signal_connect</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">timeline</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"marker-reached::foo"</span><span class="symbol">,</span>
1529 <span class="normal">                  </span><span class="function"><a href="../gobject/gobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">foo_marker_reached</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>
1530 <span class="function"><a href="../gobject/gobject-Signals.html#g-signal-connect">g_signal_connect</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">timeline</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"marker-reached::bar"</span><span class="symbol">,</span>
1531 <span class="normal">                  </span><span class="function"><a href="../gobject/gobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">bar_marker_reached</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></pre></td>
1532       </tr>
1533     </tbody>
1534   </table>
1535 </div>
1536
1537 <p>
1538 </p>
1539 <p>
1540 In the example, the first callback will be invoked for both
1541 the "foo" and "bar" marker, while the second and third callbacks
1542 will be invoked for the "foo" or "bar" markers, respectively.
1543 </p>
1544 <div class="variablelist"><table border="0">
1545 <col align="left" valign="top">
1546 <tbody>
1547 <tr>
1548 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1549 <td>the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> which received the signal</td>
1550 </tr>
1551 <tr>
1552 <td><p><span class="term"><em class="parameter"><code>marker_name</code></em> :</span></p></td>
1553 <td>the name of the marker reached</td>
1554 </tr>
1555 <tr>
1556 <td><p><span class="term"><em class="parameter"><code>msecs</code></em> :</span></p></td>
1557 <td>the elapsed time</td>
1558 </tr>
1559 <tr>
1560 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1561 <td>user data set when the signal handler was connected.</td>
1562 </tr>
1563 </tbody>
1564 </table></div>
1565 <p class="since">Since 0.8</p>
1566 </div>
1567 <hr>
1568 <div class="refsect2">
1569 <a name="ClutterTimeline-new-frame"></a><h3>The <code class="literal">"new-frame"</code> signal</h3>
1570 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline,
1571                                                         <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>             msecs,
1572                                                         <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)      : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1573 <p>
1574 The ::new-frame signal is emitted for each timeline running
1575 timeline before a new frame is drawn to give animations a chance
1576 to update the scene.
1577 </p>
1578 <div class="variablelist"><table border="0">
1579 <col align="left" valign="top">
1580 <tbody>
1581 <tr>
1582 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1583 <td>the timeline which received the signal</td>
1584 </tr>
1585 <tr>
1586 <td><p><span class="term"><em class="parameter"><code>msecs</code></em> :</span></p></td>
1587 <td>the elapsed time between 0 and duration</td>
1588 </tr>
1589 <tr>
1590 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1591 <td>user data set when the signal handler was connected.</td>
1592 </tr>
1593 </tbody>
1594 </table></div>
1595 </div>
1596 <hr>
1597 <div class="refsect2">
1598 <a name="ClutterTimeline-paused"></a><h3>The <code class="literal">"paused"</code> signal</h3>
1599 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline,
1600                                                         <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)      : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1601 <p>
1602 The ::paused signal is emitted when <a class="link" href="ClutterTimeline.html#clutter-timeline-pause" title="clutter_timeline_pause ()"><code class="function">clutter_timeline_pause()</code></a> is invoked.
1603 </p>
1604 <div class="variablelist"><table border="0">
1605 <col align="left" valign="top">
1606 <tbody>
1607 <tr>
1608 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1609 <td>the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> which received the signal</td>
1610 </tr>
1611 <tr>
1612 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1613 <td>user data set when the signal handler was connected.</td>
1614 </tr>
1615 </tbody>
1616 </table></div>
1617 </div>
1618 <hr>
1619 <div class="refsect2">
1620 <a name="ClutterTimeline-started"></a><h3>The <code class="literal">"started"</code> signal</h3>
1621 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline,
1622                                                         <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)      : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1623 <p>
1624 The ::started signal is emitted when the timeline starts its run.
1625 This might be as soon as <a class="link" href="ClutterTimeline.html#clutter-timeline-start" title="clutter_timeline_start ()"><code class="function">clutter_timeline_start()</code></a> is invoked or
1626 after the delay set in the ClutterTimeline:delay property has
1627 expired.
1628 </p>
1629 <div class="variablelist"><table border="0">
1630 <col align="left" valign="top">
1631 <tbody>
1632 <tr>
1633 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
1634 <td>the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> which received the signal</td>
1635 </tr>
1636 <tr>
1637 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1638 <td>user data set when the signal handler was connected.</td>
1639 </tr>
1640 </tbody>
1641 </table></div>
1642 </div>
1643 </div>
1644 <div class="refsect1">
1645 <a name="ClutterTimeline.see-also"></a><h2>See Also</h2>
1646 <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a>, <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>, <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
1647 </div>
1648 </div>
1649 <div class="footer">
1650 <hr>
1651           Generated by GTK-Doc V1.18.1</div>
1652 </body>
1653 </html>