← Back to branch summary

~ubuntu-branches/ubuntu/vivid/clutter-1.0/vivid-proposed

« back to all changes in this revision

Viewing changes to doc/reference/clutter/html/ClutterScript.html

  • Committer: Bazaar Package Importer
  • Author(s): Emilio Pozuelo Monfort
  • Date: 2010-07-18 17:21:49 UTC
  • mfrom: (1.2.1 upstream) (4.1.3 experimental)
  • Revision ID: james.westby@ubuntu.com-20100718172149-j6s9u4chocaoykme
Tags: 1.2.12-1
* New upstream release.
* debian/libclutter-1.0-0.symbols,
  debian/rules:
  - Add a symbols file.
* debian/rules,
  debian/source/format:
  - Switch to source format 3.0 (quilt).
* debian/control.in:
  - Standards-Version is 3.9.0, no changes needed.
* Upload to unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/clutter/html/ClutterScript.html
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">
51
13
</head>
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>
60
22
</tr>
61
23
<tr><td colspan="5" class="shortcuts">
62
24
<a href="#ClutterScript.synopsis" class="shortcut">Top</a>
63
 
                 | 
64
 
                <a href="#ClutterScript.description" class="shortcut">Description</a>
65
 
                 | 
66
 
                <a href="#ClutterScript.object-hierarchy" class="shortcut">Object Hierarchy</a>
67
 
                 | 
68
 
                <a href="#ClutterScript.properties" class="shortcut">Properties</a>
 
25
                   | 
 
26
                  <a href="#ClutterScript.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#ClutterScript.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#ClutterScript.properties" class="shortcut">Properties</a>
69
31
</td></tr>
70
32
</table>
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>;
87
 
<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,
90
 
                                                         const <a
91
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
92
 
>gchar</a> *data,
93
 
                                                         <a
94
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize"
95
 
>gssize</a> length,
96
 
                                                         <a
97
 
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
98
 
>GError</a> **error);
99
 
<a
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,
102
 
                                                         const <a
103
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
104
 
>gchar</a> *filename,
105
 
                                                         <a
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,
109
 
                                                         const <a
110
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
111
 
>gchar</a> * const paths[],
112
 
                                                         <a
113
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize"
114
 
>gsize</a> n_paths);
115
 
<a
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,
118
 
                                                         const <a
119
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
120
 
>gchar</a> *filename);
121
 
 
122
 
<a
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,
125
 
                                                         const <a
126
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
127
 
>gchar</a> *name);
128
 
<a
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,
131
 
                                                         const <a
132
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
133
 
>gchar</a> *first_name,
134
 
                                                         ...);
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,
136
 
                                                         <a
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);
140
 
<a
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);
143
 
 
144
 
void                (<a class="link" href="ClutterScript.html#ClutterScriptConnectFunc" title="ClutterScriptConnectFunc ()">*ClutterScriptConnectFunc</a>)         (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
145
 
                                                         <a
146
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
147
 
>GObject</a> *object,
148
 
                                                         const <a
149
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
150
 
>gchar</a> *signal_name,
151
 
                                                         const <a
152
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
153
 
>gchar</a> *handler_name,
154
 
                                                         <a
155
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
156
 
>GObject</a> *connect_object,
157
 
                                                         <a
158
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#GConnectFlags"
159
 
>GConnectFlags</a> flags,
160
 
                                                         <a
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,
164
 
                                                         <a
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,
169
 
                                                         <a
170
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
171
 
>gpointer</a> user_data);
172
 
 
173
 
<a
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,
176
 
                                                         const <a
177
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
178
 
>gchar</a> *type_name);
179
 
const <a
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>);
 
60
 
 
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>);
 
70
 
 
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>);
 
83
 
 
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>);
184
87
</pre>
185
88
</div>
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">
189
 
  <a
190
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
191
 
>GObject</a>
 
92
  GObject
192
93
   +----ClutterScript
193
94
</pre>
194
95
</div>
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"
200
 
>gchar</a>*                : Read
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"
203
 
>gboolean</a>              : Read
 
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
204
101
</pre>
205
102
</div>
206
103
<div class="refsect1" title="Description">
223
120
A <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> holds a reference on every object it creates from
224
121
the definition data, except for the stage. Every non-actor object
225
122
will be finalized when the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance holding it will
226
 
be finalized, so they need to be referenced using <a
227
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-ref"
228
 
><code class="function">g_object_ref()</code></a> in
 
123
be finalized, so they need to be referenced using <code class="function">g_object_ref()</code> in
229
124
order for them to survive.
230
125
</p>
231
126
<p>
233
128
</p>
234
129
<p>
235
130
</p>
236
 
<div class="informalexample"><pre class="programlisting">
237
 
{
238
 
  "id"     : "red-button",
239
 
  "type"   : "ClutterRectangle",
240
 
  "width"  : 100,
241
 
  "height" : 100,
242
 
  "color"  : "#ff0000ff"
243
 
}
244
 
</pre></div>
 
131
<div class="informalexample">
 
132
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
133
    <tbody>
 
134
      <tr>
 
135
        <td class="listing_lines" align="right"><pre>1
 
136
2
 
137
3
 
138
4
 
139
5
 
140
6
 
141
7</pre></td>
 
142
        <td class="listing_code"><pre class="programlisting"><span class="cbracket">{</span>
 
143
<span class="normal">  </span><span class="string">"id"</span><span class="normal">     </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"red-button"</span><span class="symbol">,</span>
 
144
<span class="normal">  </span><span class="string">"type"</span><span class="normal">   </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"ClutterRectangle"</span><span class="symbol">,</span>
 
145
<span class="normal">  </span><span class="string">"width"</span><span class="normal">  </span><span class="symbol">:</span><span class="normal"> </span><span class="number">100</span><span class="symbol">,</span>
 
146
<span class="normal">  </span><span class="string">"height"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="number">100</span><span class="symbol">,</span>
 
147
<span class="normal">  </span><span class="string">"color"</span><span class="normal">  </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"#ff0000ff"</span>
 
148
<span class="cbracket">}</span></pre></td>
 
149
      </tr>
 
150
    </tbody>
 
151
  </table>
 
152
</div>
 
153
 
245
154
<p>
246
155
</p>
247
156
<p>
250
159
</p>
251
160
<p>
252
161
</p>
253
 
<div class="informalexample"><pre class="programlisting">
254
 
ClutterActor *red_button;
255
 
 
256
 
red_button = CLUTTER_ACTOR (clutter_script_get_object (script, "red-button"));
257
 
</pre></div>
 
162
<div class="informalexample">
 
163
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
164
    <tbody>
 
165
      <tr>
 
166
        <td class="listing_lines" align="right"><pre>1
 
167
2
 
168
3</pre></td>
 
169
        <td class="listing_code"><pre class="programlisting"><span class="normal"><a href="ClutterActor.html">ClutterActor</a> </span><span class="symbol">*</span><span class="normal">red_button</span><span class="symbol">;</span>
 
170
 
 
171
<span class="normal">red_button </span><span class="symbol">=</span><span class="normal"> </span><span class="function">CLUTTER_ACTOR</span><span class="normal"> </span><span class="symbol">(</span><span class="function"><a href="ClutterScript.html#clutter-script-get-object">clutter_script_get_object</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">script</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"red-button"</span><span class="symbol">));</span></pre></td>
 
172
      </tr>
 
173
    </tbody>
 
174
  </table>
 
175
</div>
 
176
 
258
177
<p>
259
178
</p>
260
179
<p>
274
193
</p>
275
194
<p>
276
195
</p>
277
 
<div class="informalexample"><pre class="programlisting">
278
 
{
279
 
  "id"          : "rotate-behaviour",
280
 
  "type"        : "ClutterBehaviourRotate",
281
 
  "angle-start" : 0.0,
282
 
  "angle-end"   : 360.0,
283
 
  "axis"        : "z-axis",
284
 
  "alpha"       : {
285
 
    "timeline" : { "duration" : 4000, "fps" : 60, "loop" : true },
286
 
    "function" : "sine"
287
 
  }
288
 
}
289
 
</pre></div>
 
196
<div class="informalexample">
 
197
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
198
    <tbody>
 
199
      <tr>
 
200
        <td class="listing_lines" align="right"><pre>1
 
201
2
 
202
3
 
203
4
 
204
5
 
205
6
 
206
7
 
207
8
 
208
9
 
209
10
 
210
11</pre></td>
 
211
        <td class="listing_code"><pre class="programlisting"><span class="cbracket">{</span>
 
212
<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>
 
213
<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>
 
214
<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>
 
215
<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>
 
216
<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>
 
217
<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>
 
218
<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><span class="normal"> </span><span class="string">"duration"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="number">4000</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"loop"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> true </span><span class="cbracket">}</span><span class="symbol">,</span>
 
219
<span class="normal">    </span><span class="string">"mode"</span><span class="normal">     </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"easeInSine"</span>
 
220
<span class="normal">  </span><span class="cbracket">}</span>
 
221
<span class="cbracket">}</span></pre></td>
 
222
      </tr>
 
223
    </tbody>
 
224
  </table>
 
225
</div>
 
226
 
290
227
<p>
291
228
</p>
292
229
<p>
295
232
</p>
296
233
<p>
297
234
</p>
298
 
<div class="informalexample"><pre class="programlisting">
299
 
{
300
 
  "id" : "my-rotating-actor",
301
 
  "type" : "ClutterTexture",
302
 
  ...
303
 
  "behaviours" : [ "rotate-behaviour" ]
304
 
}
305
 
</pre></div>
 
235
<div class="informalexample">
 
236
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
237
    <tbody>
 
238
      <tr>
 
239
        <td class="listing_lines" align="right"><pre>1
 
240
2
 
241
3
 
242
4
 
243
5
 
244
6</pre></td>
 
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>
 
251
      </tr>
 
252
    </tbody>
 
253
  </table>
 
254
</div>
 
255
 
306
256
<p>
307
257
</p>
308
258
<p>
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>
316
 
API respectively).
 
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.:
 
262
</p>
 
263
<p>
 
264
</p>
 
265
<div class="informalexample">
 
266
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
267
    <tbody>
 
268
      <tr>
 
269
        <td class="listing_lines" align="right"><pre>1
 
270
2
 
271
3
 
272
4
 
273
5
 
274
6
 
275
7
 
276
8
 
277
9
 
278
10
 
279
11
 
280
12
 
281
13
 
282
14
 
283
15
 
284
16
 
285
17
 
286
18</pre></td>
 
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>
 
305
      </tr>
 
306
    </tbody>
 
307
  </table>
 
308
</div>
 
309
 
 
310
<p>
 
311
</p>
 
312
<p>
 
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).
317
318
</p>
318
319
<p>
319
320
Signal handlers can be defined inside a Clutter UI definition file and
322
323
</p>
323
324
<p>
324
325
</p>
325
 
<div class="informalexample"><pre class="programlisting">
326
 
  ...
327
 
  "signals" : [
328
 
    { "name" : "button-press-event", "handler" : "on_button_press" },
329
 
    {
330
 
      "name" : "foo-signal",
331
 
      "handler" : "after_foo",
332
 
      "after" : true
333
 
    },
334
 
  ],
335
 
  ...
336
 
</pre></div>
 
326
<div class="informalexample">
 
327
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
328
    <tbody>
 
329
      <tr>
 
330
        <td class="listing_lines" align="right"><pre>1
 
331
2
 
332
3
 
333
4
 
334
5
 
335
6
 
336
7
 
337
8
 
338
9
 
339
10</pre></td>
 
340
        <td class="listing_code"><pre class="programlisting"><span class="symbol">...</span>
 
341
<span class="string">"signals"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="symbol">[</span>
 
342
<span class="normal">  </span><span class="cbracket">{</span><span class="normal"> </span><span class="string">"name"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"button-press-event"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"handler"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"on_button_press"</span><span class="normal"> </span><span class="cbracket">}</span><span class="symbol">,</span>
 
343
<span class="normal">  </span><span class="cbracket">{</span>
 
344
<span class="normal">    </span><span class="string">"name"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"foo-signal"</span><span class="symbol">,</span>
 
345
<span class="normal">    </span><span class="string">"handler"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"after_foo"</span><span class="symbol">,</span>
 
346
<span class="normal">    </span><span class="string">"after"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> true</span>
 
347
<span class="normal">  </span><span class="cbracket">}</span><span class="symbol">,</span>
 
348
<span class="symbol">],</span>
 
349
<span class="symbol">...</span></pre></td>
 
350
      </tr>
 
351
    </tbody>
 
352
  </table>
 
353
</div>
 
354
 
337
355
<p>
338
356
</p>
339
357
<p>
341
359
they can also have the "after" and "swapped" boolean members (for the
342
360
signal connection flags <code class="literal">G_CONNECT_AFTER</code> and <code class="literal">G_CONNECT_SWAPPED</code>
343
361
respectively) and the "object" string member for calling
344
 
<a
345
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#g-signal-connect-object"
346
 
><code class="function">g_signal_connect_object()</code></a> instead of <a
347
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#g-signal-connect"
348
 
><code class="function">g_signal_connect()</code></a>.
 
362
<code class="function">g_signal_connect_object()</code> instead of <code class="function">g_signal_connect()</code>.
349
363
</p>
350
364
<p>
351
365
Clutter reserves the following names, so classes defining properties
369
383
<p>
370
384
</p>
371
385
<p>
372
 
<a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> is available since Clutter 0.6</p>
373
 
<p>
 
386
<a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> is available since Clutter 0.6
374
387
</p>
375
388
</div>
376
389
<div class="refsect1" title="Details">
380
393
<pre class="programlisting">typedef struct _ClutterScript ClutterScript;</pre>
381
394
<p>
382
395
The <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> structure contains only private data
383
 
and should be accessed using the provided API</p>
384
 
<p>
 
396
and should be accessed using the provided API
385
397
</p>
386
398
<p class="since">Since 0.6</p>
387
399
</div>
394
406
} ClutterScriptClass;
395
407
</pre>
396
408
<p>
397
 
The <a class="link" href="ClutterScript.html#ClutterScriptClass" title="ClutterScriptClass"><span class="type">ClutterScriptClass</span></a> structure contains only private data</p>
398
 
<p>
 
409
The <a class="link" href="ClutterScript.html#ClutterScriptClass" title="ClutterScriptClass"><span class="type">ClutterScriptClass</span></a> structure contains only private data
399
410
</p>
400
411
<div class="variablelist"><table border="0">
401
412
<col align="left" valign="top">
402
413
<tbody><tr>
403
 
<td><p><span class="term"><em class="structfield"><code>get_type_from_name</code></em> ()</span></p></td>
404
 
<td> virtual function used to map a type name
405
 
  to a <a
406
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
407
 
><span class="type">GType</span></a>. This function should only be overridden by
408
 
  language bindings in order to map native types to <a
409
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
410
 
><span class="type">GType</span></a>.
411
 
  The default implementation is equivalent to <a
412
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#g-type-from-name"
413
 
><code class="function">g_type_from_name()</code></a>
 
414
<td><p><span class="term"><em class="structfield"><code><a name="ClutterScriptClass.get-type-from-name"></a>get_type_from_name</code></em> ()</span></p></td>
 
415
<td>virtual function used to map a type name
 
416
  to a <span class="type">GType</span>. This function should only be overridden by
 
417
  language bindings in order to map native types to <span class="type">GType</span>.
 
418
  The default implementation is equivalent to <code class="function">g_type_from_name()</code>
414
419
</td>
415
420
</tr></tbody>
416
421
</table></div>
419
424
<hr>
420
425
<div class="refsect2" title="clutter_script_new ()">
421
426
<a name="clutter-script-new"></a><h3>clutter_script_new ()</h3>
422
 
<pre class="programlisting"><a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *     clutter_script_new                  (void);</pre>
 
427
<pre class="programlisting"><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="returnvalue">ClutterScript</span></a> *     clutter_script_new                  (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
423
428
<p>
424
429
Creates a new <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance. <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> can be used
425
430
to load objects definitions for scenegraph elements, like actors,
426
431
or behavioural elements, like behaviours and timelines. The
427
432
definitions must be encoded using the JavaScript Object Notation (JSON)
428
 
language.</p>
429
 
<p>
 
433
language.
430
434
</p>
431
435
<div class="variablelist"><table border="0">
432
436
<col align="left" valign="top">
433
437
<tbody><tr>
434
438
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
435
439
<td> the newly created <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance. Use
436
 
  <a
437
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"
438
 
><code class="function">g_object_unref()</code></a> when done.
 
440
  <code class="function">g_object_unref()</code> when done.
439
441
 
440
442
</td>
441
443
</tr></tbody>
452
454
} ClutterScriptError;
453
455
</pre>
454
456
<p>
455
 
<a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> error enumeration.</p>
456
 
<p>
 
457
<a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> error enumeration.
457
458
</p>
458
459
<div class="variablelist"><table border="0">
459
460
<col align="left" valign="top">
460
461
<tbody>
461
462
<tr>
462
 
<td><p><a name="CLUTTER-SCRIPT-ERROR-INVALID-TYPE-FUNCTION--CAPS"></a><span class="term"><code class="literal">CLUTTER_SCRIPT_ERROR_INVALID_TYPE_FUNCTION</code></span></p></td>
463
 
<td> Type function not found
 
463
<td><p><a name="CLUTTER-SCRIPT-ERROR-INVALID-TYPE-FUNCTION:CAPS"></a><span class="term"><code class="literal">CLUTTER_SCRIPT_ERROR_INVALID_TYPE_FUNCTION</code></span></p></td>
 
464
<td>Type function not found
464
465
  or invalid
465
466
</td>
466
467
</tr>
467
468
<tr>
468
 
<td><p><a name="CLUTTER-SCRIPT-ERROR-INVALID-PROPERTY--CAPS"></a><span class="term"><code class="literal">CLUTTER_SCRIPT_ERROR_INVALID_PROPERTY</code></span></p></td>
469
 
<td> Property not found or invalid
 
469
<td><p><a name="CLUTTER-SCRIPT-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">CLUTTER_SCRIPT_ERROR_INVALID_PROPERTY</code></span></p></td>
 
470
<td>Property not found or invalid
470
471
</td>
471
472
</tr>
472
473
<tr>
473
 
<td><p><a name="CLUTTER-SCRIPT-ERROR-INVALID-VALUE--CAPS"></a><span class="term"><code class="literal">CLUTTER_SCRIPT_ERROR_INVALID_VALUE</code></span></p></td>
474
 
<td> Invalid value
 
474
<td><p><a name="CLUTTER-SCRIPT-ERROR-INVALID-VALUE:CAPS"></a><span class="term"><code class="literal">CLUTTER_SCRIPT_ERROR_INVALID_VALUE</code></span></p></td>
 
475
<td>Invalid value
475
476
</td>
476
477
</tr>
477
478
</tbody>
481
482
<hr>
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,
487
 
                                                         const <a
488
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
489
 
>gchar</a> *data,
490
 
                                                         <a
491
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize"
492
 
>gssize</a> length,
493
 
                                                         <a
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>
496
489
<p>
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>
499
 
<p>
 
491
the currently loaded ones, if any.
500
492
</p>
501
493
<div class="variablelist"><table border="0">
502
494
<col align="left" valign="top">
503
495
<tbody>
504
496
<tr>
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>
507
499
</td>
508
500
</tr>
509
501
<tr>
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
512
504
</td>
513
505
</tr>
514
506
<tr>
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
517
509
  buffer
518
510
</td>
519
511
</tr>
520
512
<tr>
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>
527
515
</td>
528
516
</tr>
529
517
<tr>
541
529
<hr>
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,
547
 
                                                         const <a
548
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
549
 
>gchar</a> *filename,
550
 
                                                         <a
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>
553
535
<p>
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>
556
 
<p>
 
537
the currently loaded ones, if any.
557
538
</p>
558
539
<div class="variablelist"><table border="0">
559
540
<col align="left" valign="top">
560
541
<tbody>
561
542
<tr>
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>
564
545
</td>
565
546
</tr>
566
547
<tr>
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
569
550
</td>
570
551
</tr>
571
552
<tr>
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>
578
555
</td>
579
556
</tr>
580
557
<tr>
592
569
<hr>
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,
596
 
                                                         const <a
597
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
598
 
>gchar</a> * const paths[],
599
 
                                                         <a
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>
602
575
<p>
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>.
604
577
</p>
605
578
<p>
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>
609
 
<p>
 
581
or other custom, file-based properties.
610
582
</p>
611
583
<div class="variablelist"><table border="0">
612
584
<col align="left" valign="top">
613
585
<tbody>
614
586
<tr>
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>
617
589
</td>
618
590
</tr>
619
591
<tr>
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
622
594
</td>
623
595
</tr>
624
596
<tr>
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
627
599
</td>
628
600
</tr>
629
601
</tbody>
633
605
<hr>
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,
639
 
                                                         const <a
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>
642
610
<p>
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>
645
 
<p>
 
612
is found, its full path will be returned .
646
613
</p>
647
614
<div class="variablelist"><table border="0">
648
615
<col align="left" valign="top">
649
616
<tbody>
650
617
<tr>
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>
653
620
</td>
654
621
</tr>
655
622
<tr>
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
658
625
</td>
659
626
</tr>
660
627
<tr>
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
665
630
  found.
666
631
 
667
632
</td>
673
638
<hr>
674
639
<div class="refsect2" title="clutter_script_get_object ()">
675
640
<a name="clutter-script-get-object"></a><h3>clutter_script_get_object ()</h3>
676
 
<pre class="programlisting"><a
677
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
678
 
>GObject</a> *           clutter_script_get_object           (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
679
 
                                                         const <a
680
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
681
 
>gchar</a> *name);</pre>
 
641
<pre class="programlisting"><span class="returnvalue">GObject</span> *           clutter_script_get_object           (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
 
642
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
682
643
<p>
683
644
Retrieves the object bound to <em class="parameter"><code>name</code></em>. This function does not increment
684
 
the reference count of the returned object.</p>
685
 
<p>
 
645
the reference count of the returned object.
686
646
</p>
687
647
<div class="variablelist"><table border="0">
688
648
<col align="left" valign="top">
689
649
<tbody>
690
650
<tr>
691
651
<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
692
 
<td> a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
 
652
<td>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
693
653
</td>
694
654
</tr>
695
655
<tr>
696
656
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
697
 
<td> the name of the object to retrieve
 
657
<td>the name of the object to retrieve
698
658
</td>
699
659
</tr>
700
660
<tr>
701
661
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
702
 
<td>transfer none. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=transfer"><span class="acronym">transfer</span></a> none. </td>
 
662
<td> the named object, or <code class="literal">NULL</code> if no object
 
663
  with the given name was available. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
664
</td>
703
665
</tr>
704
666
</tbody>
705
667
</table></div>
708
670
<hr>
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,
714
 
                                                         const <a
715
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
716
 
>gchar</a> *first_name,
717
 
                                                         ...);</pre>
 
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>
718
676
<p>
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:
724
680
</p>
725
681
<p>
726
682
</p>
727
 
<div class="informalexample"><pre class="programlisting">
728
 
  GObject *my_label, *a_button, *main_timeline;
729
 
 
730
 
  clutter_script_get_objects (script,
731
 
                              "my-label", &amp;my_label,
732
 
                              "a-button", &amp;a_button,
733
 
                              "main-timeline", &amp;main_timeline,
734
 
                              NULL);
735
 
</pre></div>
 
683
<div class="informalexample">
 
684
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
685
    <tbody>
 
686
      <tr>
 
687
        <td class="listing_lines" align="right"><pre>1
 
688
2
 
689
3
 
690
4
 
691
5
 
692
6
 
693
7</pre></td>
 
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>
 
695
 
 
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">&amp;</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">&amp;</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">&amp;</span><span class="normal">main_timeline</span><span class="symbol">,</span>
 
700
<span class="normal">                            NULL</span><span class="symbol">);</span></pre></td>
 
701
      </tr>
 
702
    </tbody>
 
703
  </table>
 
704
</div>
 
705
 
736
706
<p>
737
707
</p>
738
708
<p>
739
709
Note: This function does not increment the reference count of the
740
 
returned objects.</p>
741
 
<p>
 
710
returned objects.
742
711
</p>
743
712
<div class="variablelist"><table border="0">
744
713
<col align="left" valign="top">
745
714
<tbody>
746
715
<tr>
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>
749
718
</td>
750
719
</tr>
751
720
<tr>
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
754
723
</td>
755
724
</tr>
756
725
<tr>
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
761
 
  with <a
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>
764
729
</td>
765
730
</tr>
766
731
<tr>
776
741
<hr>
777
742
<div class="refsect2" title="clutter_script_unmerge_objects ()">
778
743
<a name="clutter-script-unmerge-objects"></a><h3>clutter_script_unmerge_objects ()</h3>
779
 
<pre class="programlisting">void                clutter_script_unmerge_objects      (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
780
 
                                                         <a
781
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
782
 
>guint</a> merge_id);</pre>
783
 
<p>
784
 
Unmerges the objects identified by <em class="parameter"><code>merge_id</code></em>.</p>
785
 
<p>
 
744
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_script_unmerge_objects      (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
 
745
                                                         <em class="parameter"><code><span class="type">guint</span> merge_id</code></em>);</pre>
 
746
<p>
 
747
Unmerges the objects identified by <em class="parameter"><code>merge_id</code></em>.
786
748
</p>
787
749
<div class="variablelist"><table border="0">
788
750
<col align="left" valign="top">
789
751
<tbody>
790
752
<tr>
791
753
<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
792
 
<td> a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
 
754
<td>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
793
755
</td>
794
756
</tr>
795
757
<tr>
796
758
<td><p><span class="term"><em class="parameter"><code>merge_id</code></em> :</span></p></td>
797
 
<td> merge id returned when loading a UI definition
 
759
<td>merge id returned when loading a UI definition
798
760
</td>
799
761
</tr>
800
762
</tbody>
804
766
<hr>
805
767
<div class="refsect2" title="clutter_script_ensure_objects ()">
806
768
<a name="clutter-script-ensure-objects"></a><h3>clutter_script_ensure_objects ()</h3>
807
 
<pre class="programlisting">void                clutter_script_ensure_objects       (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script);</pre>
 
769
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_script_ensure_objects       (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>);</pre>
808
770
<p>
809
771
Ensure that every object defined inside <em class="parameter"><code>script</code></em> is correctly
810
 
constructed. You should rarely need to use this function.</p>
811
 
<p>
 
772
constructed. You should rarely need to use this function.
812
773
</p>
813
774
<div class="variablelist"><table border="0">
814
775
<col align="left" valign="top">
815
776
<tbody><tr>
816
777
<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
817
 
<td> a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
 
778
<td>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
818
779
</td>
819
780
</tr></tbody>
820
781
</table></div>
823
784
<hr>
824
785
<div class="refsect2" title="clutter_script_list_objects ()">
825
786
<a name="clutter-script-list-objects"></a><h3>clutter_script_list_objects ()</h3>
826
 
<pre class="programlisting"><a
827
 
href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
828
 
>GList</a> *             clutter_script_list_objects         (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script);</pre>
 
787
<pre class="programlisting"><span class="returnvalue">GList</span> *             clutter_script_list_objects         (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>);</pre>
829
788
<p>
830
789
Retrieves all the objects created by <em class="parameter"><code>script</code></em>.
831
790
</p>
832
791
<p>
833
792
Note: this function does not increment the reference count of the
834
 
objects it returns.</p>
835
 
<p>
 
793
objects it returns.
836
794
</p>
837
795
<div class="variablelist"><table border="0">
838
796
<col align="left" valign="top">
839
797
<tbody>
840
798
<tr>
841
799
<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
842
 
<td> a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
 
800
<td>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
843
801
</td>
844
802
</tr>
845
803
<tr>
846
804
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
847
 
<td>transfer container) (element-type GObject. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=transfer"><span class="acronym">transfer</span></a> container. <acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GObject. </td>
 
805
<td> a list of <span class="type">GObject</span>s,
 
806
  or <code class="literal">NULL</code>. The objects are owned by the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance. Use <code class="function">g_list_free()</code> on the
 
807
  returned value when done. <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> GObject]</span>
 
808
</td>
848
809
</tr>
849
810
</tbody>
850
811
</table></div>
853
814
<hr>
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,
857
 
                                                         <a
858
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
859
 
>GObject</a> *object,
860
 
                                                         const <a
861
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
862
 
>gchar</a> *signal_name,
863
 
                                                         const <a
864
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
865
 
>gchar</a> *handler_name,
866
 
                                                         <a
867
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
868
 
>GObject</a> *connect_object,
869
 
                                                         <a
870
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#GConnectFlags"
871
 
>GConnectFlags</a> flags,
872
 
                                                         <a
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>
875
824
<p>
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>
880
 
<p>
 
828
programmer wants more control over the signal connection process.
881
829
</p>
882
830
<div class="variablelist"><table border="0">
883
831
<col align="left" valign="top">
884
832
<tbody>
885
833
<tr>
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>
888
836
</td>
889
837
</tr>
890
838
<tr>
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
893
841
</td>
894
842
</tr>
895
843
<tr>
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
898
846
</td>
899
847
</tr>
900
848
<tr>
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
903
851
</td>
904
852
</tr>
905
853
<tr>
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>
910
856
</td>
911
857
</tr>
912
858
<tr>
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
915
861
</td>
916
862
</tr>
917
863
<tr>
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
920
866
</td>
921
867
</tr>
922
868
</tbody>
926
872
<hr>
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,
930
 
                                                         <a
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>
933
877
<p>
934
878
Connects all the signals defined into a UI definition file to their
935
879
handlers.
936
880
</p>
937
881
<p>
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
939
 
and uses  <a
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.
943
885
</p>
944
886
<p>
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>
949
 
<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.
950
889
</p>
951
890
<div class="variablelist"><table border="0">
952
891
<col align="left" valign="top">
953
892
<tbody>
954
893
<tr>
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>
957
896
</td>
958
897
</tr>
959
898
<tr>
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>
964
901
</td>
965
902
</tr>
966
903
</tbody>
970
907
<hr>
971
908
<div class="refsect2" title="clutter_script_connect_signals_full ()">
972
909
<a name="clutter-script-connect-signals-full"></a><h3>clutter_script_connect_signals_full ()</h3>
973
 
<pre class="programlisting">void                clutter_script_connect_signals_full (<a class="link" href="ClutterScript.html" title="ClutterScript">ClutterScript</a> *script,
974
 
                                                         <a class="link" href="ClutterScript.html#ClutterScriptConnectFunc" title="ClutterScriptConnectFunc ()">ClutterScriptConnectFunc</a> func,
975
 
                                                         <a
976
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
977
 
>gpointer</a> user_data);</pre>
 
910
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_script_connect_signals_full (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
 
911
                                                         <em class="parameter"><code><a class="link" href="ClutterScript.html#ClutterScriptConnectFunc" title="ClutterScriptConnectFunc ()"><span class="type">ClutterScriptConnectFunc</span></a> func</code></em>,
 
912
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
978
913
<p>
979
914
Connects all the signals defined into a UI definition file to their
980
915
handlers.
986
921
names using the native API.
987
922
</p>
988
923
<p>
989
 
Applications should use <a class="link" href="ClutterScript.html#clutter-script-connect-signals" title="clutter_script_connect_signals ()"><code class="function">clutter_script_connect_signals()</code></a>.</p>
990
 
<p>
 
924
Applications should use <a class="link" href="ClutterScript.html#clutter-script-connect-signals" title="clutter_script_connect_signals ()"><code class="function">clutter_script_connect_signals()</code></a>.
991
925
</p>
992
926
<div class="variablelist"><table border="0">
993
927
<col align="left" valign="top">
994
928
<tbody>
995
929
<tr>
996
930
<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
997
 
<td> a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
 
931
<td>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
998
932
</td>
999
933
</tr>
1000
934
<tr>
1001
935
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
1002
 
<td> signal connection function
 
936
<td>signal connection function
1003
937
</td>
1004
938
</tr>
1005
939
<tr>
1006
940
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1007
 
<td> data to be passed to the signal handlers, or <a
1008
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
1009
 
><code class="literal">NULL</code></a>
 
941
<td>data to be passed to the signal handlers, or <code class="literal">NULL</code>
1010
942
</td>
1011
943
</tr>
1012
944
</tbody>
1016
948
<hr>
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,
1022
 
                                                         const <a
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>
1025
953
<p>
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
1028
 
rarely be used.</p>
1029
 
<p>
 
956
rarely be used.
1030
957
</p>
1031
958
<div class="variablelist"><table border="0">
1032
959
<col align="left" valign="top">
1033
960
<tbody>
1034
961
<tr>
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>
1037
964
</td>
1038
965
</tr>
1039
966
<tr>
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
1042
969
</td>
1043
970
</tr>
1044
971
<tr>
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
1047
 
  <a
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.
1050
975
 
1051
976
</td>
1052
977
</tr>
1057
982
<hr>
1058
983
<div class="refsect2" title="clutter_get_script_id ()">
1059
984
<a name="clutter-get-script-id"></a><h3>clutter_get_script_id ()</h3>
1060
 
<pre class="programlisting">const <a
1061
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1062
 
>gchar</a> *       clutter_get_script_id               (<a
1063
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
1064
 
>GObject</a> *gobject);</pre>
1065
 
<p>
1066
 
Retrieves the Clutter script id, if any.</p>
1067
 
<p>
 
985
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       clutter_get_script_id               (<em class="parameter"><code><span class="type">GObject</span> *gobject</code></em>);</pre>
 
986
<p>
 
987
Retrieves the Clutter script id, if any.
1068
988
</p>
1069
989
<div class="variablelist"><table border="0">
1070
990
<col align="left" valign="top">
1071
991
<tbody>
1072
992
<tr>
1073
993
<td><p><span class="term"><em class="parameter"><code>gobject</code></em> :</span></p></td>
1074
 
<td> a <a
1075
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
1076
 
><span class="type">GObject</span></a>
 
994
<td>a <span class="type">GObject</span>
1077
995
</td>
1078
996
</tr>
1079
997
<tr>
1080
998
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1081
 
<td> the script id, or <a
1082
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
1083
 
><code class="literal">NULL</code></a> if <em class="parameter"><code>object</code></em> was not defined inside
 
999
<td> the script id, or <code class="literal">NULL</code> if <em class="parameter"><code>object</code></em> was not defined inside
1084
1000
  a UI definition file. The returned string is owned by the object and
1085
1001
  should never be modified or freed.
1086
1002
 
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>
1101
 
<p>
1102
 
The path of the currently parsed file. If ClutterScript:filename-set
1103
 
is <a
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>
1106
 
<p>
 
1014
<pre class="programlisting">  "filename"                 <span class="type">gchar</span>*                : Read</pre>
 
1015
<p>
 
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.
1107
1018
</p>
1108
1019
<p>Default value: NULL</p>
1109
 
<p>Since 0.6</p>
 
1020
<p class="since">Since 0.6</p>
1110
1021
</div>
1111
1022
<hr>
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>
1117
 
<p>
1118
 
Whether the ClutterScript:filename property is set. If this property
1119
 
is <a
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>
1123
 
<p>
 
1025
<pre class="programlisting">  "filename-set"             <span class="type">gboolean</span>              : Read</pre>
 
1026
<p>
 
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.
1124
1030
</p>
1125
1031
<p>Default value: FALSE</p>
1126
 
<p>Since 0.6</p>
 
1032
<p class="since">Since 0.6</p>
1127
1033
</div>
1128
1034
</div>
1129
1035
</div>
1130
1036
<div class="footer">
1131
1037
<hr>
1132
 
          Generated by GTK-Doc V1.11</div>
 
1038
          Generated by GTK-Doc V1.15.1</div>
1133
1039
</body>
1134
 
</html>
 
1040
</html>
 
 
b'\\ No newline at end of file'