5
5
<title>ClutterScript</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Clutter Reference Manual">
8
<link rel="up" href="ch08.html" title="User interface definition">
9
<link rel="prev" href="ch08.html" title="User interface definition">
8
<link rel="up" href="ch09.html" title="User interface definition">
9
<link rel="prev" href="ch09.html" title="User interface definition">
10
10
<link rel="next" href="ClutterScriptable.html" title="ClutterScriptable">
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="clutter-overview.html" title="Part I. Overview">
14
<link rel="part" href="building-clutter.html" title="Part II. Building Clutter">
15
<link rel="part" href="running-clutter.html" title="Part III. Running Clutter">
16
<link rel="part" href="clutterbase.html" title="Part IV. Clutter Core Reference">
17
<link rel="chapter" href="ch01.html" title="Abstract classes and interfaces">
18
<link rel="chapter" href="ch02.html" title="Base actors">
19
<link rel="chapter" href="ch03.html" title="Container actors">
20
<link rel="part" href="clutteranimation.html" title="Part V. Clutter Animation Framework">
21
<link rel="chapter" href="ch04.html" title="Base classes">
22
<link rel="chapter" href="ch05.html" title="Behaviours">
23
<link rel="chapter" href="ch06.html" title="High Level API">
24
<link rel="part" href="cluttertools.html" title="Part VI. Clutter Tools">
25
<link rel="chapter" href="ch07.html" title="General purpose API">
26
<link rel="chapter" href="ch08.html" title="User interface definition">
27
<link rel="chapter" href="ch09.html" title="Generic list model">
28
<link rel="part" href="clutterbackends.html" title="Part VII. Clutter Backends">
29
<link rel="part" href="additionaldocs.html" title="Part VIII. Additional Documentation">
30
<link rel="chapter" href="clutter-subclassing-ClutterActor.html" title="Implementing a new actor">
31
<link rel="chapter" href="clutter-animations.html" title="Creating Animations with Clutter">
32
<link rel="chapter" href="creating-your-own-behaviours.html" title="Creating You Own Behaviours">
33
<link rel="part" href="migration.html" title="Part IX. Migrating from previous version of Clutter">
34
<link rel="part" href="pt10.html" title="Part I. ">
35
<link rel="chapter" href="migrating-ClutterEffect.html" title="Migrating from ClutterEffect">
36
<link rel="chapter" href="migrating-ClutterPath.html" title="Migrating to ClutterPath">
37
<link rel="part" href="clutterobjects.html" title="Part X. Clutter Actors and Objects">
38
<link rel="chapter" href="clutterobjecthierarchy.html" title="Object Hierarchy">
39
<link rel="chapter" href="clutterobjectindex.html" title="Object Index">
40
<link rel="part" href="clutterglossary.html" title="Part XI. Glossaries">
41
<link rel="glossary" href="go01.html" title="Glossary">
42
<link rel="glossary" href="annotation-glossary.html" title="Annotation Glossary">
43
<link rel="index" href="ix01.html" title="Index of all symbols">
44
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
45
<link rel="index" href="ix03.html" title="Index of new symbols in 0.2">
46
<link rel="index" href="ix04.html" title="Index of new symbols in 0.4">
47
<link rel="index" href="ix05.html" title="Index of new symbols in 0.6">
48
<link rel="index" href="ix06.html" title="Index of new symbols in 0.8">
49
<link rel="index" href="ix07.html" title="Index of new symbols in 1.0">
50
<link rel="appendix" href="license.html" title="Appendix A. License">
52
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
53
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
54
16
<tr valign="middle">
55
<td><a accesskey="p" href="ch08.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
56
<td><a accesskey="u" href="ch08.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
17
<td><a accesskey="p" href="ch09.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="ch09.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
57
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
58
20
<th width="100%" align="center">Clutter Reference Manual</th>
59
21
<td><a accesskey="n" href="ClutterScriptable.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
61
23
<tr><td colspan="5" class="shortcuts">
62
24
<a href="#ClutterScript.synopsis" class="shortcut">Top</a>
64
<a href="#ClutterScript.description" class="shortcut">Description</a>
66
<a href="#ClutterScript.object-hierarchy" class="shortcut">Object Hierarchy</a>
68
<a href="#ClutterScript.properties" class="shortcut">Properties</a>
26
<a href="#ClutterScript.description" class="shortcut">Description</a>
28
<a href="#ClutterScript.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#ClutterScript.properties" class="shortcut">Properties</a>
71
33
<div class="refentry" title="ClutterScript">
79
41
</tr></table></div>
80
42
<div class="refsynopsisdiv" title="Synopsis">
81
43
<a name="ClutterScript.synopsis"></a><h2>Synopsis</h2>
82
<pre class="synopsis">
83
<a class="link" href="ClutterScript.html#ClutterScript-struct" title="ClutterScript">ClutterScript</a>;
44
<pre class="synopsis"> <a class="link" href="ClutterScript.html#ClutterScript-struct" title="ClutterScript">ClutterScript</a>;
84
45
<a class="link" href="ClutterScript.html#ClutterScriptClass" title="ClutterScriptClass">ClutterScriptClass</a>;
85
<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> * <a class="link" href="ClutterScript.html#clutter-script-new" title="clutter_script_new ()">clutter_script_new</a> (void);
46
<a class="link" href="ClutterScript.html" title="ClutterScript"><span class="returnvalue">ClutterScript</span></a> * <a class="link" href="ClutterScript.html#clutter-script-new" title="clutter_script_new ()">clutter_script_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
86
47
enum <a class="link" href="ClutterScript.html#ClutterScriptError" title="enum ClutterScriptError">ClutterScriptError</a>;
88
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
89
>guint</a> <a class="link" href="ClutterScript.html#clutter-script-load-from-data" title="clutter_script_load_from_data ()">clutter_script_load_from_data</a> (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
91
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
94
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize"
97
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
100
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
101
>guint</a> <a class="link" href="ClutterScript.html#clutter-script-load-from-file" title="clutter_script_load_from_file ()">clutter_script_load_from_file</a> (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
103
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
104
>gchar</a> *filename,
106
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
107
>GError</a> **error);
108
void <a class="link" href="ClutterScript.html#clutter-script-add-search-paths" title="clutter_script_add_search_paths ()">clutter_script_add_search_paths</a> (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
110
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
111
>gchar</a> * const paths[],
113
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize"
116
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
117
>gchar</a> * <a class="link" href="ClutterScript.html#clutter-script-lookup-filename" title="clutter_script_lookup_filename ()">clutter_script_lookup_filename</a> (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
119
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
120
>gchar</a> *filename);
123
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
124
>GObject</a> * <a class="link" href="ClutterScript.html#clutter-script-get-object" title="clutter_script_get_object ()">clutter_script_get_object</a> (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
126
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
129
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
130
>gint</a> <a class="link" href="ClutterScript.html#clutter-script-get-objects" title="clutter_script_get_objects ()">clutter_script_get_objects</a> (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
132
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
133
>gchar</a> *first_name,
135
void <a class="link" href="ClutterScript.html#clutter-script-unmerge-objects" title="clutter_script_unmerge_objects ()">clutter_script_unmerge_objects</a> (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
137
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
138
>guint</a> merge_id);
139
void <a class="link" href="ClutterScript.html#clutter-script-ensure-objects" title="clutter_script_ensure_objects ()">clutter_script_ensure_objects</a> (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script);
141
href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
142
>GList</a> * <a class="link" href="ClutterScript.html#clutter-script-list-objects" title="clutter_script_list_objects ()">clutter_script_list_objects</a> (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script);
144
void (<a class="link" href="ClutterScript.html#ClutterScriptConnectFunc" title="ClutterScriptConnectFunc ()">*ClutterScriptConnectFunc</a>) (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
146
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
147
>GObject</a> *object,
149
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
150
>gchar</a> *signal_name,
152
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
153
>gchar</a> *handler_name,
155
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
156
>GObject</a> *connect_object,
158
href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#GConnectFlags"
159
>GConnectFlags</a> flags,
161
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
162
>gpointer</a> user_data);
163
void <a class="link" href="ClutterScript.html#clutter-script-connect-signals" title="clutter_script_connect_signals ()">clutter_script_connect_signals</a> (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
165
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
166
>gpointer</a> user_data);
167
void <a class="link" href="ClutterScript.html#clutter-script-connect-signals-full" title="clutter_script_connect_signals_full ()">clutter_script_connect_signals_full</a> (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
168
<a class="link" href="ClutterScript.html#ClutterScriptConnectFunc" title="ClutterScriptConnectFunc ()">ClutterScriptConnectFunc</a> func,
170
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
171
>gpointer</a> user_data);
174
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
175
>GType</a> <a class="link" href="ClutterScript.html#clutter-script-get-type-from-name" title="clutter_script_get_type_from_name ()">clutter_script_get_type_from_name</a> (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
177
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
178
>gchar</a> *type_name);
180
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
181
>gchar</a> * <a class="link" href="ClutterScript.html#clutter-get-script-id" title="clutter_get_script_id ()">clutter_get_script_id</a> (<a
182
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
183
>GObject</a> *gobject);
48
<span class="returnvalue">guint</span> <a class="link" href="ClutterScript.html#clutter-script-load-from-data" title="clutter_script_load_from_data ()">clutter_script_load_from_data</a> (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
49
<em class="parameter"><code>const <span class="type">gchar</span> *data</code></em>,
50
<em class="parameter"><code><span class="type">gssize</span> length</code></em>,
51
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
52
<span class="returnvalue">guint</span> <a class="link" href="ClutterScript.html#clutter-script-load-from-file" title="clutter_script_load_from_file ()">clutter_script_load_from_file</a> (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
53
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
54
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
55
<span class="returnvalue">void</span> <a class="link" href="ClutterScript.html#clutter-script-add-search-paths" title="clutter_script_add_search_paths ()">clutter_script_add_search_paths</a> (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
56
<em class="parameter"><code>const <span class="type">gchar</span> * const paths[]</code></em>,
57
<em class="parameter"><code><span class="type">gsize</span> n_paths</code></em>);
58
<span class="returnvalue">gchar</span> * <a class="link" href="ClutterScript.html#clutter-script-lookup-filename" title="clutter_script_lookup_filename ()">clutter_script_lookup_filename</a> (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
59
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);
61
<span class="returnvalue">GObject</span> * <a class="link" href="ClutterScript.html#clutter-script-get-object" title="clutter_script_get_object ()">clutter_script_get_object</a> (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
62
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
63
<span class="returnvalue">gint</span> <a class="link" href="ClutterScript.html#clutter-script-get-objects" title="clutter_script_get_objects ()">clutter_script_get_objects</a> (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
64
<em class="parameter"><code>const <span class="type">gchar</span> *first_name</code></em>,
65
<em class="parameter"><code>...</code></em>);
66
<span class="returnvalue">void</span> <a class="link" href="ClutterScript.html#clutter-script-unmerge-objects" title="clutter_script_unmerge_objects ()">clutter_script_unmerge_objects</a> (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
67
<em class="parameter"><code><span class="type">guint</span> merge_id</code></em>);
68
<span class="returnvalue">void</span> <a class="link" href="ClutterScript.html#clutter-script-ensure-objects" title="clutter_script_ensure_objects ()">clutter_script_ensure_objects</a> (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>);
69
<span class="returnvalue">GList</span> * <a class="link" href="ClutterScript.html#clutter-script-list-objects" title="clutter_script_list_objects ()">clutter_script_list_objects</a> (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>);
71
<span class="returnvalue">void</span> (<a class="link" href="ClutterScript.html#ClutterScriptConnectFunc" title="ClutterScriptConnectFunc ()">*ClutterScriptConnectFunc</a>) (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
72
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
73
<em class="parameter"><code>const <span class="type">gchar</span> *signal_name</code></em>,
74
<em class="parameter"><code>const <span class="type">gchar</span> *handler_name</code></em>,
75
<em class="parameter"><code><span class="type">GObject</span> *connect_object</code></em>,
76
<em class="parameter"><code><span class="type">GConnectFlags</span> flags</code></em>,
77
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
78
<span class="returnvalue">void</span> <a class="link" href="ClutterScript.html#clutter-script-connect-signals" title="clutter_script_connect_signals ()">clutter_script_connect_signals</a> (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
79
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
80
<span class="returnvalue">void</span> <a class="link" href="ClutterScript.html#clutter-script-connect-signals-full" title="clutter_script_connect_signals_full ()">clutter_script_connect_signals_full</a> (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
81
<em class="parameter"><code><a class="link" href="ClutterScript.html#ClutterScriptConnectFunc" title="ClutterScriptConnectFunc ()"><span class="type">ClutterScriptConnectFunc</span></a> func</code></em>,
82
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
84
<span class="returnvalue">GType</span> <a class="link" href="ClutterScript.html#clutter-script-get-type-from-name" title="clutter_script_get_type_from_name ()">clutter_script_get_type_from_name</a> (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
85
<em class="parameter"><code>const <span class="type">gchar</span> *type_name</code></em>);
86
const <span class="returnvalue">gchar</span> * <a class="link" href="ClutterScript.html#clutter-get-script-id" title="clutter_get_script_id ()">clutter_get_script_id</a> (<em class="parameter"><code><span class="type">GObject</span> *gobject</code></em>);
186
89
<div class="refsect1" title="Object Hierarchy">
187
90
<a name="ClutterScript.object-hierarchy"></a><h2>Object Hierarchy</h2>
188
91
<pre class="synopsis">
190
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
192
93
+----ClutterScript
195
96
<div class="refsect1" title="Properties">
196
97
<a name="ClutterScript.properties"></a><h2>Properties</h2>
197
98
<pre class="synopsis">
198
"<a class="link" href="ClutterScript.html#ClutterScript--filename" title='The "filename" property'>filename</a>" <a
199
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
201
"<a class="link" href="ClutterScript.html#ClutterScript--filename-set" title='The "filename-set" property'>filename-set</a>" <a
202
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
99
"<a class="link" href="ClutterScript.html#ClutterScript--filename" title='The "filename" property'>filename</a>" <span class="type">gchar</span>* : Read
100
"<a class="link" href="ClutterScript.html#ClutterScript--filename-set" title='The "filename-set" property'>filename-set</a>" <span class="type">gboolean</span> : Read
206
103
<div class="refsect1" title="Description">
298
<div class="informalexample"><pre class="programlisting">
300
"id" : "my-rotating-actor",
301
"type" : "ClutterTexture",
303
"behaviours" : [ "rotate-behaviour" ]
235
<div class="informalexample">
236
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
239
<td class="listing_lines" align="right"><pre>1
245
<td class="listing_code"><pre class="programlisting"><span class="cbracket">{</span>
246
<span class="normal"> </span><span class="string">"id"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"my-rotating-actor"</span><span class="symbol">,</span>
247
<span class="normal"> </span><span class="string">"type"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"ClutterTexture"</span><span class="symbol">,</span>
248
<span class="normal"> </span><span class="symbol">...</span>
249
<span class="normal"> </span><span class="string">"behaviours"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="symbol">[</span><span class="normal"> </span><span class="string">"rotate-behaviour"</span><span class="normal"> </span><span class="symbol">]</span>
250
<span class="cbracket">}</span></pre></td>
309
259
A <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> belonging to a <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a> can only be defined
310
implicitely. A <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> belonging to a <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> can be
311
either defined implicitely or explicitely. Implicitely defined
312
<a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a>s and <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>s can omit the
313
<code class="varname">id</code> member, as well as the <code class="varname">type</code> member,
314
but will not be available using <a class="link" href="ClutterScript.html#clutter-script-get-object" title="clutter_script_get_object ()"><code class="function">clutter_script_get_object()</code></a> (they can,
315
however, be extracted using the <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a> and <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a>
260
implicitly like in the example above, or explicitly by setting the
261
"alpha" property to point to a previously defined <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a>, e.g.:
265
<div class="informalexample">
266
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
269
<td class="listing_lines" align="right"><pre>1
287
<td class="listing_code"><pre class="programlisting"><span class="cbracket">{</span>
288
<span class="normal"> </span><span class="string">"id"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"rotate-behaviour"</span><span class="symbol">,</span>
289
<span class="normal"> </span><span class="string">"type"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"ClutterBehaviourRotate"</span><span class="symbol">,</span>
290
<span class="normal"> </span><span class="string">"angle-start"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="number">0.0</span><span class="symbol">,</span>
291
<span class="normal"> </span><span class="string">"angle-end"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="number">360.0</span><span class="symbol">,</span>
292
<span class="normal"> </span><span class="string">"axis"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"z-axis"</span><span class="symbol">,</span>
293
<span class="normal"> </span><span class="string">"alpha"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="cbracket">{</span>
294
<span class="normal"> </span><span class="string">"id"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"rotate-alpha"</span><span class="symbol">,</span>
295
<span class="normal"> </span><span class="string">"type"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"ClutterAlpha"</span><span class="symbol">,</span>
296
<span class="normal"> </span><span class="string">"timeline"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="cbracket">{</span>
297
<span class="normal"> </span><span class="string">"id"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"rotate-timeline"</span><span class="symbol">,</span>
298
<span class="normal"> </span><span class="string">"type : "</span><span class="normal"><a href="ClutterTimeline.html">ClutterTimeline</a></span><span class="string">",</span>
299
<span class="string"> "</span><span class="normal">duration</span><span class="string">" : 4000,</span>
300
<span class="string"> "</span><span class="normal">loop</span><span class="string">" : true</span>
301
<span class="string"> },</span>
302
<span class="string"> "</span><span class="normal">function</span><span class="string">" : "</span><span class="normal">custom_sine_alpha</span><span class="string">"</span>
303
<span class="string"> }</span>
304
<span class="string">}</span></pre></td>
313
Implicitely defined <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a>s and <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>s
314
can omit the <code class="varname">id</code> member, as well as the
315
<code class="varname">type</code> member, but will not be available using
316
<a class="link" href="ClutterScript.html#clutter-script-get-object" title="clutter_script_get_object ()"><code class="function">clutter_script_get_object()</code></a> (they can, however, be extracted using the
317
<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a> and <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> API respectively).
319
320
Signal handlers can be defined inside a Clutter UI definition file and
482
483
<div class="refsect2" title="clutter_script_load_from_data ()">
483
484
<a name="clutter-script-load-from-data"></a><h3>clutter_script_load_from_data ()</h3>
484
<pre class="programlisting"><a
485
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
486
>guint</a> clutter_script_load_from_data (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
488
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
491
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize"
494
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
495
>GError</a> **error);</pre>
485
<pre class="programlisting"><span class="returnvalue">guint</span> clutter_script_load_from_data (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
486
<em class="parameter"><code>const <span class="type">gchar</span> *data</code></em>,
487
<em class="parameter"><code><span class="type">gssize</span> length</code></em>,
488
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
497
490
Loads the definitions from <em class="parameter"><code>data</code></em> into <em class="parameter"><code>script</code></em> and merges with
498
the currently loaded ones, if any.</p>
491
the currently loaded ones, if any.
501
493
<div class="variablelist"><table border="0">
502
494
<col align="left" valign="top">
505
497
<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
506
<td> a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
498
<td>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
510
502
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
511
<td> a buffer containing the definitions
503
<td>a buffer containing the definitions
515
507
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
516
<td> the length of the buffer, or -1 if <em class="parameter"><code>data</code></em> is a NUL-terminated
508
<td>the length of the buffer, or -1 if <em class="parameter"><code>data</code></em> is a NUL-terminated
521
513
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
522
<td> return location for a <a
523
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
524
><span class="type">GError</span></a>, or <a
525
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
526
><code class="literal">NULL</code></a>
514
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
542
530
<div class="refsect2" title="clutter_script_load_from_file ()">
543
531
<a name="clutter-script-load-from-file"></a><h3>clutter_script_load_from_file ()</h3>
544
<pre class="programlisting"><a
545
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
546
>guint</a> clutter_script_load_from_file (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
548
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
549
>gchar</a> *filename,
551
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
552
>GError</a> **error);</pre>
532
<pre class="programlisting"><span class="returnvalue">guint</span> clutter_script_load_from_file (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
533
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
534
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
554
536
Loads the definitions from <em class="parameter"><code>filename</code></em> into <em class="parameter"><code>script</code></em> and merges with
555
the currently loaded ones, if any.</p>
537
the currently loaded ones, if any.
558
539
<div class="variablelist"><table border="0">
559
540
<col align="left" valign="top">
562
543
<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
563
<td> a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
544
<td>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
567
548
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
568
<td> the full path to the definition file
549
<td>the full path to the definition file
572
553
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
573
<td> return location for a <a
574
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
575
><span class="type">GError</span></a>, or <a
576
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
577
><code class="literal">NULL</code></a>
554
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
593
570
<div class="refsect2" title="clutter_script_add_search_paths ()">
594
571
<a name="clutter-script-add-search-paths"></a><h3>clutter_script_add_search_paths ()</h3>
595
<pre class="programlisting">void clutter_script_add_search_paths (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
597
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
598
>gchar</a> * const paths[],
600
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize"
601
>gsize</a> n_paths);</pre>
572
<pre class="programlisting"><span class="returnvalue">void</span> clutter_script_add_search_paths (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
573
<em class="parameter"><code>const <span class="type">gchar</span> * const paths[]</code></em>,
574
<em class="parameter"><code><span class="type">gsize</span> n_paths</code></em>);</pre>
603
576
Adds <em class="parameter"><code>paths</code></em> to the list of search paths held by <em class="parameter"><code>script</code></em>.
606
579
The search paths are used by <a class="link" href="ClutterScript.html#clutter-script-lookup-filename" title="clutter_script_lookup_filename ()"><code class="function">clutter_script_lookup_filename()</code></a>, which
607
580
can be used to define search paths for the textures source file name
608
or other custom, file-based properties.</p>
581
or other custom, file-based properties.
611
583
<div class="variablelist"><table border="0">
612
584
<col align="left" valign="top">
615
587
<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
616
<td> a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
588
<td>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
620
592
<td><p><span class="term"><em class="parameter"><code>paths</code></em> :</span></p></td>
621
<td> an array of strings containing different search paths
593
<td>an array of strings containing different search paths
625
597
<td><p><span class="term"><em class="parameter"><code>n_paths</code></em> :</span></p></td>
626
<td> the length of the passed array
598
<td>the length of the passed array
634
606
<div class="refsect2" title="clutter_script_lookup_filename ()">
635
607
<a name="clutter-script-lookup-filename"></a><h3>clutter_script_lookup_filename ()</h3>
636
<pre class="programlisting"><a
637
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
638
>gchar</a> * clutter_script_lookup_filename (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
640
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
641
>gchar</a> *filename);</pre>
608
<pre class="programlisting"><span class="returnvalue">gchar</span> * clutter_script_lookup_filename (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
609
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
643
611
Looks up <em class="parameter"><code>filename</code></em> inside the search paths of <em class="parameter"><code>script</code></em>. If <em class="parameter"><code>filename</code></em>
644
is found, its full path will be returned .</p>
612
is found, its full path will be returned .
647
614
<div class="variablelist"><table border="0">
648
615
<col align="left" valign="top">
651
618
<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
652
<td> a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
619
<td>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
656
623
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
657
<td> the name of the file to lookup
624
<td>the name of the file to lookup
661
628
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
662
<td> the full path of <em class="parameter"><code>filename</code></em> or <a
663
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
664
><code class="literal">NULL</code></a> if no path was
629
<td> the full path of <em class="parameter"><code>filename</code></em> or <code class="literal">NULL</code> if no path was
709
671
<div class="refsect2" title="clutter_script_get_objects ()">
710
672
<a name="clutter-script-get-objects"></a><h3>clutter_script_get_objects ()</h3>
711
<pre class="programlisting"><a
712
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
713
>gint</a> clutter_script_get_objects (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
715
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
716
>gchar</a> *first_name,
673
<pre class="programlisting"><span class="returnvalue">gint</span> clutter_script_get_objects (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
674
<em class="parameter"><code>const <span class="type">gchar</span> *first_name</code></em>,
675
<em class="parameter"><code>...</code></em>);</pre>
719
677
Retrieves a list of objects for the given names. After <em class="parameter"><code>script</code></em>, object
720
names/return location pairs should be listed, with a <a
721
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
722
><code class="literal">NULL</code></a> pointer
678
names/return location pairs should be listed, with a <code class="literal">NULL</code> pointer
723
679
ending the list, like:
727
<div class="informalexample"><pre class="programlisting">
728
GObject *my_label, *a_button, *main_timeline;
730
clutter_script_get_objects (script,
731
"my-label", &my_label,
732
"a-button", &a_button,
733
"main-timeline", &main_timeline,
683
<div class="informalexample">
684
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
687
<td class="listing_lines" align="right"><pre>1
694
<td class="listing_code"><pre class="programlisting"><span class="normal">GObject </span><span class="symbol">*</span><span class="normal">my_label</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">a_button</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">main_timeline</span><span class="symbol">;</span>
696
<span class="function"><a href="ClutterScript.html#clutter-script-get-objects">clutter_script_get_objects</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">script</span><span class="symbol">,</span>
697
<span class="normal"> </span><span class="string">"my-label"</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">my_label</span><span class="symbol">,</span>
698
<span class="normal"> </span><span class="string">"a-button"</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">a_button</span><span class="symbol">,</span>
699
<span class="normal"> </span><span class="string">"main-timeline"</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">main_timeline</span><span class="symbol">,</span>
700
<span class="normal"> NULL</span><span class="symbol">);</span></pre></td>
739
709
Note: This function does not increment the reference count of the
740
returned objects.</p>
743
712
<div class="variablelist"><table border="0">
744
713
<col align="left" valign="top">
747
716
<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
748
<td> a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
717
<td>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
752
721
<td><p><span class="term"><em class="parameter"><code>first_name</code></em> :</span></p></td>
753
<td> the name of the first object to retrieve
722
<td>the name of the first object to retrieve
757
726
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
758
<td> return location for a <a
759
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
760
><span class="type">GObject</span></a>, then additional names, ending
762
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
763
><code class="literal">NULL</code></a>
727
<td>return location for a <span class="type">GObject</span>, then additional names, ending
728
with <code class="literal">NULL</code>
854
815
<div class="refsect2" title="ClutterScriptConnectFunc ()">
855
816
<a name="ClutterScriptConnectFunc"></a><h3>ClutterScriptConnectFunc ()</h3>
856
<pre class="programlisting">void (*ClutterScriptConnectFunc) (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
858
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
859
>GObject</a> *object,
861
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
862
>gchar</a> *signal_name,
864
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
865
>gchar</a> *handler_name,
867
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
868
>GObject</a> *connect_object,
870
href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#GConnectFlags"
871
>GConnectFlags</a> flags,
873
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
874
>gpointer</a> user_data);</pre>
817
<pre class="programlisting"><span class="returnvalue">void</span> (*ClutterScriptConnectFunc) (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
818
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
819
<em class="parameter"><code>const <span class="type">gchar</span> *signal_name</code></em>,
820
<em class="parameter"><code>const <span class="type">gchar</span> *handler_name</code></em>,
821
<em class="parameter"><code><span class="type">GObject</span> *connect_object</code></em>,
822
<em class="parameter"><code><span class="type">GConnectFlags</span> flags</code></em>,
823
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
876
825
This is the signature of a function used to connect signals. It is used
877
826
by the <a class="link" href="ClutterScript.html#clutter-script-connect-signals-full" title="clutter_script_connect_signals_full ()"><code class="function">clutter_script_connect_signals_full()</code></a> function. It is mainly
878
827
intended for interpreted language bindings, but could be useful where the
879
programmer wants more control over the signal connection process.</p>
828
programmer wants more control over the signal connection process.
882
830
<div class="variablelist"><table border="0">
883
831
<col align="left" valign="top">
886
834
<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
887
<td> a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
835
<td>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
891
839
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
892
<td> the object to connect
840
<td>the object to connect
896
844
<td><p><span class="term"><em class="parameter"><code>signal_name</code></em> :</span></p></td>
897
<td> the name of the signal
845
<td>the name of the signal
901
849
<td><p><span class="term"><em class="parameter"><code>handler_name</code></em> :</span></p></td>
902
<td> the name of the signal handler
850
<td>the name of the signal handler
906
854
<td><p><span class="term"><em class="parameter"><code>connect_object</code></em> :</span></p></td>
907
<td> the object to connect the signal to, or <a
908
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
909
><code class="literal">NULL</code></a>
855
<td>the object to connect the signal to, or <code class="literal">NULL</code>
913
859
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
914
<td> signal connection flags
860
<td>signal connection flags
918
864
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
919
<td> user data to pass to the signal handler
865
<td>user data to pass to the signal handler
927
873
<div class="refsect2" title="clutter_script_connect_signals ()">
928
874
<a name="clutter-script-connect-signals"></a><h3>clutter_script_connect_signals ()</h3>
929
<pre class="programlisting">void clutter_script_connect_signals (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
931
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
932
>gpointer</a> user_data);</pre>
875
<pre class="programlisting"><span class="returnvalue">void</span> clutter_script_connect_signals (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
876
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
934
878
Connects all the signals defined into a UI definition file to their
938
882
This method invokes <a class="link" href="ClutterScript.html#clutter-script-connect-signals-full" title="clutter_script_connect_signals_full ()"><code class="function">clutter_script_connect_signals_full()</code></a> internally
940
href="http://library.gnome.org/devel/glib/unstable/glib-Dynamic-Loading-of-Modules.html#GModule"
941
><span class="type">GModule</span></a>'s introspective features (by opening the current
883
and uses <span class="type">GModule</span>'s introspective features (by opening the current
942
884
module's scope) to look at the application's symbol table.
945
Note that this function will not work if <a
946
href="http://library.gnome.org/devel/glib/unstable/glib-Dynamic-Loading-of-Modules.html#GModule"
947
><span class="type">GModule</span></a> is not supported by
948
the platform Clutter is running on.</p>
887
Note that this function will not work if <span class="type">GModule</span> is not supported by
888
the platform Clutter is running on.
951
890
<div class="variablelist"><table border="0">
952
891
<col align="left" valign="top">
955
894
<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
956
<td> a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
895
<td>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
960
899
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
961
<td> data to be passed to the signal handlers, or <a
962
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
963
><code class="literal">NULL</code></a>
900
<td>data to be passed to the signal handlers, or <code class="literal">NULL</code>
1017
949
<div class="refsect2" title="clutter_script_get_type_from_name ()">
1018
950
<a name="clutter-script-get-type-from-name"></a><h3>clutter_script_get_type_from_name ()</h3>
1019
<pre class="programlisting"><a
1020
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
1021
>GType</a> clutter_script_get_type_from_name (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
1023
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1024
>gchar</a> *type_name);</pre>
951
<pre class="programlisting"><span class="returnvalue">GType</span> clutter_script_get_type_from_name (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
952
<em class="parameter"><code>const <span class="type">gchar</span> *type_name</code></em>);</pre>
1026
954
Looks up a type by name, using the virtual function that
1027
955
<a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> has for that purpose. This function should
1031
958
<div class="variablelist"><table border="0">
1032
959
<col align="left" valign="top">
1035
962
<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
1036
<td> a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
963
<td>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
1040
967
<td><p><span class="term"><em class="parameter"><code>type_name</code></em> :</span></p></td>
1041
<td> name of the type to look up
968
<td>name of the type to look up
1045
972
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1046
973
<td> the type for the requested type name, or
1048
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-INVALID--CAPS"
1049
><code class="literal">G_TYPE_INVALID</code></a> if not corresponding type was found.
974
<code class="literal">G_TYPE_INVALID</code> if not corresponding type was found.
1095
1011
<a name="ClutterScript.property-details"></a><h2>Property Details</h2>
1096
1012
<div class="refsect2" title='The "filename" property'>
1097
1013
<a name="ClutterScript--filename"></a><h3>The <code class="literal">"filename"</code> property</h3>
1098
<pre class="programlisting"> "filename" <a
1099
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1100
>gchar</a>* : Read</pre>
1102
The path of the currently parsed file. If ClutterScript:filename-set
1104
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
1105
><code class="literal">FALSE</code></a> then the value of this property is undefined.</p>
1014
<pre class="programlisting"> "filename" <span class="type">gchar</span>* : Read</pre>
1016
The path of the currently parsed file. If <a class="link" href="ClutterScript.html#ClutterScript--filename-set" title='The "filename-set" property'><span class="type">"filename-set"</span></a>
1017
is <code class="literal">FALSE</code> then the value of this property is undefined.
1108
1019
<p>Default value: NULL</p>
1020
<p class="since">Since 0.6</p>
1112
1023
<div class="refsect2" title='The "filename-set" property'>
1113
1024
<a name="ClutterScript--filename-set"></a><h3>The <code class="literal">"filename-set"</code> property</h3>
1114
<pre class="programlisting"> "filename-set" <a
1115
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1116
>gboolean</a> : Read</pre>
1118
Whether the ClutterScript:filename property is set. If this property
1120
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
1121
><code class="literal">TRUE</code></a> then the currently parsed data comes from a file, and the
1122
file name is stored inside the ClutterScript:filename property.</p>
1025
<pre class="programlisting"> "filename-set" <span class="type">gboolean</span> : Read</pre>
1027
Whether the <a class="link" href="ClutterScript.html#ClutterScript--filename" title='The "filename" property'><span class="type">"filename"</span></a> property is set. If this property
1028
is <code class="literal">TRUE</code> then the currently parsed data comes from a file, and the
1029
file name is stored inside the <a class="link" href="ClutterScript.html#ClutterScript--filename" title='The "filename" property'><span class="type">"filename"</span></a> property.
1125
1031
<p>Default value: FALSE</p>
1032
<p class="since">Since 0.6</p>
1130
1036
<div class="footer">
1132
Generated by GTK-Doc V1.11</div>
1038
Generated by GTK-Doc V1.15.1</div>
b'\\ No newline at end of file'