<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterScript: Clutter Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Clutter Reference Manual">
<link rel="up" href="ch11.html" title="User interface definition">
<link rel="prev" href="ch11.html" title="User interface definition">
<link rel="next" href="ClutterScriptable.html" title="ClutterScriptable">
<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#ClutterScript.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ClutterScript.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ClutterScript.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch11.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch11.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterScriptable.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterScript"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterScript.top_of_page"></a>ClutterScript</span></h2>
<p>ClutterScript — Loads a scene from UI definition data</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterScript.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="ClutterScript.html" title="ClutterScript"><span class="returnvalue">ClutterScript</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-new" title="clutter_script_new ()">clutter_script_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-load-from-data" title="clutter_script_load_from_data ()">clutter_script_load_from_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-load-from-file" title="clutter_script_load_from_file ()">clutter_script_load_from_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-load-from-resource" title="clutter_script_load_from_resource ()">clutter_script_load_from_resource</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-add-search-paths" title="clutter_script_add_search_paths ()">clutter_script_add_search_paths</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-lookup-filename" title="clutter_script_lookup_filename ()">clutter_script_lookup_filename</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GObject</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-get-object" title="clutter_script_get_object ()">clutter_script_get_object</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-get-objects" title="clutter_script_get_objects ()">clutter_script_get_objects</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-unmerge-objects" title="clutter_script_unmerge_objects ()">clutter_script_unmerge_objects</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-ensure-objects" title="clutter_script_ensure_objects ()">clutter_script_ensure_objects</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GList</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-list-objects" title="clutter_script_list_objects ()">clutter_script_list_objects</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="ClutterScript.html#ClutterScriptConnectFunc" title="ClutterScriptConnectFunc ()">*ClutterScriptConnectFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-connect-signals" title="clutter_script_connect_signals ()">clutter_script_connect_signals</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-connect-signals-full" title="clutter_script_connect_signals_full ()">clutter_script_connect_signals_full</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-add-states" title="clutter_script_add_states ()">clutter_script_add_states</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterState.html" title="ClutterState"><span class="returnvalue">ClutterState</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-get-states" title="clutter_script_get_states ()">clutter_script_get_states</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GType</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-get-script-id" title="clutter_get_script_id ()">clutter_get_script_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-get-translation-domain" title="clutter_script_get_translation_domain ()">clutter_script_get_translation_domain</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-set-translation-domain" title="clutter_script_set_translation_domain ()">clutter_script_set_translation_domain</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterScript.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="ClutterScript.html#ClutterScript--filename" title="The “filename” property">filename</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterScript.html#ClutterScript--filename-set" title="The “filename-set” property">filename-set</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="ClutterScript.html#ClutterScript--translation-domain" title="The “translation-domain” property">translation-domain</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterScript.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterScript.html#ClutterScript-struct" title="struct ClutterScript">ClutterScript</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterScript.html#ClutterScriptClass" title="struct ClutterScriptClass">ClutterScriptClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="ClutterScript.html#ClutterScriptError" title="enum ClutterScriptError">ClutterScriptError</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterScript.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> ClutterScript
</pre>
</div>
<div class="refsect1">
<a name="ClutterScript.description"></a><h2>Description</h2>
<p><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> is an object used for loading and building parts or a
complete scenegraph from external definition data in forms of string
buffers or files.</p>
<p>The UI definition format is JSON, the JavaScript Object Notation as
described by RFC 4627. <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> can load a JSON data stream,
parse it and build all the objects defined into it. The top-level node
in the JSON file can be a single object or an array of objects. Each object
must have an "id" and a "type" properties defining the name to be used
to retrieve it from <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> with <a class="link" href="ClutterScript.html#clutter-script-get-object" title="clutter_script_get_object ()"><code class="function">clutter_script_get_object()</code></a>,
and the class type to be instanciated. Every other attribute will
be mapped to the class properties.</p>
<p>A <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> holds a reference on every object it creates from
the definition data, except for the stage. Every non-actor object
will be finalized when the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance holding it will
be finalized, so they need to be referenced using <code class="function">g_object_ref()</code> in
order for them to survive.</p>
<p>A simple object might be defined as:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="cbracket">{</span>
<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>
<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>
<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>
<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>
<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>
<span class="cbracket">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>This will produce a red <a class="link" href="ClutterRectangle.html" title="ClutterRectangle"><span class="type">ClutterRectangle</span></a>, 100x100 pixels wide, and
with a ClutterScript id of "red-button"; it can be retrieved by calling:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">ClutterActor</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">red_button</span><span class="symbol">;</span>
<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>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>and then manipulated with the Clutter API. For every object created
using ClutterScript it is possible to check the id by calling
<a class="link" href="ClutterScript.html#clutter-get-script-id" title="clutter_get_script_id ()"><code class="function">clutter_get_script_id()</code></a>.</p>
<p>Multiple objects can be defined using an array:</p>
<div class="informalexample"><pre class="screen">
[
{
"id" : "red-button",
"type" : "ClutterRectangle",
"width" : 100,
"height" : 100,
"color" : "#ff0000ff"
},
{
"id" : "white-button",
"type" : "ClutterRectangle",
"width" : 100,
"height" : 100,
"color" : "#ffffffff"
}
]
</pre></div>
<p></p>
<p>Packing can be represented using the "children" member, and passing an
array of objects or ids of objects already defined (but not packed: the
packing rules of Clutter still apply, and an actor cannot be packed
in multiple containers without unparenting it in between).</p>
<p>Behaviours and timelines can also be defined inside a UI definition
buffer:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="cbracket">{</span>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<span class="normal"> </span><span class="cbracket">}</span>
<span class="cbracket">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>And then to apply a defined behaviour to an actor defined inside the
definition of an actor, the "behaviour" member can be used:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="cbracket">{</span>
<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>
<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>
<span class="normal"> </span><span class="symbol">...</span>
<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>
<span class="cbracket">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>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
implicitly like in the example above, or explicitly by setting the
"alpha" property to point to a previously defined <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a>, e.g.:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="cbracket">{</span>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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">"id"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"rotate-timeline"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"type : "</span><span class="normal"><a href="ClutterTimeline.html#ClutterTimeline-struct">ClutterTimeline</a></span><span class="string">",</span>
<span class="string"> "</span><span class="normal">duration</span><span class="string">" : 4000,</span>
<span class="string"> "</span><span class="normal">loop</span><span class="string">" : true</span>
<span class="string"> },</span>
<span class="string"> "</span><span class="normal">function</span><span class="string">" : "</span><span class="normal">custom_sine_alpha</span><span class="string">"</span>
<span class="string"> }</span>
<span class="string">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>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
can omit the <code class="literal">id</code>, as well as the <code class="literal">type</code> members, 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, 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> API respectively).</p>
<p>Signal handlers can be defined inside a Clutter UI definition file and
then autoconnected to their respective signals using the
<a class="link" href="ClutterScript.html#clutter-script-connect-signals" title="clutter_script_connect_signals ()"><code class="function">clutter_script_connect_signals()</code></a> function:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="symbol">...</span>
<span class="string">"signals"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="symbol">[</span>
<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>
<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">"foo-signal"</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">"after_foo"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"after"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> true</span>
<span class="normal"> </span><span class="cbracket">}</span><span class="symbol">,</span>
<span class="symbol">],</span>
<span class="symbol">...</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>Signal handler definitions must have a "name" and a "handler" members;
they can also have the "after" and "swapped" boolean members (for the
signal connection flags <code class="literal">G_CONNECT_AFTER</code> and <code class="literal">G_CONNECT_SWAPPED</code>
respectively) and the "object" string member for calling
<code class="function">g_signal_connect_object()</code> instead of <code class="function">g_signal_connect()</code>.</p>
<p>Signals can also be directly attached to a specific state defined
inside a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance, for instance:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="symbol">...</span>
<span class="string">"signals"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="symbol">[</span>
<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">"enter-event"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"states"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"button-states"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"target-state"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"hover"</span>
<span class="normal"> </span><span class="cbracket">}</span><span class="symbol">,</span>
<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">"leave-event"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"states"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"button-states"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"target-state"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"base"</span>
<span class="normal"> </span><span class="cbracket">}</span><span class="symbol">,</span>
<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">"states"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"button-states"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"target-state"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"active"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="cbracket">}</span><span class="symbol">,</span>
<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">"key-press-event"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"states"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"button-states"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"target-state"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"key-focus"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"warp"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> true</span>
<span class="normal"> </span><span class="cbracket">}</span>
<span class="symbol">],</span>
<span class="symbol">...</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>The "states" key defines the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance to be used to
resolve the "target-state" key; it can be either a script id for a
<a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> built by the same <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance, or to a
<a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> built in code and associated to the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
instance through the <a class="link" href="ClutterScript.html#clutter-script-add-states" title="clutter_script_add_states ()"><code class="function">clutter_script_add_states()</code></a> function. If no
"states" key is present, then the default <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> associated to
the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance will be used; the default <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
can be set using <a class="link" href="ClutterScript.html#clutter-script-add-states" title="clutter_script_add_states ()"><code class="function">clutter_script_add_states()</code></a> using a <code class="literal">NULL</code> name. The
"warp" key can be used to warp to a specific state instead of
animating to it. State changes on signal emission will not affect
the signal emission chain.</p>
<p>ClutterScript supports translation using gettext: if a "translatable" key is
added to a property value, it will be passed through <code class="function">g_dgettext()</code> before
being set on the created object. For example, to mark the <a class="link" href="ClutterText.html#ClutterText--text" title="The “text” property"><span class="type">“text”</span></a>
property as being translatable:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="cbracket">{</span>
<span class="normal"> </span><span class="string">"id"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"label"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"type"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"ClutterText"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"text"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="cbracket">{</span><span class="normal"> </span><span class="string">"translatable"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> true</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"string"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"Clutter Script"</span><span class="normal"> </span><span class="cbracket">}</span>
<span class="cbracket">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>In order for translation to work, the C runtime locale must have been set
using <code class="function">setlocale()</code> before loading the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>, and the translation
domain must have been set using <code class="function">textdomain()</code>. If the strings in the script
are in a different translation domain from the rest of the program, use
<a class="link" href="ClutterScript.html#clutter-script-set-translation-domain" title="clutter_script_set_translation_domain ()"><code class="function">clutter_script_set_translation_domain()</code></a> to set the domain for the
<a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> only.</p>
<p>As well as the "translatable" key, ClutterScript supports optional "domain"
and "context" keys for specifying the message domain (if it is not the
default) and context for disambiguating it from other equal message strings.</p>
<p>Clutter reserves the following names, so classes defining properties
through the usual GObject registration process should avoid using these
names to avoid collisions:</p>
<pre class="programlisting">
"id" := the unique name of a ClutterScript object
"type" := the class literal name, also used to infer the type
function
"type_func" := the GType function name, for non-standard classes
"children" := an array of names or objects to add as children
"behaviours" := an array of names or objects to apply to an actor
"signals" := an array of signal definitions to connect to an object
"is-default" := a boolean flag used when defining the #ClutterStage;
if set to "true" the default stage will be used instead
of creating a new #ClutterStage instance
</pre>
<p><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> is available since Clutter 0.6</p>
</div>
<div class="refsect1">
<a name="ClutterScript.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-script-new"></a><h3>clutter_script_new ()</h3>
<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>
<p>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
to load objects definitions for scenegraph elements, like actors,
or behavioural elements, like behaviours and timelines. The
definitions must be encoded using the JavaScript Object Notation (JSON)
language.</p>
<div class="refsect3">
<a name="clutter-script-new.returns"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance. Use
<code class="function">g_object_unref()</code> when done.</p>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-load-from-data"></a><h3>clutter_script_load_from_data ()</h3>
<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>,
<em class="parameter"><code>const <span class="type">gchar</span> *data</code></em>,
<em class="parameter"><code><span class="type">gssize</span> length</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Loads the definitions from <em class="parameter"><code>data</code></em>
into <em class="parameter"><code>script</code></em>
and merges with
the currently loaded ones, if any.</p>
<div class="refsect3">
<a name="clutter-script-load-from-data.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>a buffer containing the definitions</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>length</p></td>
<td class="parameter_description"><p>the length of the buffer, or -1 if <em class="parameter"><code>data</code></em>
is a NUL-terminated
buffer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-script-load-from-data.returns"></a><h4>Returns</h4>
<p> on error, zero is returned and <em class="parameter"><code>error</code></em>
is set
accordingly. On success, the merge id for the UI definitions is
returned. You can use the merge id with <a class="link" href="ClutterScript.html#clutter-script-unmerge-objects" title="clutter_script_unmerge_objects ()"><code class="function">clutter_script_unmerge_objects()</code></a>.</p>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-load-from-file"></a><h3>clutter_script_load_from_file ()</h3>
<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>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Loads the definitions from <em class="parameter"><code>filename</code></em>
into <em class="parameter"><code>script</code></em>
and merges with
the currently loaded ones, if any.</p>
<div class="refsect3">
<a name="clutter-script-load-from-file.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>the full path to the definition file</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-script-load-from-file.returns"></a><h4>Returns</h4>
<p> on error, zero is returned and <em class="parameter"><code>error</code></em>
is set
accordingly. On success, the merge id for the UI definitions is
returned. You can use the merge id with <a class="link" href="ClutterScript.html#clutter-script-unmerge-objects" title="clutter_script_unmerge_objects ()"><code class="function">clutter_script_unmerge_objects()</code></a>.</p>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-load-from-resource"></a><h3>clutter_script_load_from_resource ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_script_load_from_resource (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *resource_path</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Loads the definitions from a resource file into <em class="parameter"><code>script</code></em>
and merges with
the currently loaded ones, if any.</p>
<div class="refsect3">
<a name="clutter-script-load-from-resource.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>resource_path</p></td>
<td class="parameter_description"><p>the resource path of the file to parse</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-script-load-from-resource.returns"></a><h4>Returns</h4>
<p> on error, zero is returned and <em class="parameter"><code>error</code></em>
is set
accordingly. On success, the merge id for the UI definitions is
returned. You can use the merge id with <a class="link" href="ClutterScript.html#clutter-script-unmerge-objects" title="clutter_script_unmerge_objects ()"><code class="function">clutter_script_unmerge_objects()</code></a>.</p>
</div>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-add-search-paths"></a><h3>clutter_script_add_search_paths ()</h3>
<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>,
<em class="parameter"><code>const <span class="type">gchar</span> * const paths[]</code></em>,
<em class="parameter"><code><span class="type">gsize</span> n_paths</code></em>);</pre>
<p>Adds <em class="parameter"><code>paths</code></em>
to the list of search paths held by <em class="parameter"><code>script</code></em>
.</p>
<p>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
can be used to define search paths for the textures source file name
or other custom, file-based properties.</p>
<div class="refsect3">
<a name="clutter-script-add-search-paths.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>paths</p></td>
<td class="parameter_description"><p> an array of strings containing
different search paths. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_paths]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>n_paths</p></td>
<td class="parameter_description"><p>the length of the passed array</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-lookup-filename"></a><h3>clutter_script_lookup_filename ()</h3>
<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>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
<p>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>
is found, its full path will be returned .</p>
<div class="refsect3">
<a name="clutter-script-lookup-filename.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>the name of the file to lookup</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-script-lookup-filename.returns"></a><h4>Returns</h4>
<p> the full path of <em class="parameter"><code>filename</code></em>
or <code class="literal">NULL</code> if no path was
found.</p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-get-object"></a><h3>clutter_script_get_object ()</h3>
<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>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Retrieves the object bound to <em class="parameter"><code>name</code></em>
. This function does not increment
the reference count of the returned object.</p>
<div class="refsect3">
<a name="clutter-script-get-object.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>the name of the object to retrieve</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-script-get-object.returns"></a><h4>Returns</h4>
<p> the named object, or <code class="literal">NULL</code> if no object
with the given name was available. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-get-objects"></a><h3>clutter_script_get_objects ()</h3>
<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>,
<em class="parameter"><code>const <span class="type">gchar</span> *first_name</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Retrieves a list of objects for the given names. After <em class="parameter"><code>script</code></em>
, object
names/return location pairs should be listed, with a <code class="literal">NULL</code> pointer
ending the list, like:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">GObject</span><span class="normal"> </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>
<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>
<span class="normal"> </span><span class="string">"my-label"</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">my_label</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"a-button"</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">a_button</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"main-timeline"</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">main_timeline</span><span class="symbol">,</span>
<span class="normal"> NULL</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>Note: This function does not increment the reference count of the
returned objects.</p>
<div class="refsect3">
<a name="clutter-script-get-objects.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>first_name</p></td>
<td class="parameter_description"><p>the name of the first object to retrieve</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GObject</span>, then additional names, ending
with <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-script-get-objects.returns"></a><h4>Returns</h4>
<p> the number of objects returned.</p>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-unmerge-objects"></a><h3>clutter_script_unmerge_objects ()</h3>
<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>,
<em class="parameter"><code><span class="type">guint</span> merge_id</code></em>);</pre>
<p>Unmerges the objects identified by <em class="parameter"><code>merge_id</code></em>
.</p>
<div class="refsect3">
<a name="clutter-script-unmerge-objects.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>merge_id</p></td>
<td class="parameter_description"><p>merge id returned when loading a UI definition</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-ensure-objects"></a><h3>clutter_script_ensure_objects ()</h3>
<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>
<p>Ensure that every object defined inside <em class="parameter"><code>script</code></em>
is correctly
constructed. You should rarely need to use this function.</p>
<div class="refsect3">
<a name="clutter-script-ensure-objects.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-list-objects"></a><h3>clutter_script_list_objects ()</h3>
<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>
<p>Retrieves all the objects created by <em class="parameter"><code>script</code></em>
.</p>
<p>Note: this function does not increment the reference count of the
objects it returns.</p>
<div class="refsect3">
<a name="clutter-script-list-objects.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-script-list-objects.returns"></a><h4>Returns</h4>
<p> a list
of <span class="type">GObject</span>s, 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 returned list when
done. </p>
<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GObject.Object]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterScriptConnectFunc"></a><h3>ClutterScriptConnectFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*ClutterScriptConnectFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *signal_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *handler_name</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *connect_object</code></em>,
<em class="parameter"><code><span class="type">GConnectFlags</span> flags</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>This is the signature of a function used to connect signals. It is used
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
intended for interpreted language bindings, but could be useful where the
programmer wants more control over the signal connection process.</p>
<div class="refsect3">
<a name="ClutterScriptConnectFunc.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>the object to connect</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>signal_name</p></td>
<td class="parameter_description"><p>the name of the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>handler_name</p></td>
<td class="parameter_description"><p>the name of the signal handler</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connect_object</p></td>
<td class="parameter_description"><p>the object to connect the signal to, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>signal connection flags</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data to pass to the signal handler</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-connect-signals"></a><h3>clutter_script_connect_signals ()</h3>
<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>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Connects all the signals defined into a UI definition file to their
handlers.</p>
<p>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
and uses <span class="type">GModule</span>'s introspective features (by opening the current
module's scope) to look at the application's symbol table.</p>
<p>Note that this function will not work if <span class="type">GModule</span> is not supported by
the platform Clutter is running on.</p>
<div class="refsect3">
<a name="clutter-script-connect-signals.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>data to be passed to the signal handlers, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-connect-signals-full"></a><h3>clutter_script_connect_signals_full ()</h3>
<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>,
<em class="parameter"><code><a class="link" href="ClutterScript.html#ClutterScriptConnectFunc" title="ClutterScriptConnectFunc ()"><span class="type">ClutterScriptConnectFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Connects all the signals defined into a UI definition file to their
handlers.</p>
<p>This function allows to control how the signal handlers are
going to be connected to their respective signals. It is meant
primarily for language bindings to allow resolving the function
names using the native API, but it can also be used on platforms
that do not support GModule.</p>
<p>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>
<div class="refsect3">
<a name="clutter-script-connect-signals-full.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p> signal connection function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>data to be passed to the signal handlers, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-add-states"></a><h3>clutter_script_add_states ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_script_add_states (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>);</pre>
<div class="warning"><p><code class="literal">clutter_script_add_states</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p></div>
<p>Associates a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> to the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance using the given
name.</p>
<p>The <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance will use <em class="parameter"><code>state</code></em>
to resolve target states when
connecting signal handlers.</p>
<p>The <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance will take a reference on the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
passed to this function.</p>
<div class="refsect3">
<a name="clutter-script-add-states.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p> a name for the <em class="parameter"><code>state</code></em>
, or <code class="literal">NULL</code> to
set the default <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>state</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-get-states"></a><h3>clutter_script_get_states ()</h3>
<pre class="programlisting"><a class="link" href="ClutterState.html" title="ClutterState"><span class="returnvalue">ClutterState</span></a> *
clutter_script_get_states (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<div class="warning"><p><code class="literal">clutter_script_get_states</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p></div>
<p>Retrieves the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> for the given <em class="parameter"><code>state_name</code></em>
.</p>
<p>If <em class="parameter"><code>name</code></em>
is <code class="literal">NULL</code>, this function will return the default
<a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</p>
<div class="refsect3">
<a name="clutter-script-get-states.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p> the name of the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-script-get-states.returns"></a><h4>Returns</h4>
<p> a pointer to the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> for the
given name. The <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> is owned by the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance
and it should not be unreferenced. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-get-type-from-name"></a><h3>clutter_script_get_type_from_name ()</h3>
<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>,
<em class="parameter"><code>const <span class="type">gchar</span> *type_name</code></em>);</pre>
<p>Looks up a type by name, using the virtual function that
<a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> has for that purpose. This function should
rarely be used.</p>
<div class="refsect3">
<a name="clutter-script-get-type-from-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type_name</p></td>
<td class="parameter_description"><p>name of the type to look up</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-script-get-type-from-name.returns"></a><h4>Returns</h4>
<p> the type for the requested type name, or
<code class="literal">G_TYPE_INVALID</code> if not corresponding type was found.</p>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-get-script-id"></a><h3>clutter_get_script_id ()</h3>
<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>
<p>Retrieves the Clutter script id, if any.</p>
<div class="refsect3">
<a name="clutter-get-script-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>gobject</p></td>
<td class="parameter_description"><p>a <span class="type">GObject</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-get-script-id.returns"></a><h4>Returns</h4>
<p> the script id, or <code class="literal">NULL</code> if <em class="parameter"><code>object</code></em>
was not defined inside
a UI definition file. The returned string is owned by the object and
should never be modified or freed.</p>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-get-translation-domain"></a><h3>clutter_script_get_translation_domain ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
clutter_script_get_translation_domain (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>);</pre>
<p>Retrieves the translation domain set using
<a class="link" href="ClutterScript.html#clutter-script-set-translation-domain" title="clutter_script_set_translation_domain ()"><code class="function">clutter_script_set_translation_domain()</code></a>.</p>
<div class="refsect3">
<a name="clutter-script-get-translation-domain.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-script-get-translation-domain.returns"></a><h4>Returns</h4>
<p> the translation domain, if any is set,
or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-set-translation-domain"></a><h3>clutter_script_set_translation_domain ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_script_set_translation_domain (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *domain</code></em>);</pre>
<p>Sets the translation domain for <em class="parameter"><code>script</code></em>
.</p>
<div class="refsect3">
<a name="clutter-script-set-translation-domain.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>domain</p></td>
<td class="parameter_description"><p> the translation domain, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterScript.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterScript-struct"></a><h3>struct ClutterScript</h3>
<pre class="programlisting">struct ClutterScript;</pre>
<p>The <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> structure contains only private data
and should be accessed using the provided API</p>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterScriptClass"></a><h3>struct ClutterScriptClass</h3>
<pre class="programlisting">struct ClutterScriptClass {
GType (* get_type_from_name) (ClutterScript *script,
const gchar *type_name);
};
</pre>
<p>The <a class="link" href="ClutterScript.html#ClutterScriptClass" title="struct ClutterScriptClass"><span class="type">ClutterScriptClass</span></a> structure contains only private data</p>
<div class="refsect3">
<a name="ClutterScriptClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterScriptClass.get-type-from-name"></a>get_type_from_name</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual function used to map a type name
to a <span class="type">GType</span>. This function should only be overridden by
language bindings in order to map native types to <span class="type">GType</span>.
The default implementation is equivalent to <code class="function">g_type_from_name()</code></p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterScriptError"></a><h3>enum ClutterScriptError</h3>
<p><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> error enumeration.</p>
<div class="refsect3">
<a name="ClutterScriptError.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-SCRIPT-ERROR-INVALID-TYPE-FUNCTION:CAPS"></a>CLUTTER_SCRIPT_ERROR_INVALID_TYPE_FUNCTION</p></td>
<td class="enum_member_description">
<p>Type function not found
or invalid</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-SCRIPT-ERROR-INVALID-PROPERTY:CAPS"></a>CLUTTER_SCRIPT_ERROR_INVALID_PROPERTY</p></td>
<td class="enum_member_description">
<p>Property not found or invalid</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-SCRIPT-ERROR-INVALID-VALUE:CAPS"></a>CLUTTER_SCRIPT_ERROR_INVALID_VALUE</p></td>
<td class="enum_member_description">
<p>Invalid value</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterScript.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterScript--filename"></a><h3>The <code class="literal">“filename”</code> property</h3>
<pre class="programlisting"> “filename” <span class="type">gchar</span> *</pre>
<p>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>
is <code class="literal">FALSE</code> then the value of this property is undefined.</p>
<p>Flags: Read</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterScript--filename-set"></a><h3>The <code class="literal">“filename-set”</code> property</h3>
<pre class="programlisting"> “filename-set” <span class="type">gboolean</span></pre>
<p>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
is <code class="literal">TRUE</code> then the currently parsed data comes from a file, and the
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.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterScript--translation-domain"></a><h3>The <code class="literal">“translation-domain”</code> property</h3>
<pre class="programlisting"> “translation-domain” <span class="type">gchar</span> *</pre>
<p>The translation domain, used to localize strings marked as translatable
inside a UI definition.</p>
<p>If <a class="link" href="ClutterScript.html#ClutterScript--translation-domain" title="The “translation-domain” property"><span class="type">“translation-domain”</span></a> is set to <code class="literal">NULL</code>, <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
will use <code class="function">gettext()</code>, otherwise <code class="function">g_dgettext()</code> will be used.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>