41
33
<h2><span class="refentrytitle"><a name="ClutterState.top_of_page"></a>ClutterState</span></h2>
42
34
<p>ClutterState — State machine with animated transitions</p>
44
<td valign="top" align="right"></td>
36
<td class="gallery_image" valign="top" align="right"></td>
45
37
</tr></table></div>
46
<div class="refsynopsisdiv">
47
<a name="ClutterState.synopsis"></a><h2>Synopsis</h2>
48
<pre class="synopsis"> <a class="link" href="ClutterState.html#ClutterState-struct" title="ClutterState">ClutterState</a>;
49
struct <a class="link" href="ClutterState.html#ClutterStateClass" title="struct ClutterStateClass">ClutterStateClass</a>;
50
<a class="link" href="ClutterState.html" title="ClutterState"><span class="returnvalue">ClutterState</span></a> * <a class="link" href="ClutterState.html#clutter-state-new" title="clutter_state_new ()">clutter_state_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
51
<a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> * <a class="link" href="ClutterState.html#clutter-state-set-state" title="clutter_state_set_state ()">clutter_state_set_state</a> (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
52
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>);
53
const <span class="returnvalue">gchar</span> * <a class="link" href="ClutterState.html#clutter-state-get-state" title="clutter_state_get_state ()">clutter_state_get_state</a> (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>);
54
<a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> * <a class="link" href="ClutterState.html#clutter-state-warp-to-state" title="clutter_state_warp_to_state ()">clutter_state_warp_to_state</a> (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
55
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>);
56
<span class="returnvalue">void</span> <a class="link" href="ClutterState.html#clutter-state-set" title="clutter_state_set ()">clutter_state_set</a> (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
57
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
58
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
59
<em class="parameter"><code><span class="type">gpointer</span> first_object</code></em>,
60
<em class="parameter"><code>const <span class="type">gchar</span> *first_property_name</code></em>,
61
<em class="parameter"><code><span class="type">gulong</span> first_mode</code></em>,
62
<em class="parameter"><code>...</code></em>);
63
<a class="link" href="ClutterState.html" title="ClutterState"><span class="returnvalue">ClutterState</span></a> * <a class="link" href="ClutterState.html#clutter-state-set-key" title="clutter_state_set_key ()">clutter_state_set_key</a> (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
64
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
65
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
66
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
67
<em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>,
68
<em class="parameter"><code><span class="type">guint</span> mode</code></em>,
69
<em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>,
70
<em class="parameter"><code><span class="type">gdouble</span> pre_delay</code></em>,
71
<em class="parameter"><code><span class="type">gdouble</span> post_delay</code></em>);
72
<span class="returnvalue">void</span> <a class="link" href="ClutterState.html#clutter-state-set-duration" title="clutter_state_set_duration ()">clutter_state_set_duration</a> (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
73
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
74
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
75
<em class="parameter"><code><span class="type">guint</span> duration</code></em>);
76
<span class="returnvalue">guint</span> <a class="link" href="ClutterState.html#clutter-state-get-duration" title="clutter_state_get_duration ()">clutter_state_get_duration</a> (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
77
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
78
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>);
79
<span class="returnvalue">GList</span> * <a class="link" href="ClutterState.html#clutter-state-get-states" title="clutter_state_get_states ()">clutter_state_get_states</a> (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>);
80
<span class="returnvalue">GList</span> * <a class="link" href="ClutterState.html#clutter-state-get-keys" title="clutter_state_get_keys ()">clutter_state_get_keys</a> (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
81
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
82
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
83
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
84
<em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);
85
<span class="returnvalue">void</span> <a class="link" href="ClutterState.html#clutter-state-remove-key" title="clutter_state_remove_key ()">clutter_state_remove_key</a> (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
86
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
87
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
88
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
89
<em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);
90
<a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> * <a class="link" href="ClutterState.html#clutter-state-get-timeline" title="clutter_state_get_timeline ()">clutter_state_get_timeline</a> (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>);
91
<span class="returnvalue">void</span> <a class="link" href="ClutterState.html#clutter-state-set-animator" title="clutter_state_set_animator ()">clutter_state_set_animator</a> (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
92
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
93
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
94
<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>);
95
<a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="returnvalue">ClutterAnimator</span></a> * <a class="link" href="ClutterState.html#clutter-state-get-animator" title="clutter_state_get_animator ()">clutter_state_get_animator</a> (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
96
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
97
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>);
99
<a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey">ClutterStateKey</a>;
100
const <span class="returnvalue">gchar</span> * <a class="link" href="ClutterState.html#clutter-state-key-get-source-state-name" title="clutter_state_key_get_source_state_name ()">clutter_state_key_get_source_state_name</a>
101
(<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);
102
const <span class="returnvalue">gchar</span> * <a class="link" href="ClutterState.html#clutter-state-key-get-target-state-name" title="clutter_state_key_get_target_state_name ()">clutter_state_key_get_target_state_name</a>
103
(<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);
104
<span class="returnvalue">GObject</span> * <a class="link" href="ClutterState.html#clutter-state-key-get-object" title="clutter_state_key_get_object ()">clutter_state_key_get_object</a> (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);
105
const <span class="returnvalue">gchar</span> * <a class="link" href="ClutterState.html#clutter-state-key-get-property-name" title="clutter_state_key_get_property_name ()">clutter_state_key_get_property_name</a> (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);
106
<span class="returnvalue">gulong</span> <a class="link" href="ClutterState.html#clutter-state-key-get-mode" title="clutter_state_key_get_mode ()">clutter_state_key_get_mode</a> (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);
107
<span class="returnvalue">gboolean</span> <a class="link" href="ClutterState.html#clutter-state-key-get-value" title="clutter_state_key_get_value ()">clutter_state_key_get_value</a> (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>,
108
<em class="parameter"><code><span class="type">GValue</span> *value</code></em>);
109
<span class="returnvalue">GType</span> <a class="link" href="ClutterState.html#clutter-state-key-get-property-type" title="clutter_state_key_get_property_type ()">clutter_state_key_get_property_type</a> (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *key</code></em>);
110
<span class="returnvalue">gdouble</span> <a class="link" href="ClutterState.html#clutter-state-key-get-pre-delay" title="clutter_state_key_get_pre_delay ()">clutter_state_key_get_pre_delay</a> (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);
111
<span class="returnvalue">gdouble</span> <a class="link" href="ClutterState.html#clutter-state-key-get-post-delay" title="clutter_state_key_get_post_delay ()">clutter_state_key_get_post_delay</a> (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);
38
<div class="refsect1">
39
<a name="ClutterState.functions"></a><h2>Functions</h2>
40
<div class="informaltable"><table width="100%" border="0">
42
<col width="150px" class="functions_return">
43
<col class="functions_name">
47
<td class="function_type">
48
<a class="link" href="ClutterState.html" title="ClutterState"><span class="returnvalue">ClutterState</span></a> *
50
<td class="function_name">
51
<a class="link" href="ClutterState.html#clutter-state-new" title="clutter_state_new ()">clutter_state_new</a> <span class="c_punctuation">()</span>
55
<td class="function_type">
56
<a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *
58
<td class="function_name">
59
<a class="link" href="ClutterState.html#clutter-state-set-state" title="clutter_state_set_state ()">clutter_state_set_state</a> <span class="c_punctuation">()</span>
63
<td class="function_type">const <span class="returnvalue">gchar</span> *
65
<td class="function_name">
66
<a class="link" href="ClutterState.html#clutter-state-get-state" title="clutter_state_get_state ()">clutter_state_get_state</a> <span class="c_punctuation">()</span>
70
<td class="function_type">
71
<a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *
73
<td class="function_name">
74
<a class="link" href="ClutterState.html#clutter-state-warp-to-state" title="clutter_state_warp_to_state ()">clutter_state_warp_to_state</a> <span class="c_punctuation">()</span>
78
<td class="function_type">
79
<span class="returnvalue">void</span>
81
<td class="function_name">
82
<a class="link" href="ClutterState.html#clutter-state-set" title="clutter_state_set ()">clutter_state_set</a> <span class="c_punctuation">()</span>
86
<td class="function_type">
87
<a class="link" href="ClutterState.html" title="ClutterState"><span class="returnvalue">ClutterState</span></a> *
89
<td class="function_name">
90
<a class="link" href="ClutterState.html#clutter-state-set-key" title="clutter_state_set_key ()">clutter_state_set_key</a> <span class="c_punctuation">()</span>
94
<td class="function_type">
95
<span class="returnvalue">void</span>
97
<td class="function_name">
98
<a class="link" href="ClutterState.html#clutter-state-set-duration" title="clutter_state_set_duration ()">clutter_state_set_duration</a> <span class="c_punctuation">()</span>
102
<td class="function_type">
103
<span class="returnvalue">guint</span>
105
<td class="function_name">
106
<a class="link" href="ClutterState.html#clutter-state-get-duration" title="clutter_state_get_duration ()">clutter_state_get_duration</a> <span class="c_punctuation">()</span>
110
<td class="function_type">
111
<span class="returnvalue">GList</span> *
113
<td class="function_name">
114
<a class="link" href="ClutterState.html#clutter-state-get-states" title="clutter_state_get_states ()">clutter_state_get_states</a> <span class="c_punctuation">()</span>
118
<td class="function_type">
119
<span class="returnvalue">GList</span> *
121
<td class="function_name">
122
<a class="link" href="ClutterState.html#clutter-state-get-keys" title="clutter_state_get_keys ()">clutter_state_get_keys</a> <span class="c_punctuation">()</span>
126
<td class="function_type">
127
<span class="returnvalue">void</span>
129
<td class="function_name">
130
<a class="link" href="ClutterState.html#clutter-state-remove-key" title="clutter_state_remove_key ()">clutter_state_remove_key</a> <span class="c_punctuation">()</span>
134
<td class="function_type">
135
<a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *
137
<td class="function_name">
138
<a class="link" href="ClutterState.html#clutter-state-get-timeline" title="clutter_state_get_timeline ()">clutter_state_get_timeline</a> <span class="c_punctuation">()</span>
142
<td class="function_type">
143
<span class="returnvalue">void</span>
145
<td class="function_name">
146
<a class="link" href="ClutterState.html#clutter-state-set-animator" title="clutter_state_set_animator ()">clutter_state_set_animator</a> <span class="c_punctuation">()</span>
150
<td class="function_type">
151
<a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="returnvalue">ClutterAnimator</span></a> *
153
<td class="function_name">
154
<a class="link" href="ClutterState.html#clutter-state-get-animator" title="clutter_state_get_animator ()">clutter_state_get_animator</a> <span class="c_punctuation">()</span>
158
<td class="function_type">const <span class="returnvalue">gchar</span> *
160
<td class="function_name">
161
<a class="link" href="ClutterState.html#clutter-state-key-get-source-state-name" title="clutter_state_key_get_source_state_name ()">clutter_state_key_get_source_state_name</a> <span class="c_punctuation">()</span>
165
<td class="function_type">const <span class="returnvalue">gchar</span> *
167
<td class="function_name">
168
<a class="link" href="ClutterState.html#clutter-state-key-get-target-state-name" title="clutter_state_key_get_target_state_name ()">clutter_state_key_get_target_state_name</a> <span class="c_punctuation">()</span>
172
<td class="function_type">
173
<span class="returnvalue">GObject</span> *
175
<td class="function_name">
176
<a class="link" href="ClutterState.html#clutter-state-key-get-object" title="clutter_state_key_get_object ()">clutter_state_key_get_object</a> <span class="c_punctuation">()</span>
180
<td class="function_type">const <span class="returnvalue">gchar</span> *
182
<td class="function_name">
183
<a class="link" href="ClutterState.html#clutter-state-key-get-property-name" title="clutter_state_key_get_property_name ()">clutter_state_key_get_property_name</a> <span class="c_punctuation">()</span>
187
<td class="function_type">
188
<span class="returnvalue">gulong</span>
190
<td class="function_name">
191
<a class="link" href="ClutterState.html#clutter-state-key-get-mode" title="clutter_state_key_get_mode ()">clutter_state_key_get_mode</a> <span class="c_punctuation">()</span>
195
<td class="function_type">
196
<span class="returnvalue">gboolean</span>
198
<td class="function_name">
199
<a class="link" href="ClutterState.html#clutter-state-key-get-value" title="clutter_state_key_get_value ()">clutter_state_key_get_value</a> <span class="c_punctuation">()</span>
203
<td class="function_type">
204
<span class="returnvalue">GType</span>
206
<td class="function_name">
207
<a class="link" href="ClutterState.html#clutter-state-key-get-property-type" title="clutter_state_key_get_property_type ()">clutter_state_key_get_property_type</a> <span class="c_punctuation">()</span>
211
<td class="function_type">
212
<span class="returnvalue">gdouble</span>
214
<td class="function_name">
215
<a class="link" href="ClutterState.html#clutter-state-key-get-pre-delay" title="clutter_state_key_get_pre_delay ()">clutter_state_key_get_pre_delay</a> <span class="c_punctuation">()</span>
219
<td class="function_type">
220
<span class="returnvalue">gdouble</span>
222
<td class="function_name">
223
<a class="link" href="ClutterState.html#clutter-state-key-get-post-delay" title="clutter_state_key_get_post_delay ()">clutter_state_key_get_post_delay</a> <span class="c_punctuation">()</span>
229
<div class="refsect1">
230
<a name="ClutterState.properties"></a><h2>Properties</h2>
231
<div class="informaltable"><table border="0">
233
<col width="150px" class="properties_type">
234
<col width="300px" class="properties_name">
235
<col width="200px" class="properties_flags">
239
<td class="property_type"><span class="type">guint</span></td>
240
<td class="property_name"><a class="link" href="ClutterState.html#ClutterState--duration" title="The “duration” property">duration</a></td>
241
<td class="property_flags">Read / Write</td>
244
<td class="property_type">
245
<span class="type">gchar</span> *</td>
246
<td class="property_name"><a class="link" href="ClutterState.html#ClutterState--state" title="The “state” property">state</a></td>
247
<td class="property_flags">Read / Write</td>
252
<div class="refsect1">
253
<a name="ClutterState.signals"></a><h2>Signals</h2>
254
<div class="informaltable"><table border="0">
256
<col width="150px" class="signals_return">
257
<col width="300px" class="signals_name">
258
<col width="200px" class="signals_flags">
261
<td class="signal_type"><span class="returnvalue">void</span></td>
262
<td class="signal_name"><a class="link" href="ClutterState.html#ClutterState-completed" title="The “completed” signal">completed</a></td>
263
<td class="signal_flags">Run Last</td>
267
<div class="refsect1">
268
<a name="ClutterState.other"></a><h2>Types and Values</h2>
269
<div class="informaltable"><table width="100%" border="0">
271
<col width="150px" class="name">
272
<col class="description">
276
<td class="datatype_keyword"> </td>
277
<td class="function_name"><a class="link" href="ClutterState.html#ClutterState-struct" title="ClutterState">ClutterState</a></td>
280
<td class="datatype_keyword">struct</td>
281
<td class="function_name"><a class="link" href="ClutterState.html#ClutterStateClass" title="struct ClutterStateClass">ClutterStateClass</a></td>
284
<td class="datatype_keyword"> </td>
285
<td class="function_name"><a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey">ClutterStateKey</a></td>
114
290
<div class="refsect1">
115
291
<a name="ClutterState.object-hierarchy"></a><h2>Object Hierarchy</h2>
116
<pre class="synopsis">
292
<pre class="screen"> GObject
293
<span class="lineart">╰──</span> ClutterState
121
296
<div class="refsect1">
294
<p>Each element of the <span class="emphasis"><em>transitions</em></span> array follows
295
the same rules as <a class="link" href="ClutterState.html#clutter-state-set-key" title="clutter_state_set_key ()"><code class="function">clutter_state_set_key()</code></a>.</p>
296
<p>The <span class="emphasis"><em>source</em></span> and <span class="emphasis"><em>target</em></span>
297
values control the source and target state of the transition. The
298
<span class="emphasis"><em>key</em></span> and <span class="emphasis"><em>animator</em></span> are mutually
299
exclusive. The <span class="emphasis"><em>pre-delay</em></span> and
300
<span class="emphasis"><em>post-delay</em></span> values are optional.</p>
301
<div class="example">
302
<a name="ClutterState-script-example"></a><p class="title"><b>Example 26. ClutterState definition</b></p>
303
<div class="example-contents">
304
<p>The example below is a translation into a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
305
definition of the code in the <a class="ulink" href="" target="_top">example
307
<pre class="programlisting">
309
"id" : "button-state",
310
"type" : "ClutterState",
317
[ "button", "color", "linear", "rgb(255, 0, 0)" ],
318
[ "button", "scale-x", "easeInBounce", 1.0 ],
319
[ "button", "scale-y", "easeInBounce", 1.0 ]
326
[ "button", "color", "linear", "rgb(0, 0, 255)" ],
327
[ "button", "scale-x", "easeOutBounce", 1.7 ],
328
[ "button", "scale-y", "easeOutBounce", 1.7 ]
336
<br class="example-break">
341
<a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> is available since Clutter 1.4.
344
<a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> has been deprecated in Clutter 1.12.
505
<p>Each element of the transitions array follows the same rules and order
506
as <a class="link" href="ClutterState.html#clutter-state-set-key" title="clutter_state_set_key ()"><code class="function">clutter_state_set_key()</code></a> function arguments.</p>
507
<p>The source and target values control the source and target state of the
508
transition. The key and animator properties are mutually exclusive.</p>
509
<p>The pre-delay and post-delay values are optional.</p>
510
<p>The example below is a translation into a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> definition of
511
the code in the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> example above.</p>
512
<div class="informalexample">
513
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
516
<td class="listing_lines" align="right"><pre>1
541
<td class="listing_code"><pre class="programlisting"><span class="cbracket">{</span>
542
<span class="normal"> </span><span class="string">"id"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"button-state"</span><span class="symbol">,</span>
543
<span class="normal"> </span><span class="string">"type"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"ClutterState"</span><span class="symbol">,</span>
544
<span class="normal"> </span><span class="string">"duration"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="number">500</span><span class="symbol">,</span>
545
<span class="normal"> </span><span class="string">"transitions"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="symbol">[</span>
546
<span class="normal"> </span><span class="cbracket">{</span>
547
<span class="normal"> </span><span class="string">"source"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"*"</span><span class="symbol">,</span>
548
<span class="normal"> </span><span class="string">"target"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"base"</span><span class="symbol">,</span>
549
<span class="normal"> </span><span class="string">"keys"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="symbol">[</span>
550
<span class="normal"> </span><span class="symbol">[</span><span class="normal"> </span><span class="string">"button"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"color"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"linear"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"rgb(255, 0, 0)"</span><span class="normal"> </span><span class="symbol">],</span>
551
<span class="normal"> </span><span class="symbol">[</span><span class="normal"> </span><span class="string">"button"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"scale-x"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"easeInBounce"</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1.0</span><span class="normal"> </span><span class="symbol">],</span>
552
<span class="normal"> </span><span class="symbol">[</span><span class="normal"> </span><span class="string">"button"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"scale-y"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"easeInBounce"</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1.0</span><span class="normal"> </span><span class="symbol">]</span>
553
<span class="normal"> </span><span class="symbol">]</span>
554
<span class="normal"> </span><span class="cbracket">}</span><span class="symbol">,</span>
555
<span class="normal"> </span><span class="cbracket">{</span>
556
<span class="normal"> </span><span class="string">"source"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"base"</span><span class="symbol">,</span>
557
<span class="normal"> </span><span class="string">"target"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"hover"</span><span class="symbol">,</span>
558
<span class="normal"> </span><span class="string">"keys"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="symbol">[</span>
559
<span class="normal"> </span><span class="symbol">[</span><span class="normal"> </span><span class="string">"button"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"color"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"linear"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"rgb(0, 0, 255)"</span><span class="normal"> </span><span class="symbol">],</span>
560
<span class="normal"> </span><span class="symbol">[</span><span class="normal"> </span><span class="string">"button"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"scale-x"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"easeOutBounce"</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1.7</span><span class="normal"> </span><span class="symbol">],</span>
561
<span class="normal"> </span><span class="symbol">[</span><span class="normal"> </span><span class="string">"button"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"scale-y"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"easeOutBounce"</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1.7</span><span class="normal"> </span><span class="symbol">]</span>
562
<span class="normal"> </span><span class="symbol">]</span>
563
<span class="normal"> </span><span class="cbracket">}</span>
564
<span class="normal"> </span><span class="symbol">]</span>
565
<span class="cbracket">}</span></pre></td>
347
574
<div class="refsect1">
348
<a name="ClutterState.details"></a><h2>Details</h2>
349
<div class="refsect2">
350
<a name="ClutterState-struct"></a><h3>ClutterState</h3>
351
<pre class="programlisting">typedef struct _ClutterState ClutterState;</pre>
353
The <span class="structname">ClutterState</span> structure contains only
354
private data and should be accessed using the provided API
356
<p class="since">Since 1.4</p>
359
<div class="refsect2">
360
<a name="ClutterStateClass"></a><h3>struct ClutterStateClass</h3>
361
<pre class="programlisting">struct ClutterStateClass {
362
void (* completed) (ClutterState *state);
365
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
366
<h3 class="title">Warning</h3>
367
<p><code class="literal">ClutterStateClass</code> is deprecated and should not be used in newly-written code. 1.12</p>
370
The <span class="structname">ClutterStateClass</span> structure contains
373
<div class="variablelist"><table border="0" class="variablelist">
375
<col align="left" valign="top">
379
<td><p><span class="term"><em class="structfield"><code><a name="ClutterStateClass.completed"></a>completed</code></em> ()</span></p></td>
380
<td>class handler for the <a class="link" href="ClutterState.html#ClutterState-completed" title='The "completed" signal'><span class="type">"completed"</span></a> signal</td>
383
<p class="since">Since 1.4</p>
386
<div class="refsect2">
387
<a name="clutter-state-new"></a><h3>clutter_state_new ()</h3>
388
<pre class="programlisting"><a class="link" href="ClutterState.html" title="ClutterState"><span class="returnvalue">ClutterState</span></a> * clutter_state_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
389
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
390
<h3 class="title">Warning</h3>
391
<p><code class="literal">clutter_state_new</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
392
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
395
Creates a new <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
397
<div class="variablelist"><table border="0" class="variablelist">
399
<col align="left" valign="top">
403
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
404
<td>the newly create <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance</td>
407
<p class="since">Since 1.4</p>
410
<div class="refsect2">
411
<a name="clutter-state-set-state"></a><h3>clutter_state_set_state ()</h3>
412
<pre class="programlisting"><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> * clutter_state_set_state (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
413
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>);</pre>
414
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
415
<h3 class="title">Warning</h3>
416
<p><code class="literal">clutter_state_set_state</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
417
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
420
Change the current state of <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> to <em class="parameter"><code>target_state_name</code></em>.
423
The state will animate during its transition, see
424
<a class="link" href="ClutterState.html#clutter-state-warp-to-state" title="clutter_state_warp_to_state ()"><span class="type">clutter_state_warp_to_state</span></a> for animation-free state switching.
427
Setting a <code class="literal">NULL</code> state will stop the current animation and unset
428
the current state, but keys will be left intact.
430
<div class="variablelist"><table border="0" class="variablelist">
432
<col align="left" valign="top">
437
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
438
<td>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
442
<td><p><span class="term"><em class="parameter"><code>target_state_name</code></em> :</span></p></td>
443
<td>the state to transition to</td>
446
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
447
<td>the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> that drives the
448
state transition. The returned timeline is owned by the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
449
and it should not be unreferenced. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
454
<p class="since">Since 1.4</p>
457
<div class="refsect2">
458
<a name="clutter-state-get-state"></a><h3>clutter_state_get_state ()</h3>
459
<pre class="programlisting">const <span class="returnvalue">gchar</span> * clutter_state_get_state (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>);</pre>
460
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
461
<h3 class="title">Warning</h3>
462
<p><code class="literal">clutter_state_get_state</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
463
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
466
Queries the currently set target state.
469
During a transition this function will return the target of the transition.
472
This function is useful when called from handlers of the
473
<a class="link" href="ClutterState.html#ClutterState-completed" title='The "completed" signal'><span class="type">"completed"</span></a> signal.
475
<div class="variablelist"><table border="0" class="variablelist">
477
<col align="left" valign="top">
482
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
483
<td>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
487
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
488
<td>a string containing the target state. The returned string
489
is owned by the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> and should not be modified or freed</td>
493
<p class="since">Since 1.4</p>
496
<div class="refsect2">
497
<a name="clutter-state-warp-to-state"></a><h3>clutter_state_warp_to_state ()</h3>
498
<pre class="programlisting"><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> * clutter_state_warp_to_state (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
499
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>);</pre>
500
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
501
<h3 class="title">Warning</h3>
502
<p><code class="literal">clutter_state_warp_to_state</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
503
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
506
Change to the specified target state immediately with no animation.
509
See <a class="link" href="ClutterState.html#clutter-state-set-state" title="clutter_state_set_state ()"><code class="function">clutter_state_set_state()</code></a>.
511
<div class="variablelist"><table border="0" class="variablelist">
513
<col align="left" valign="top">
518
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
519
<td>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
523
<td><p><span class="term"><em class="parameter"><code>target_state_name</code></em> :</span></p></td>
524
<td>the state to transition to</td>
527
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
528
<td>the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> that drives the
529
state transition. The returned timeline is owned by the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
530
and it should not be unreferenced. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
535
<p class="since">Since 1.4</p>
538
<div class="refsect2">
539
<a name="clutter-state-set"></a><h3>clutter_state_set ()</h3>
540
<pre class="programlisting"><span class="returnvalue">void</span> clutter_state_set (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
541
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
542
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
543
<em class="parameter"><code><span class="type">gpointer</span> first_object</code></em>,
544
<em class="parameter"><code>const <span class="type">gchar</span> *first_property_name</code></em>,
545
<em class="parameter"><code><span class="type">gulong</span> first_mode</code></em>,
546
<em class="parameter"><code>...</code></em>);</pre>
547
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
548
<h3 class="title">Warning</h3>
549
<p><code class="literal">clutter_state_set</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
550
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
553
Adds multiple keys to a named state of a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance, specifying
575
<a name="ClutterState.functions_details"></a><h2>Functions</h2>
576
<div class="refsect2">
577
<a name="clutter-state-new"></a><h3>clutter_state_new ()</h3>
578
<pre class="programlisting"><a class="link" href="ClutterState.html" title="ClutterState"><span class="returnvalue">ClutterState</span></a> *
579
clutter_state_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
580
<div class="warning">
581
<p><code class="literal">clutter_state_new</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
582
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
583
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
585
<p>Creates a new <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a></p>
586
<div class="refsect3">
587
<a name="id-1.10.18.10.2.7"></a><h4>Returns</h4>
588
<p> the newly create <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance</p>
591
<p class="since">Since 1.4</p>
594
<div class="refsect2">
595
<a name="clutter-state-set-state"></a><h3>clutter_state_set_state ()</h3>
596
<pre class="programlisting"><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *
597
clutter_state_set_state (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
598
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>);</pre>
599
<div class="warning">
600
<p><code class="literal">clutter_state_set_state</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
601
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
602
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
604
<p>Change the current state of <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> to <em class="parameter"><code>target_state_name</code></em>
606
<p>The state will animate during its transition, see
607
<a class="link" href="ClutterState.html#clutter-state-warp-to-state" title="clutter_state_warp_to_state ()"><span class="type">clutter_state_warp_to_state</span></a> for animation-free state switching.</p>
608
<p>Setting a <code class="literal">NULL</code> state will stop the current animation and unset
609
the current state, but keys will be left intact.</p>
610
<div class="refsect3">
611
<a name="id-1.10.18.10.3.9"></a><h4>Parameters</h4>
612
<div class="informaltable"><table width="100%" border="0">
614
<col width="150px" class="parameters_name">
615
<col class="parameters_description">
616
<col width="200px" class="parameters_annotations">
620
<td class="parameter_name"><p>state</p></td>
621
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a></p></td>
622
<td class="parameter_annotations"> </td>
625
<td class="parameter_name"><p>target_state_name</p></td>
626
<td class="parameter_description"><p>the state to transition to</p></td>
627
<td class="parameter_annotations"> </td>
632
<div class="refsect3">
633
<a name="id-1.10.18.10.3.10"></a><h4>Returns</h4>
634
<p> the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> that drives the
635
state transition. The returned timeline is owned by the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
636
and it should not be unreferenced. </p>
637
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
639
<p class="since">Since 1.4</p>
642
<div class="refsect2">
643
<a name="clutter-state-get-state"></a><h3>clutter_state_get_state ()</h3>
644
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
645
clutter_state_get_state (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>);</pre>
646
<div class="warning">
647
<p><code class="literal">clutter_state_get_state</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
648
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
649
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
651
<p>Queries the currently set target state.</p>
652
<p>During a transition this function will return the target of the transition.</p>
653
<p>This function is useful when called from handlers of the
654
<a class="link" href="ClutterState.html#ClutterState-completed" title="The “completed” signal"><span class="type">“completed”</span></a> signal.</p>
655
<div class="refsect3">
656
<a name="id-1.10.18.10.4.9"></a><h4>Parameters</h4>
657
<div class="informaltable"><table width="100%" border="0">
659
<col width="150px" class="parameters_name">
660
<col class="parameters_description">
661
<col width="200px" class="parameters_annotations">
664
<td class="parameter_name"><p>state</p></td>
665
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a></p></td>
666
<td class="parameter_annotations"> </td>
670
<div class="refsect3">
671
<a name="id-1.10.18.10.4.10"></a><h4>Returns</h4>
672
<p> a string containing the target state. The returned string
673
is owned by the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> and should not be modified or freed</p>
676
<p class="since">Since 1.4</p>
679
<div class="refsect2">
680
<a name="clutter-state-warp-to-state"></a><h3>clutter_state_warp_to_state ()</h3>
681
<pre class="programlisting"><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *
682
clutter_state_warp_to_state (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
683
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>);</pre>
684
<div class="warning">
685
<p><code class="literal">clutter_state_warp_to_state</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
686
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
687
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
689
<p>Change to the specified target state immediately with no animation.</p>
690
<p>See <a class="link" href="ClutterState.html#clutter-state-set-state" title="clutter_state_set_state ()"><code class="function">clutter_state_set_state()</code></a>.</p>
691
<div class="refsect3">
692
<a name="id-1.10.18.10.5.8"></a><h4>Parameters</h4>
693
<div class="informaltable"><table width="100%" border="0">
695
<col width="150px" class="parameters_name">
696
<col class="parameters_description">
697
<col width="200px" class="parameters_annotations">
701
<td class="parameter_name"><p>state</p></td>
702
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a></p></td>
703
<td class="parameter_annotations"> </td>
706
<td class="parameter_name"><p>target_state_name</p></td>
707
<td class="parameter_description"><p>the state to transition to</p></td>
708
<td class="parameter_annotations"> </td>
713
<div class="refsect3">
714
<a name="id-1.10.18.10.5.9"></a><h4>Returns</h4>
715
<p> the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> that drives the
716
state transition. The returned timeline is owned by the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
717
and it should not be unreferenced. </p>
718
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
720
<p class="since">Since 1.4</p>
723
<div class="refsect2">
724
<a name="clutter-state-set"></a><h3>clutter_state_set ()</h3>
725
<pre class="programlisting"><span class="returnvalue">void</span>
726
clutter_state_set (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
727
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
728
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
729
<em class="parameter"><code><span class="type">gpointer</span> first_object</code></em>,
730
<em class="parameter"><code>const <span class="type">gchar</span> *first_property_name</code></em>,
731
<em class="parameter"><code><span class="type">gulong</span> first_mode</code></em>,
732
<em class="parameter"><code>...</code></em>);</pre>
733
<div class="warning">
734
<p><code class="literal">clutter_state_set</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
735
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
736
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
738
<p>Adds multiple keys to a named state of a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance, specifying
554
739
the easing mode and value a given property of an object should have at a
555
given progress of the animation.
558
The mode specified is the easing mode used when going to from the previous
559
key to the specified key.
562
For instance, the code below:
740
given progress of the animation.</p>
741
<p>The mode specified is the easing mode used when going to from the previous
742
key to the specified key.</p>
743
<p>For instance, the code below:</p>
566
744
<div class="informalexample">
567
745
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
633
800
<td class="listing_code"><pre class="programlisting"><span class="function"><a href="ClutterState.html#clutter-state-set">clutter_state_set</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">state</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"hover"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"toggled"</span><span class="symbol">,</span>
634
<span class="normal"> button</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"delayed::scale-x"</span><span class="symbol">,</span><span class="normal"> <a href="ClutterTimeline.html#CLUTTER-LINEAR:CAPS">CLUTTER_LINEAR</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">1.0</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0.2</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0.2</span><span class="symbol">,</span>
635
<span class="normal"> button</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"delayed::scale-y"</span><span class="symbol">,</span><span class="normal"> <a href="ClutterTimeline.html#CLUTTER-LINEAR:CAPS">CLUTTER_LINEAR</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">1.0</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0.2</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0.2</span><span class="symbol">,</span>
801
<span class="normal"> button</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"delayed::scale-x"</span><span class="symbol">,</span><span class="normal"> CLUTTER_LINEAR</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1.0</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0.2</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0.2</span><span class="symbol">,</span>
802
<span class="normal"> button</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"delayed::scale-y"</span><span class="symbol">,</span><span class="normal"> CLUTTER_LINEAR</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1.0</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0.2</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0.2</span><span class="symbol">,</span>
636
803
<span class="normal"> NULL</span><span class="symbol">);</span></pre></td>
645
will pause for 20% of the duration of the transition before animating,
646
and 20% of the duration after animating.
648
<div class="variablelist"><table border="0" class="variablelist">
810
<p>will pause for 20% of the duration of the transition before animating,
811
and 20% of the duration after animating.</p>
812
<div class="refsect3">
813
<a name="id-1.10.18.10.6.19"></a><h4>Parameters</h4>
814
<div class="informaltable"><table width="100%" border="0">
650
<col align="left" valign="top">
816
<col width="150px" class="parameters_name">
817
<col class="parameters_description">
818
<col width="200px" class="parameters_annotations">
655
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
656
<td>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</td>
659
<td><p><span class="term"><em class="parameter"><code>source_state_name</code></em> :</span></p></td>
660
<td>the name of the source state keys are being added for. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
664
<td><p><span class="term"><em class="parameter"><code>target_state_name</code></em> :</span></p></td>
665
<td>the name of the target state keys are being added for</td>
668
<td><p><span class="term"><em class="parameter"><code>first_object</code></em> :</span></p></td>
669
<td>a <span class="type">GObject</span>
673
<td><p><span class="term"><em class="parameter"><code>first_property_name</code></em> :</span></p></td>
674
<td>a property of <em class="parameter"><code>first_object</code></em> to specify a key for</td>
677
<td><p><span class="term"><em class="parameter"><code>first_mode</code></em> :</span></p></td>
678
<td>the id of the alpha function to use</td>
681
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
682
<td>the value <em class="parameter"><code>first_property_name</code></em> should have in <em class="parameter"><code>target_state_name</code></em>,
822
<td class="parameter_name"><p>state</p></td>
823
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</p></td>
824
<td class="parameter_annotations"> </td>
827
<td class="parameter_name"><p>source_state_name</p></td>
828
<td class="parameter_description"><p> the name of the source state keys are being added for. </p></td>
829
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
832
<td class="parameter_name"><p>target_state_name</p></td>
833
<td class="parameter_description"><p>the name of the target state keys are being added for</p></td>
834
<td class="parameter_annotations"> </td>
837
<td class="parameter_name"><p>first_object</p></td>
838
<td class="parameter_description"><p>a <span class="type">GObject</span></p></td>
839
<td class="parameter_annotations"> </td>
842
<td class="parameter_name"><p>first_property_name</p></td>
843
<td class="parameter_description"><p>a property of <em class="parameter"><code>first_object</code></em>
844
to specify a key for</p></td>
845
<td class="parameter_annotations"> </td>
848
<td class="parameter_name"><p>first_mode</p></td>
849
<td class="parameter_description"><p>the id of the alpha function to use</p></td>
850
<td class="parameter_annotations"> </td>
853
<td class="parameter_name"><p>...</p></td>
854
<td class="parameter_description"><p>the value <em class="parameter"><code>first_property_name</code></em>
855
should have in <em class="parameter"><code>target_state_name</code></em>
683
857
followed by object, property name, mode, value tuples, terminated
684
by <code class="literal">NULL</code>
858
by <code class="literal">NULL</code></p></td>
859
<td class="parameter_annotations"> </td>
689
864
<p class="since">Since 1.4</p>
692
867
<div class="refsect2">
693
<a name="clutter-state-set-key"></a><h3>clutter_state_set_key ()</h3>
694
<pre class="programlisting"><a class="link" href="ClutterState.html" title="ClutterState"><span class="returnvalue">ClutterState</span></a> * clutter_state_set_key (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
695
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
696
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
697
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
698
<em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>,
699
<em class="parameter"><code><span class="type">guint</span> mode</code></em>,
700
<em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>,
701
<em class="parameter"><code><span class="type">gdouble</span> pre_delay</code></em>,
702
<em class="parameter"><code><span class="type">gdouble</span> post_delay</code></em>);</pre>
703
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
704
<h3 class="title">Warning</h3>
705
<p><code class="literal">clutter_state_set_key</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
868
<a name="clutter-state-set-key"></a><h3>clutter_state_set_key ()</h3>
869
<pre class="programlisting"><a class="link" href="ClutterState.html" title="ClutterState"><span class="returnvalue">ClutterState</span></a> *
870
clutter_state_set_key (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
871
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
872
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
873
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
874
<em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>,
875
<em class="parameter"><code><span class="type">guint</span> mode</code></em>,
876
<em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>,
877
<em class="parameter"><code><span class="type">gdouble</span> pre_delay</code></em>,
878
<em class="parameter"><code><span class="type">gdouble</span> post_delay</code></em>);</pre>
879
<div class="warning">
880
<p><code class="literal">clutter_state_set_key</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
881
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
706
882
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
709
Sets one specific end key for a state name, <em class="parameter"><code>object</code></em>, <em class="parameter"><code>property_name</code></em>
712
<div class="variablelist"><table border="0" class="variablelist">
884
<p>Sets one specific end key for a state name, <em class="parameter"><code>object</code></em>
885
, <em class="parameter"><code>property_name</code></em>
888
<div class="refsect3">
889
<a name="id-1.10.18.10.7.7"></a><h4>Parameters</h4>
890
<div class="informaltable"><table width="100%" border="0">
714
<col align="left" valign="top">
892
<col width="150px" class="parameters_name">
893
<col class="parameters_description">
894
<col width="200px" class="parameters_annotations">
719
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
720
<td>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</td>
898
<td class="parameter_name"><p>state</p></td>
899
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</p></td>
900
<td class="parameter_annotations"> </td>
723
<td><p><span class="term"><em class="parameter"><code>source_state_name</code></em> :</span></p></td>
724
<td>the source transition to specify
903
<td class="parameter_name"><p>source_state_name</p></td>
904
<td class="parameter_description"><p> the source transition to specify
725
905
transition for, or <code class="literal">NULL</code> to specify the default fallback when a
726
more specific source state doesn't exist. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
730
<td><p><span class="term"><em class="parameter"><code>target_state_name</code></em> :</span></p></td>
731
<td>the name of the transition to set a key value for.</td>
734
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
735
<td>the <span class="type">GObject</span> to set a key for</td>
738
<td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
739
<td>the property to set a key for</td>
742
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
743
<td>the id of the alpha function to use</td>
746
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
747
<td>the value for property_name of object in state_name</td>
750
<td><p><span class="term"><em class="parameter"><code>pre_delay</code></em> :</span></p></td>
751
<td>relative time of the transition to be idle in the beginning
752
of the transition</td>
755
<td><p><span class="term"><em class="parameter"><code>post_delay</code></em> :</span></p></td>
756
<td>relative time of the transition to be idle in the end of
760
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
761
<td>the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance, allowing
762
chaining of multiple calls. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
767
<p class="since">Since 1.4</p>
770
<div class="refsect2">
771
<a name="clutter-state-set-duration"></a><h3>clutter_state_set_duration ()</h3>
772
<pre class="programlisting"><span class="returnvalue">void</span> clutter_state_set_duration (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
773
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
774
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
775
<em class="parameter"><code><span class="type">guint</span> duration</code></em>);</pre>
776
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
777
<h3 class="title">Warning</h3>
778
<p><code class="literal">clutter_state_set_duration</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
779
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
782
Sets the duration of a transition.
785
If both state names are <code class="literal">NULL</code> the default duration for <em class="parameter"><code>state</code></em> is set.
788
If only <em class="parameter"><code>target_state_name</code></em> is specified, the passed <em class="parameter"><code>duration</code></em> becomes
789
the default duration for transitions to the target state.
792
If both states names are specified, the passed <em class="parameter"><code>duration</code></em> only applies
793
to the specified transition.
795
<div class="variablelist"><table border="0" class="variablelist">
797
<col align="left" valign="top">
802
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
803
<td>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
807
<td><p><span class="term"><em class="parameter"><code>source_state_name</code></em> :</span></p></td>
808
<td>the name of the source state, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
812
<td><p><span class="term"><em class="parameter"><code>target_state_name</code></em> :</span></p></td>
813
<td>the name of the target state, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
817
<td><p><span class="term"><em class="parameter"><code>duration</code></em> :</span></p></td>
818
<td>the duration of the transition, in milliseconds</td>
822
<p class="since">Since 1.4</p>
825
<div class="refsect2">
826
<a name="clutter-state-get-duration"></a><h3>clutter_state_get_duration ()</h3>
827
<pre class="programlisting"><span class="returnvalue">guint</span> clutter_state_get_duration (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
828
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
829
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>);</pre>
830
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
831
<h3 class="title">Warning</h3>
832
<p><code class="literal">clutter_state_get_duration</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
833
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
836
Queries the duration used for transitions between a source and
840
The semantics for the query are the same as the semantics used for
841
setting the duration with <a class="link" href="ClutterState.html#clutter-state-set-duration" title="clutter_state_set_duration ()"><code class="function">clutter_state_set_duration()</code></a>
843
<div class="variablelist"><table border="0" class="variablelist">
845
<col align="left" valign="top">
850
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
851
<td>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
855
<td><p><span class="term"><em class="parameter"><code>source_state_name</code></em> :</span></p></td>
856
<td>the name of the source state to
857
get the duration of, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
861
<td><p><span class="term"><em class="parameter"><code>target_state_name</code></em> :</span></p></td>
862
<td>the name of the source state to
863
get the duration of, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
867
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
868
<td>the duration, in milliseconds</td>
872
<p class="since">Since 1.4</p>
875
<div class="refsect2">
876
<a name="clutter-state-get-states"></a><h3>clutter_state_get_states ()</h3>
877
<pre class="programlisting"><span class="returnvalue">GList</span> * clutter_state_get_states (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>);</pre>
878
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
879
<h3 class="title">Warning</h3>
880
<p><code class="literal">clutter_state_get_states</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
881
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
884
Gets a list of all the state names managed by this <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>.
886
<div class="variablelist"><table border="0" class="variablelist">
888
<col align="left" valign="top">
893
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
894
<td>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</td>
897
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
898
<td>a newly allocated
906
more specific source state doesn't exist. </p></td>
907
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
910
<td class="parameter_name"><p>target_state_name</p></td>
911
<td class="parameter_description"><p>the name of the transition to set a key value for.</p></td>
912
<td class="parameter_annotations"> </td>
915
<td class="parameter_name"><p>object</p></td>
916
<td class="parameter_description"><p>the <span class="type">GObject</span> to set a key for</p></td>
917
<td class="parameter_annotations"> </td>
920
<td class="parameter_name"><p>property_name</p></td>
921
<td class="parameter_description"><p>the property to set a key for</p></td>
922
<td class="parameter_annotations"> </td>
925
<td class="parameter_name"><p>mode</p></td>
926
<td class="parameter_description"><p>the id of the alpha function to use</p></td>
927
<td class="parameter_annotations"> </td>
930
<td class="parameter_name"><p>value</p></td>
931
<td class="parameter_description"><p>the value for property_name of object in state_name</p></td>
932
<td class="parameter_annotations"> </td>
935
<td class="parameter_name"><p>pre_delay</p></td>
936
<td class="parameter_description"><p>relative time of the transition to be idle in the beginning
937
of the transition</p></td>
938
<td class="parameter_annotations"> </td>
941
<td class="parameter_name"><p>post_delay</p></td>
942
<td class="parameter_description"><p>relative time of the transition to be idle in the end of
943
the transition</p></td>
944
<td class="parameter_annotations"> </td>
949
<div class="refsect3">
950
<a name="id-1.10.18.10.7.8"></a><h4>Returns</h4>
951
<p> the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance, allowing
952
chaining of multiple calls. </p>
953
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
955
<p class="since">Since 1.4</p>
958
<div class="refsect2">
959
<a name="clutter-state-set-duration"></a><h3>clutter_state_set_duration ()</h3>
960
<pre class="programlisting"><span class="returnvalue">void</span>
961
clutter_state_set_duration (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
962
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
963
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
964
<em class="parameter"><code><span class="type">guint</span> duration</code></em>);</pre>
965
<div class="warning">
966
<p><code class="literal">clutter_state_set_duration</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
967
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
968
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
970
<p>Sets the duration of a transition.</p>
971
<p>If both state names are <code class="literal">NULL</code> the default duration for <em class="parameter"><code>state</code></em>
973
<p>If only <em class="parameter"><code>target_state_name</code></em>
974
is specified, the passed <em class="parameter"><code>duration</code></em>
976
the default duration for transitions to the target state.</p>
977
<p>If both states names are specified, the passed <em class="parameter"><code>duration</code></em>
979
to the specified transition.</p>
980
<div class="refsect3">
981
<a name="id-1.10.18.10.8.10"></a><h4>Parameters</h4>
982
<div class="informaltable"><table width="100%" border="0">
984
<col width="150px" class="parameters_name">
985
<col class="parameters_description">
986
<col width="200px" class="parameters_annotations">
990
<td class="parameter_name"><p>state</p></td>
991
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a></p></td>
992
<td class="parameter_annotations"> </td>
995
<td class="parameter_name"><p>source_state_name</p></td>
996
<td class="parameter_description"><p> the name of the source state, or <code class="literal">NULL</code>. </p></td>
997
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1000
<td class="parameter_name"><p>target_state_name</p></td>
1001
<td class="parameter_description"><p> the name of the target state, or <code class="literal">NULL</code>. </p></td>
1002
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1005
<td class="parameter_name"><p>duration</p></td>
1006
<td class="parameter_description"><p>the duration of the transition, in milliseconds</p></td>
1007
<td class="parameter_annotations"> </td>
1012
<p class="since">Since 1.4</p>
1015
<div class="refsect2">
1016
<a name="clutter-state-get-duration"></a><h3>clutter_state_get_duration ()</h3>
1017
<pre class="programlisting"><span class="returnvalue">guint</span>
1018
clutter_state_get_duration (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
1019
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
1020
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>);</pre>
1021
<div class="warning">
1022
<p><code class="literal">clutter_state_get_duration</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
1023
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1024
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1026
<p>Queries the duration used for transitions between a source and
1027
target state pair</p>
1028
<p>The semantics for the query are the same as the semantics used for
1029
setting the duration with <a class="link" href="ClutterState.html#clutter-state-set-duration" title="clutter_state_set_duration ()"><code class="function">clutter_state_set_duration()</code></a></p>
1030
<div class="refsect3">
1031
<a name="id-1.10.18.10.9.8"></a><h4>Parameters</h4>
1032
<div class="informaltable"><table width="100%" border="0">
1034
<col width="150px" class="parameters_name">
1035
<col class="parameters_description">
1036
<col width="200px" class="parameters_annotations">
1040
<td class="parameter_name"><p>state</p></td>
1041
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a></p></td>
1042
<td class="parameter_annotations"> </td>
1045
<td class="parameter_name"><p>source_state_name</p></td>
1046
<td class="parameter_description"><p> the name of the source state to
1047
get the duration of, or <code class="literal">NULL</code>. </p></td>
1048
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1051
<td class="parameter_name"><p>target_state_name</p></td>
1052
<td class="parameter_description"><p> the name of the source state to
1053
get the duration of, or <code class="literal">NULL</code>. </p></td>
1054
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1059
<div class="refsect3">
1060
<a name="id-1.10.18.10.9.9"></a><h4>Returns</h4>
1061
<p> the duration, in milliseconds</p>
1064
<p class="since">Since 1.4</p>
1067
<div class="refsect2">
1068
<a name="clutter-state-get-states"></a><h3>clutter_state_get_states ()</h3>
1069
<pre class="programlisting"><span class="returnvalue">GList</span> *
1070
clutter_state_get_states (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>);</pre>
1071
<div class="warning">
1072
<p><code class="literal">clutter_state_get_states</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
1073
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1074
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1076
<p>Gets a list of all the state names managed by this <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>.</p>
1077
<div class="refsect3">
1078
<a name="id-1.10.18.10.10.7"></a><h4>Parameters</h4>
1079
<div class="informaltable"><table width="100%" border="0">
1081
<col width="150px" class="parameters_name">
1082
<col class="parameters_description">
1083
<col width="200px" class="parameters_annotations">
1086
<td class="parameter_name"><p>state</p></td>
1087
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</p></td>
1088
<td class="parameter_annotations"> </td>
1092
<div class="refsect3">
1093
<a name="id-1.10.18.10.10.8"></a><h4>Returns</h4>
1094
<p> a newly allocated
899
1095
<span class="type">GList</span> of state names. The contents of the returned <span class="type">GList</span> are owned
900
1096
by the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> and should not be modified or freed. Use
901
1097
<code class="function">g_list_free()</code> to free the resources allocated by the returned list when
902
done using it. <span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
1099
<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span></p>
907
1101
<p class="since">Since 1.4</p>
910
1104
<div class="refsect2">
911
<a name="clutter-state-get-keys"></a><h3>clutter_state_get_keys ()</h3>
912
<pre class="programlisting"><span class="returnvalue">GList</span> * clutter_state_get_keys (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
913
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
914
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
915
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
916
<em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);</pre>
917
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
918
<h3 class="title">Warning</h3>
919
<p><code class="literal">clutter_state_get_keys</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1105
<a name="clutter-state-get-keys"></a><h3>clutter_state_get_keys ()</h3>
1106
<pre class="programlisting"><span class="returnvalue">GList</span> *
1107
clutter_state_get_keys (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
1108
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
1109
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
1110
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
1111
<em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);</pre>
1112
<div class="warning">
1113
<p><code class="literal">clutter_state_get_keys</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
1114
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
920
1115
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
923
Returns a list of pointers to opaque structures with accessor functions
924
that describe the keys added to an animator.
926
<div class="variablelist"><table border="0" class="variablelist">
1117
<p>Returns a list of pointers to opaque structures with accessor functions
1118
that describe the keys added to an animator.</p>
1119
<div class="refsect3">
1120
<a name="id-1.10.18.10.11.7"></a><h4>Parameters</h4>
1121
<div class="informaltable"><table width="100%" border="0">
928
<col align="left" valign="top">
1123
<col width="150px" class="parameters_name">
1124
<col class="parameters_description">
1125
<col width="200px" class="parameters_annotations">
933
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
934
<td>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</td>
937
<td><p><span class="term"><em class="parameter"><code>source_state_name</code></em> :</span></p></td>
938
<td>the source transition name to query,
939
or <code class="literal">NULL</code> for all source states. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
943
<td><p><span class="term"><em class="parameter"><code>target_state_name</code></em> :</span></p></td>
944
<td>the target transition name to query,
945
or <code class="literal">NULL</code> for all target states. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
949
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
950
<td>the specific object instance to list keys for,
951
or <code class="literal">NULL</code> for all managed objects. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
955
<td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
956
<td>the property name to search for, or <code class="literal">NULL</code>
957
for all properties. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
961
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
963
newly allocated <span class="type">GList</span> of <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a>s. The contents of
1129
<td class="parameter_name"><p>state</p></td>
1130
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</p></td>
1131
<td class="parameter_annotations"> </td>
1134
<td class="parameter_name"><p>source_state_name</p></td>
1135
<td class="parameter_description"><p> the source transition name to query,
1136
or <code class="literal">NULL</code> for all source states. </p></td>
1137
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1140
<td class="parameter_name"><p>target_state_name</p></td>
1141
<td class="parameter_description"><p> the target transition name to query,
1142
or <code class="literal">NULL</code> for all target states. </p></td>
1143
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1146
<td class="parameter_name"><p>object</p></td>
1147
<td class="parameter_description"><p> the specific object instance to list keys for,
1148
or <code class="literal">NULL</code> for all managed objects. </p></td>
1149
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1152
<td class="parameter_name"><p>property_name</p></td>
1153
<td class="parameter_description"><p> the property name to search for, or <code class="literal">NULL</code>
1154
for all properties. </p></td>
1155
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1160
<div class="refsect3">
1161
<a name="id-1.10.18.10.11.8"></a><h4>Returns</h4>
1163
newly allocated <span class="type">GList</span> of <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a><!-- -->s. The contents of
964
1164
the returned list are owned by the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> and should not be
965
1165
modified or freed. Use <code class="function">g_list_free()</code> to free the resources allocated
966
by the returned list when done using it. <span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Clutter.StateKey]</span>
971
<p class="since">Since 1.4</p>
974
<div class="refsect2">
975
<a name="clutter-state-remove-key"></a><h3>clutter_state_remove_key ()</h3>
976
<pre class="programlisting"><span class="returnvalue">void</span> clutter_state_remove_key (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
977
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
978
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
979
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
980
<em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);</pre>
981
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
982
<h3 class="title">Warning</h3>
983
<p><code class="literal">clutter_state_remove_key</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
984
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
987
Removes all keys matching the search criteria passed in arguments.
989
<div class="variablelist"><table border="0" class="variablelist">
991
<col align="left" valign="top">
996
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
997
<td>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</td>
1000
<td><p><span class="term"><em class="parameter"><code>source_state_name</code></em> :</span></p></td>
1001
<td>the source state name to query,
1002
or <code class="literal">NULL</code> for all source states. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1006
<td><p><span class="term"><em class="parameter"><code>target_state_name</code></em> :</span></p></td>
1007
<td>the target state name to query,
1008
or <code class="literal">NULL</code> for all target states. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1012
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
1013
<td>the specific object instance to list keys for,
1014
or <code class="literal">NULL</code> for all managed objects. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1018
<td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
1019
<td>the property name to search for,
1020
or <code class="literal">NULL</code> for all properties. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1025
<p class="since">Since 1.4</p>
1028
<div class="refsect2">
1029
<a name="clutter-state-get-timeline"></a><h3>clutter_state_get_timeline ()</h3>
1030
<pre class="programlisting"><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> * clutter_state_get_timeline (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>);</pre>
1031
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1032
<h3 class="title">Warning</h3>
1033
<p><code class="literal">clutter_state_get_timeline</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1034
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1037
Gets the timeline driving the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
1039
<div class="variablelist"><table border="0" class="variablelist">
1041
<col align="left" valign="top">
1046
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
1047
<td>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
1051
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1052
<td>the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> that drives
1166
by the returned list when done using it. </p>
1167
<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Clutter.StateKey]</span></p>
1169
<p class="since">Since 1.4</p>
1172
<div class="refsect2">
1173
<a name="clutter-state-remove-key"></a><h3>clutter_state_remove_key ()</h3>
1174
<pre class="programlisting"><span class="returnvalue">void</span>
1175
clutter_state_remove_key (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
1176
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
1177
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
1178
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
1179
<em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);</pre>
1180
<div class="warning">
1181
<p><code class="literal">clutter_state_remove_key</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
1182
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1183
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1185
<p>Removes all keys matching the search criteria passed in arguments.</p>
1186
<div class="refsect3">
1187
<a name="id-1.10.18.10.12.7"></a><h4>Parameters</h4>
1188
<div class="informaltable"><table width="100%" border="0">
1190
<col width="150px" class="parameters_name">
1191
<col class="parameters_description">
1192
<col width="200px" class="parameters_annotations">
1196
<td class="parameter_name"><p>state</p></td>
1197
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</p></td>
1198
<td class="parameter_annotations"> </td>
1201
<td class="parameter_name"><p>source_state_name</p></td>
1202
<td class="parameter_description"><p> the source state name to query,
1203
or <code class="literal">NULL</code> for all source states. </p></td>
1204
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1207
<td class="parameter_name"><p>target_state_name</p></td>
1208
<td class="parameter_description"><p> the target state name to query,
1209
or <code class="literal">NULL</code> for all target states. </p></td>
1210
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1213
<td class="parameter_name"><p>object</p></td>
1214
<td class="parameter_description"><p> the specific object instance to list keys for,
1215
or <code class="literal">NULL</code> for all managed objects. </p></td>
1216
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1219
<td class="parameter_name"><p>property_name</p></td>
1220
<td class="parameter_description"><p> the property name to search for,
1221
or <code class="literal">NULL</code> for all properties. </p></td>
1222
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1227
<p class="since">Since 1.4</p>
1230
<div class="refsect2">
1231
<a name="clutter-state-get-timeline"></a><h3>clutter_state_get_timeline ()</h3>
1232
<pre class="programlisting"><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *
1233
clutter_state_get_timeline (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>);</pre>
1234
<div class="warning">
1235
<p><code class="literal">clutter_state_get_timeline</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
1236
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1237
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1239
<p>Gets the timeline driving the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a></p>
1240
<div class="refsect3">
1241
<a name="id-1.10.18.10.13.7"></a><h4>Parameters</h4>
1242
<div class="informaltable"><table width="100%" border="0">
1244
<col width="150px" class="parameters_name">
1245
<col class="parameters_description">
1246
<col width="200px" class="parameters_annotations">
1249
<td class="parameter_name"><p>state</p></td>
1250
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a></p></td>
1251
<td class="parameter_annotations"> </td>
1255
<div class="refsect3">
1256
<a name="id-1.10.18.10.13.8"></a><h4>Returns</h4>
1257
<p> the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> that drives
1053
1258
the state change animations. The returned timeline is owned
1054
by the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> and it should not be unreferenced directly. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
1259
by the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> and it should not be unreferenced directly. </p>
1260
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
1059
1262
<p class="since">Since 1.4</p>
1062
1265
<div class="refsect2">
1063
<a name="clutter-state-set-animator"></a><h3>clutter_state_set_animator ()</h3>
1064
<pre class="programlisting"><span class="returnvalue">void</span> clutter_state_set_animator (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
1065
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
1066
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
1067
<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>);</pre>
1068
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1069
<h3 class="title">Warning</h3>
1070
<p><code class="literal">clutter_state_set_animator</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1266
<a name="clutter-state-set-animator"></a><h3>clutter_state_set_animator ()</h3>
1267
<pre class="programlisting"><span class="returnvalue">void</span>
1268
clutter_state_set_animator (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
1269
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
1270
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
1271
<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>);</pre>
1272
<div class="warning">
1273
<p><code class="literal">clutter_state_set_animator</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
1274
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1071
1275
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1074
Specifies a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> to be used when transitioning between
1075
the two named states.
1078
The <em class="parameter"><code>animator</code></em> allows specifying a transition between the state that is
1277
<p>Specifies a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> to be used when transitioning between
1278
the two named states.</p>
1279
<p>The <em class="parameter"><code>animator</code></em>
1280
allows specifying a transition between the state that is
1079
1281
more elaborate than the basic transitions allowed by the tweening of
1080
properties defined in the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> keys.
1083
If <em class="parameter"><code>animator</code></em> is <code class="literal">NULL</code> it will unset an existing animator.
1086
<a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> will take a reference on the passed <em class="parameter"><code>animator</code></em>, if any
1088
<div class="variablelist"><table border="0" class="variablelist">
1090
<col align="left" valign="top">
1095
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
1096
<td>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</td>
1099
<td><p><span class="term"><em class="parameter"><code>source_state_name</code></em> :</span></p></td>
1100
<td>the name of a source state</td>
1103
<td><p><span class="term"><em class="parameter"><code>target_state_name</code></em> :</span></p></td>
1104
<td>the name of a target state</td>
1107
<td><p><span class="term"><em class="parameter"><code>animator</code></em> :</span></p></td>
1108
<td>a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> instance, or <code class="literal">NULL</code> to
1109
unset an existing <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1114
<p class="since">Since 1.4</p>
1117
<div class="refsect2">
1118
<a name="clutter-state-get-animator"></a><h3>clutter_state_get_animator ()</h3>
1119
<pre class="programlisting"><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="returnvalue">ClutterAnimator</span></a> * clutter_state_get_animator (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
1120
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
1121
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>);</pre>
1122
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1123
<h3 class="title">Warning</h3>
1124
<p><code class="literal">clutter_state_get_animator</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1125
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1128
Retrieves the <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> that is being used for transitioning
1129
between the two states, if any has been set
1131
<div class="variablelist"><table border="0" class="variablelist">
1133
<col align="left" valign="top">
1138
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
1139
<td>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</td>
1142
<td><p><span class="term"><em class="parameter"><code>source_state_name</code></em> :</span></p></td>
1143
<td>the name of a source state</td>
1146
<td><p><span class="term"><em class="parameter"><code>target_state_name</code></em> :</span></p></td>
1147
<td>the name of a target state</td>
1150
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1151
<td>a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> instance, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
1156
<p class="since">Since 1.4</p>
1159
<div class="refsect2">
1160
<a name="ClutterStateKey"></a><h3>ClutterStateKey</h3>
1161
<pre class="programlisting">typedef struct _ClutterStateKey ClutterStateKey;</pre>
1163
<span class="structname">ClutterStateKey</span> is an opaque structure whose
1164
members cannot be accessed directly
1166
<p class="since">Since 1.4</p>
1169
<div class="refsect2">
1170
<a name="clutter-state-key-get-source-state-name"></a><h3>clutter_state_key_get_source_state_name ()</h3>
1171
<pre class="programlisting">const <span class="returnvalue">gchar</span> * clutter_state_key_get_source_state_name
1172
(<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
1173
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1174
<h3 class="title">Warning</h3>
1175
<p><code class="literal">clutter_state_key_get_source_state_name</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1176
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1179
Retrieves the name of the source state of the <em class="parameter"><code>state_key</code></em>
1181
<div class="variablelist"><table border="0" class="variablelist">
1183
<col align="left" valign="top">
1188
<td><p><span class="term"><em class="parameter"><code>state_key</code></em> :</span></p></td>
1189
<td>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a>
1193
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1194
<td>the name of the source state for this key, or <code class="literal">NULL</code>
1282
properties defined in the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> keys.</p>
1283
<p>If <em class="parameter"><code>animator</code></em>
1284
is <code class="literal">NULL</code> it will unset an existing animator.</p>
1285
<p><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> will take a reference on the passed <em class="parameter"><code>animator</code></em>
1287
<div class="refsect3">
1288
<a name="id-1.10.18.10.14.10"></a><h4>Parameters</h4>
1289
<div class="informaltable"><table width="100%" border="0">
1291
<col width="150px" class="parameters_name">
1292
<col class="parameters_description">
1293
<col width="200px" class="parameters_annotations">
1297
<td class="parameter_name"><p>state</p></td>
1298
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</p></td>
1299
<td class="parameter_annotations"> </td>
1302
<td class="parameter_name"><p>source_state_name</p></td>
1303
<td class="parameter_description"><p>the name of a source state</p></td>
1304
<td class="parameter_annotations"> </td>
1307
<td class="parameter_name"><p>target_state_name</p></td>
1308
<td class="parameter_description"><p>the name of a target state</p></td>
1309
<td class="parameter_annotations"> </td>
1312
<td class="parameter_name"><p>animator</p></td>
1313
<td class="parameter_description"><p> a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> instance, or <code class="literal">NULL</code> to
1314
unset an existing <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>. </p></td>
1315
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1320
<p class="since">Since 1.4</p>
1323
<div class="refsect2">
1324
<a name="clutter-state-get-animator"></a><h3>clutter_state_get_animator ()</h3>
1325
<pre class="programlisting"><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="returnvalue">ClutterAnimator</span></a> *
1326
clutter_state_get_animator (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
1327
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
1328
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>);</pre>
1329
<div class="warning">
1330
<p><code class="literal">clutter_state_get_animator</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
1331
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1332
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1334
<p>Retrieves the <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> that is being used for transitioning
1335
between the two states, if any has been set</p>
1336
<div class="refsect3">
1337
<a name="id-1.10.18.10.15.7"></a><h4>Parameters</h4>
1338
<div class="informaltable"><table width="100%" border="0">
1340
<col width="150px" class="parameters_name">
1341
<col class="parameters_description">
1342
<col width="200px" class="parameters_annotations">
1346
<td class="parameter_name"><p>state</p></td>
1347
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</p></td>
1348
<td class="parameter_annotations"> </td>
1351
<td class="parameter_name"><p>source_state_name</p></td>
1352
<td class="parameter_description"><p>the name of a source state</p></td>
1353
<td class="parameter_annotations"> </td>
1356
<td class="parameter_name"><p>target_state_name</p></td>
1357
<td class="parameter_description"><p>the name of a target state</p></td>
1358
<td class="parameter_annotations"> </td>
1363
<div class="refsect3">
1364
<a name="id-1.10.18.10.15.8"></a><h4>Returns</h4>
1365
<p> a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> instance, or <code class="literal">NULL</code>. </p>
1366
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
1368
<p class="since">Since 1.4</p>
1371
<div class="refsect2">
1372
<a name="clutter-state-key-get-source-state-name"></a><h3>clutter_state_key_get_source_state_name ()</h3>
1373
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
1374
clutter_state_key_get_source_state_name
1375
(<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
1376
<div class="warning">
1377
<p><code class="literal">clutter_state_key_get_source_state_name</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
1378
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1379
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1381
<p>Retrieves the name of the source state of the <em class="parameter"><code>state_key</code></em>
1383
<div class="refsect3">
1384
<a name="id-1.10.18.10.16.7"></a><h4>Parameters</h4>
1385
<div class="informaltable"><table width="100%" border="0">
1387
<col width="150px" class="parameters_name">
1388
<col class="parameters_description">
1389
<col width="200px" class="parameters_annotations">
1392
<td class="parameter_name"><p>state_key</p></td>
1393
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p></td>
1394
<td class="parameter_annotations"> </td>
1398
<div class="refsect3">
1399
<a name="id-1.10.18.10.16.8"></a><h4>Returns</h4>
1400
<p> the name of the source state for this key, or <code class="literal">NULL</code>
1195
1401
if this is the generic state key for the given property when
1196
1402
transitioning to the target state. The returned string is owned
1197
by the <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> and should never be modified or freed</td>
1403
by the <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> and should never be modified or freed</p>
1201
1406
<p class="since">Since 1.4</p>
1204
1409
<div class="refsect2">
1205
<a name="clutter-state-key-get-target-state-name"></a><h3>clutter_state_key_get_target_state_name ()</h3>
1206
<pre class="programlisting">const <span class="returnvalue">gchar</span> * clutter_state_key_get_target_state_name
1207
(<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
1208
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1209
<h3 class="title">Warning</h3>
1210
<p><code class="literal">clutter_state_key_get_target_state_name</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1410
<a name="clutter-state-key-get-target-state-name"></a><h3>clutter_state_key_get_target_state_name ()</h3>
1411
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
1412
clutter_state_key_get_target_state_name
1413
(<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
1414
<div class="warning">
1415
<p><code class="literal">clutter_state_key_get_target_state_name</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
1416
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1211
1417
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1214
Get the name of the source state this <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> contains,
1419
<p>Get the name of the source state this <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> contains,
1215
1420
or NULL if this is the generic state key for the given property
1216
when transitioning to the target state.
1218
<div class="variablelist"><table border="0" class="variablelist">
1220
<col align="left" valign="top">
1225
<td><p><span class="term"><em class="parameter"><code>state_key</code></em> :</span></p></td>
1226
<td>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a>
1230
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1231
<td>the name of the source state for this key, or NULL if
1232
the key is generic</td>
1236
<p class="since">Since 1.4</p>
1239
<div class="refsect2">
1240
<a name="clutter-state-key-get-object"></a><h3>clutter_state_key_get_object ()</h3>
1241
<pre class="programlisting"><span class="returnvalue">GObject</span> * clutter_state_key_get_object (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
1242
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1243
<h3 class="title">Warning</h3>
1244
<p><code class="literal">clutter_state_key_get_object</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1245
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1248
Retrieves the object instance this <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> applies to.
1250
<div class="variablelist"><table border="0" class="variablelist">
1252
<col align="left" valign="top">
1257
<td><p><span class="term"><em class="parameter"><code>state_key</code></em> :</span></p></td>
1258
<td>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a>
1262
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1263
<td>the object this state key applies to. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
1268
<p class="since">Since 1.4</p>
1271
<div class="refsect2">
1272
<a name="clutter-state-key-get-property-name"></a><h3>clutter_state_key_get_property_name ()</h3>
1273
<pre class="programlisting">const <span class="returnvalue">gchar</span> * clutter_state_key_get_property_name (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
1274
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1275
<h3 class="title">Warning</h3>
1276
<p><code class="literal">clutter_state_key_get_property_name</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1277
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1280
Retrieves the name of the property this <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> applies to
1282
<div class="variablelist"><table border="0" class="variablelist">
1284
<col align="left" valign="top">
1289
<td><p><span class="term"><em class="parameter"><code>state_key</code></em> :</span></p></td>
1290
<td>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a>
1294
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1295
<td>the name of the property. The returned string is owned
1296
by the <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> and should never be modified or freed</td>
1300
<p class="since">Since 1.4</p>
1303
<div class="refsect2">
1304
<a name="clutter-state-key-get-mode"></a><h3>clutter_state_key_get_mode ()</h3>
1305
<pre class="programlisting"><span class="returnvalue">gulong</span> clutter_state_key_get_mode (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
1306
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1307
<h3 class="title">Warning</h3>
1308
<p><code class="literal">clutter_state_key_get_mode</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1309
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1312
Retrieves the easing mode used for <em class="parameter"><code>state_key</code></em>.
1314
<div class="variablelist"><table border="0" class="variablelist">
1316
<col align="left" valign="top">
1321
<td><p><span class="term"><em class="parameter"><code>state_key</code></em> :</span></p></td>
1322
<td>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a>
1326
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1327
<td>the mode of a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a>
1332
<p class="since">Since 1.4</p>
1335
<div class="refsect2">
1336
<a name="clutter-state-key-get-value"></a><h3>clutter_state_key_get_value ()</h3>
1337
<pre class="programlisting"><span class="returnvalue">gboolean</span> clutter_state_key_get_value (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>,
1338
<em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
1339
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1340
<h3 class="title">Warning</h3>
1341
<p><code class="literal">clutter_state_key_get_value</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1342
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1345
Retrieves a copy of the value for a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a>.
1348
The <span class="type">GValue</span> needs to be already initialized for the value type
1421
when transitioning to the target state.</p>
1422
<div class="refsect3">
1423
<a name="id-1.10.18.10.17.7"></a><h4>Parameters</h4>
1424
<div class="informaltable"><table width="100%" border="0">
1426
<col width="150px" class="parameters_name">
1427
<col class="parameters_description">
1428
<col width="200px" class="parameters_annotations">
1431
<td class="parameter_name"><p>state_key</p></td>
1432
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p></td>
1433
<td class="parameter_annotations"> </td>
1437
<div class="refsect3">
1438
<a name="id-1.10.18.10.17.8"></a><h4>Returns</h4>
1439
<p> the name of the source state for this key, or NULL if
1440
the key is generic</p>
1443
<p class="since">Since 1.4</p>
1446
<div class="refsect2">
1447
<a name="clutter-state-key-get-object"></a><h3>clutter_state_key_get_object ()</h3>
1448
<pre class="programlisting"><span class="returnvalue">GObject</span> *
1449
clutter_state_key_get_object (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
1450
<div class="warning">
1451
<p><code class="literal">clutter_state_key_get_object</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
1452
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1453
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1455
<p>Retrieves the object instance this <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> applies to.</p>
1456
<div class="refsect3">
1457
<a name="id-1.10.18.10.18.7"></a><h4>Parameters</h4>
1458
<div class="informaltable"><table width="100%" border="0">
1460
<col width="150px" class="parameters_name">
1461
<col class="parameters_description">
1462
<col width="200px" class="parameters_annotations">
1465
<td class="parameter_name"><p>state_key</p></td>
1466
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p></td>
1467
<td class="parameter_annotations"> </td>
1471
<div class="refsect3">
1472
<a name="id-1.10.18.10.18.8"></a><h4>Returns</h4>
1473
<p> the object this state key applies to. </p>
1474
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
1476
<p class="since">Since 1.4</p>
1479
<div class="refsect2">
1480
<a name="clutter-state-key-get-property-name"></a><h3>clutter_state_key_get_property_name ()</h3>
1481
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
1482
clutter_state_key_get_property_name (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
1483
<div class="warning">
1484
<p><code class="literal">clutter_state_key_get_property_name</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
1485
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1486
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1488
<p>Retrieves the name of the property this <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> applies to</p>
1489
<div class="refsect3">
1490
<a name="id-1.10.18.10.19.7"></a><h4>Parameters</h4>
1491
<div class="informaltable"><table width="100%" border="0">
1493
<col width="150px" class="parameters_name">
1494
<col class="parameters_description">
1495
<col width="200px" class="parameters_annotations">
1498
<td class="parameter_name"><p>state_key</p></td>
1499
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p></td>
1500
<td class="parameter_annotations"> </td>
1504
<div class="refsect3">
1505
<a name="id-1.10.18.10.19.8"></a><h4>Returns</h4>
1506
<p> the name of the property. The returned string is owned
1507
by the <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> and should never be modified or freed</p>
1510
<p class="since">Since 1.4</p>
1513
<div class="refsect2">
1514
<a name="clutter-state-key-get-mode"></a><h3>clutter_state_key_get_mode ()</h3>
1515
<pre class="programlisting"><span class="returnvalue">gulong</span>
1516
clutter_state_key_get_mode (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
1517
<div class="warning">
1518
<p><code class="literal">clutter_state_key_get_mode</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
1519
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1520
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1522
<p>Retrieves the easing mode used for <em class="parameter"><code>state_key</code></em>
1524
<div class="refsect3">
1525
<a name="id-1.10.18.10.20.7"></a><h4>Parameters</h4>
1526
<div class="informaltable"><table width="100%" border="0">
1528
<col width="150px" class="parameters_name">
1529
<col class="parameters_description">
1530
<col width="200px" class="parameters_annotations">
1533
<td class="parameter_name"><p>state_key</p></td>
1534
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p></td>
1535
<td class="parameter_annotations"> </td>
1539
<div class="refsect3">
1540
<a name="id-1.10.18.10.20.8"></a><h4>Returns</h4>
1541
<p> the mode of a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p>
1544
<p class="since">Since 1.4</p>
1547
<div class="refsect2">
1548
<a name="clutter-state-key-get-value"></a><h3>clutter_state_key_get_value ()</h3>
1549
<pre class="programlisting"><span class="returnvalue">gboolean</span>
1550
clutter_state_key_get_value (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>,
1551
<em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
1552
<div class="warning">
1553
<p><code class="literal">clutter_state_key_get_value</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
1554
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1555
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1557
<p>Retrieves a copy of the value for a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a>.</p>
1558
<p>The <span class="type">GValue</span> needs to be already initialized for the value type
1349
1559
of the property or to a type that allow transformation from the value
1353
Use <code class="function">g_value_unset()</code> when done.
1355
<div class="variablelist"><table border="0" class="variablelist">
1357
<col align="left" valign="top">
1362
<td><p><span class="term"><em class="parameter"><code>state_key</code></em> :</span></p></td>
1363
<td>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a>
1367
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
1368
<td>a <span class="type">GValue</span> initialized with the correct type for the <em class="parameter"><code>state_key</code></em>
1372
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1374
<code class="literal">TRUE</code> if the value was successfully retrieved,
1375
and <code class="literal">FALSE</code> otherwise</td>
1379
<p class="since">Since 1.4</p>
1382
<div class="refsect2">
1383
<a name="clutter-state-key-get-property-type"></a><h3>clutter_state_key_get_property_type ()</h3>
1384
<pre class="programlisting"><span class="returnvalue">GType</span> clutter_state_key_get_property_type (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *key</code></em>);</pre>
1385
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1386
<h3 class="title">Warning</h3>
1387
<p><code class="literal">clutter_state_key_get_property_type</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1388
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1391
Retrieves the <span class="type">GType</span> of the property a key applies to
1394
You can use this type to initialize the <span class="type">GValue</span> to pass to
1395
<a class="link" href="ClutterState.html#clutter-state-key-get-value" title="clutter_state_key_get_value ()"><code class="function">clutter_state_key_get_value()</code></a>
1397
<div class="variablelist"><table border="0" class="variablelist">
1399
<col align="left" valign="top">
1404
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1405
<td>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a>
1409
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1410
<td>the <span class="type">GType</span> of the property</td>
1414
<p class="since">Since 1.4</p>
1417
<div class="refsect2">
1418
<a name="clutter-state-key-get-pre-delay"></a><h3>clutter_state_key_get_pre_delay ()</h3>
1419
<pre class="programlisting"><span class="returnvalue">gdouble</span> clutter_state_key_get_pre_delay (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
1420
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1421
<h3 class="title">Warning</h3>
1422
<p><code class="literal">clutter_state_key_get_pre_delay</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1423
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1426
Retrieves the pause before transitioning starts as a fraction of
1427
the total transition time.
1429
<div class="variablelist"><table border="0" class="variablelist">
1431
<col align="left" valign="top">
1436
<td><p><span class="term"><em class="parameter"><code>state_key</code></em> :</span></p></td>
1437
<td>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a>
1441
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1442
<td>the pre delay used before starting the transition.</td>
1446
<p class="since">Since 1.4</p>
1449
<div class="refsect2">
1450
<a name="clutter-state-key-get-post-delay"></a><h3>clutter_state_key_get_post_delay ()</h3>
1451
<pre class="programlisting"><span class="returnvalue">gdouble</span> clutter_state_key_get_post_delay (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
1452
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1453
<h3 class="title">Warning</h3>
1454
<p><code class="literal">clutter_state_key_get_post_delay</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1455
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1458
Retrieves the duration of the pause after transitioning is complete
1459
as a fraction of the total transition time.
1461
<div class="variablelist"><table border="0" class="variablelist">
1463
<col align="left" valign="top">
1468
<td><p><span class="term"><em class="parameter"><code>state_key</code></em> :</span></p></td>
1469
<td>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a>
1473
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1474
<td>the post delay, used after doing the transition.</td>
1560
type of the key.</p>
1561
<p>Use <code class="function">g_value_unset()</code> when done.</p>
1562
<div class="refsect3">
1563
<a name="id-1.10.18.10.21.9"></a><h4>Parameters</h4>
1564
<div class="informaltable"><table width="100%" border="0">
1566
<col width="150px" class="parameters_name">
1567
<col class="parameters_description">
1568
<col width="200px" class="parameters_annotations">
1572
<td class="parameter_name"><p>state_key</p></td>
1573
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p></td>
1574
<td class="parameter_annotations"> </td>
1577
<td class="parameter_name"><p>value</p></td>
1578
<td class="parameter_description"><p>a <span class="type">GValue</span> initialized with the correct type for the <em class="parameter"><code>state_key</code></em>
1580
<td class="parameter_annotations"> </td>
1585
<div class="refsect3">
1586
<a name="id-1.10.18.10.21.10"></a><h4>Returns</h4>
1587
<p> <code class="literal">TRUE</code> if the value was successfully retrieved,
1588
and <code class="literal">FALSE</code> otherwise</p>
1591
<p class="since">Since 1.4</p>
1594
<div class="refsect2">
1595
<a name="clutter-state-key-get-property-type"></a><h3>clutter_state_key_get_property_type ()</h3>
1596
<pre class="programlisting"><span class="returnvalue">GType</span>
1597
clutter_state_key_get_property_type (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *key</code></em>);</pre>
1598
<div class="warning">
1599
<p><code class="literal">clutter_state_key_get_property_type</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
1600
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1601
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1603
<p>Retrieves the <span class="type">GType</span> of the property a key applies to</p>
1604
<p>You can use this type to initialize the <span class="type">GValue</span> to pass to
1605
<a class="link" href="ClutterState.html#clutter-state-key-get-value" title="clutter_state_key_get_value ()"><code class="function">clutter_state_key_get_value()</code></a></p>
1606
<div class="refsect3">
1607
<a name="id-1.10.18.10.22.8"></a><h4>Parameters</h4>
1608
<div class="informaltable"><table width="100%" border="0">
1610
<col width="150px" class="parameters_name">
1611
<col class="parameters_description">
1612
<col width="200px" class="parameters_annotations">
1615
<td class="parameter_name"><p>key</p></td>
1616
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p></td>
1617
<td class="parameter_annotations"> </td>
1621
<div class="refsect3">
1622
<a name="id-1.10.18.10.22.9"></a><h4>Returns</h4>
1623
<p> the <span class="type">GType</span> of the property</p>
1626
<p class="since">Since 1.4</p>
1629
<div class="refsect2">
1630
<a name="clutter-state-key-get-pre-delay"></a><h3>clutter_state_key_get_pre_delay ()</h3>
1631
<pre class="programlisting"><span class="returnvalue">gdouble</span>
1632
clutter_state_key_get_pre_delay (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
1633
<div class="warning">
1634
<p><code class="literal">clutter_state_key_get_pre_delay</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
1635
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1636
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1638
<p>Retrieves the pause before transitioning starts as a fraction of
1639
the total transition time.</p>
1640
<div class="refsect3">
1641
<a name="id-1.10.18.10.23.7"></a><h4>Parameters</h4>
1642
<div class="informaltable"><table width="100%" border="0">
1644
<col width="150px" class="parameters_name">
1645
<col class="parameters_description">
1646
<col width="200px" class="parameters_annotations">
1649
<td class="parameter_name"><p>state_key</p></td>
1650
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p></td>
1651
<td class="parameter_annotations"> </td>
1655
<div class="refsect3">
1656
<a name="id-1.10.18.10.23.8"></a><h4>Returns</h4>
1657
<p> the pre delay used before starting the transition.</p>
1660
<p class="since">Since 1.4</p>
1663
<div class="refsect2">
1664
<a name="clutter-state-key-get-post-delay"></a><h3>clutter_state_key_get_post_delay ()</h3>
1665
<pre class="programlisting"><span class="returnvalue">gdouble</span>
1666
clutter_state_key_get_post_delay (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
1667
<div class="warning">
1668
<p><code class="literal">clutter_state_key_get_post_delay</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
1669
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1670
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1672
<p>Retrieves the duration of the pause after transitioning is complete
1673
as a fraction of the total transition time.</p>
1674
<div class="refsect3">
1675
<a name="id-1.10.18.10.24.7"></a><h4>Parameters</h4>
1676
<div class="informaltable"><table width="100%" border="0">
1678
<col width="150px" class="parameters_name">
1679
<col class="parameters_description">
1680
<col width="200px" class="parameters_annotations">
1683
<td class="parameter_name"><p>state_key</p></td>
1684
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p></td>
1685
<td class="parameter_annotations"> </td>
1689
<div class="refsect3">
1690
<a name="id-1.10.18.10.24.8"></a><h4>Returns</h4>
1691
<p> the post delay, used after doing the transition.</p>
1694
<p class="since">Since 1.4</p>
1697
<div class="refsect1">
1698
<a name="ClutterState.other_details"></a><h2>Types and Values</h2>
1699
<div class="refsect2">
1700
<a name="ClutterState-struct"></a><h3>ClutterState</h3>
1701
<pre class="programlisting">typedef struct _ClutterState ClutterState;</pre>
1702
<p>The <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> structure contains only
1703
private data and should be accessed using the provided API</p>
1704
<p class="since">Since 1.4</p>
1707
<div class="refsect2">
1708
<a name="ClutterStateClass"></a><h3>struct ClutterStateClass</h3>
1709
<pre class="programlisting">struct ClutterStateClass {
1710
void (* completed) (ClutterState *state);
1713
<div class="warning"><p><code class="literal">ClutterStateClass</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p></div>
1714
<p>The <a class="link" href="ClutterState.html#ClutterStateClass" title="struct ClutterStateClass"><span class="type">ClutterStateClass</span></a> structure contains
1715
only private data</p>
1716
<div class="refsect3">
1717
<a name="id-1.10.18.11.3.7"></a><h4>Members</h4>
1718
<div class="informaltable"><table width="100%" border="0">
1720
<col width="300px" class="struct_members_name">
1721
<col class="struct_members_description">
1722
<col width="200px" class="struct_members_annotations">
1725
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterStateClass.completed"></a>completed</code></em> ()</p></td>
1726
<td class="struct_member_description"><p>class handler for the <a class="link" href="ClutterState.html#ClutterState-completed" title="The “completed” signal"><span class="type">“completed”</span></a> signal</p></td>
1727
<td class="struct_member_annotations"> </td>
1731
<p class="since">Since 1.4</p>
1734
<div class="refsect2">
1735
<a name="ClutterStateKey"></a><h3>ClutterStateKey</h3>
1736
<pre class="programlisting">typedef struct _ClutterStateKey ClutterStateKey;</pre>
1737
<p><a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> is an opaque structure whose
1738
members cannot be accessed directly</p>
1478
1739
<p class="since">Since 1.4</p>
1481
1742
<div class="refsect1">
1482
1743
<a name="ClutterState.property-details"></a><h2>Property Details</h2>
1483
1744
<div class="refsect2">
1484
<a name="ClutterState--duration"></a><h3>The <code class="literal">"duration"</code> property</h3>
1485
<pre class="programlisting"> "duration" <span class="type">guint</span> : Read / Write</pre>
1486
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1487
<h3 class="title">Warning</h3>
1488
<p><code class="literal">ClutterState:duration</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1745
<a name="ClutterState--duration"></a><h3>The <code class="literal">“duration”</code> property</h3>
1746
<pre class="programlisting"> “duration” <span class="type">guint</span></pre>
1747
<p>Default duration used if an duration has not been specified for a specific
1748
source/target state pair. The values is in milliseconds.</p>
1749
<div class="warning">
1750
<p><code class="literal">ClutterState:duration</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
1751
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1489
1752
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1492
Default duration used if an duration has not been specified for a specific
1493
source/target state pair. The values is in milliseconds.
1754
<p>Flags: Read / Write</p>
1495
1755
<p>Allowed values: <= 86400000</p>
1496
1756
<p>Default value: 1000</p>
1497
1757
<p class="since">Since 1.4</p>
1500
1760
<div class="refsect2">
1501
<a name="ClutterState--state"></a><h3>The <code class="literal">"state"</code> property</h3>
1502
<pre class="programlisting"> "state" <span class="type">gchar</span>* : Read / Write</pre>
1503
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1504
<h3 class="title">Warning</h3>
1505
<p><code class="literal">ClutterState:state</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1506
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1509
The currently set target state, setting it causes the
1761
<a name="ClutterState--state"></a><h3>The <code class="literal">“state”</code> property</h3>
1762
<pre class="programlisting"> “state” <span class="type">gchar</span> *</pre>
1763
<p>The currently set target state, setting it causes the
1510
1764
state machine to transition to the new state, use
1511
<a class="link" href="ClutterState.html#clutter-state-warp-to-state" title="clutter_state_warp_to_state ()"><code class="function">clutter_state_warp_to_state()</code></a> to change state without
1765
<a class="link" href="ClutterState.html#clutter-state-warp-to-state" title="clutter_state_warp_to_state ()"><code class="function">clutter_state_warp_to_state()</code></a> to change state without
1767
<div class="warning">
1768
<p><code class="literal">ClutterState:state</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
1769
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
1770
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
1772
<p>Flags: Read / Write</p>
1514
1773
<p>Default value: NULL</p>
1515
1774
<p class="since">Since 1.4</p>
added
removed
doc/reference/clutter/html/ClutterState.html
