RubyGems - clutter - Versions diffs - 2.2.0-x86-mingw32 → 2.2.1-x86-mingw32 - Mend

clutter 2.2.0-x86-mingw32 → 2.2.1-x86-mingw32

Files changed (631) hide show

data/vendor/local/share/gtk-doc/html/clutter/ClutterScriptable.html CHANGED Viewed

@@ -8,21 +8,17 @@
 <link rel="up" href="ch11.html" title="User interface definition">
 <link rel="prev" href="ClutterScript.html" title="ClutterScript">
 <link rel="next" href="ch12.html" title="Generic list model">
-<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)">
+<meta name="generator" content="GTK-Doc V1.20.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="10"><tr valign="middle">
-<td width="100%" align="left">
-<a href="#" class="shortcut">Top</a>
-                   |
-                  <a href="#ClutterScriptable.description" class="shortcut">Description</a>
-                   |
-                  <a href="#ClutterScriptable.object-hierarchy" class="shortcut">Object Hierarchy</a>
-                   |
-                  <a href="#ClutterScriptable.prerequisites" class="shortcut">Prerequisites</a>
-                   |
-                  <a href="#ClutterScriptable.implementations" class="shortcut">Known Implementations</a>
+<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="#ClutterScriptable.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
+                  <a href="#ClutterScriptable.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites">  <span class="dim">|</span>
+                  <a href="#ClutterScriptable.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations">  <span class="dim">|</span>
+                  <a href="#ClutterScriptable.implementations" class="shortcut">Known Implementations</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>
@@ -36,33 +32,73 @@
 <h2><span class="refentrytitle"><a name="ClutterScriptable.top_of_page"></a>ClutterScriptable</span></h2>
 <p>ClutterScriptable — Override the UI definition parsing</p>
 </td>
-<td valign="top" align="right"></td>
+<td class="gallery_image" valign="top" align="right"></td>
 </tr></table></div>
-<div class="refsynopsisdiv">
-<a name="ClutterScriptable.synopsis"></a><h2>Synopsis</h2>
-<pre class="synopsis">                    <a class="link" href="ClutterScriptable.html#ClutterScriptable-struct" title="ClutterScriptable">ClutterScriptable</a>;
-struct              <a class="link" href="ClutterScriptable.html#ClutterScriptableIface" title="struct ClutterScriptableIface">ClutterScriptableIface</a>;
-<span class="returnvalue">void</span>                <a class="link" href="ClutterScriptable.html#clutter-scriptable-set-id" title="clutter_scriptable_set_id ()">clutter_scriptable_set_id</a>           (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>,
-                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id_</code></em>);
-const <span class="returnvalue">gchar</span> *       <a class="link" href="ClutterScriptable.html#clutter-scriptable-get-id" title="clutter_scriptable_get_id ()">clutter_scriptable_get_id</a>           (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>);
-<span class="returnvalue">gboolean</span>            <a class="link" href="ClutterScriptable.html#clutter-scriptable-parse-custom-node" title="clutter_scriptable_parse_custom_node ()">clutter_scriptable_parse_custom_node</a>
-                                                        (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>,
-                                                         <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">GValue</span> *value</code></em>,
-                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
-                                                         <em class="parameter"><code><span class="type">JsonNode</span> *node</code></em>);
-<span class="returnvalue">void</span>                <a class="link" href="ClutterScriptable.html#clutter-scriptable-set-custom-property" title="clutter_scriptable_set_custom_property ()">clutter_scriptable_set_custom_property</a>
-                                                        (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>,
-                                                         <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>const <span class="type">GValue</span> *value</code></em>);
-</pre>
+<div class="refsect1">
+<a name="ClutterScriptable.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_return">
+<col class="functions_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="function_type">
+<span class="returnvalue">void</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterScriptable.html#clutter-scriptable-set-id" title="clutter_scriptable_set_id ()">clutter_scriptable_set_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="ClutterScriptable.html#clutter-scriptable-get-id" title="clutter_scriptable_get_id ()">clutter_scriptable_get_id</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterScriptable.html#clutter-scriptable-parse-custom-node" title="clutter_scriptable_parse_custom_node ()">clutter_scriptable_parse_custom_node</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="ClutterScriptable.html#clutter-scriptable-set-custom-property" title="clutter_scriptable_set_custom_property ()">clutter_scriptable_set_custom_property</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="ClutterScriptable.other"></a><h2>Types and Values</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="name">
+<col class="description">
+</colgroup>
+<tbody>
+<tr>
+<td class="datatype_keyword"> </td>
+<td class="function_name"><a class="link" href="ClutterScriptable.html#ClutterScriptable-struct" title="ClutterScriptable">ClutterScriptable</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword">struct</td>
+<td class="function_name"><a class="link" href="ClutterScriptable.html#ClutterScriptableIface" title="struct ClutterScriptableIface">ClutterScriptableIface</a></td>
+</tr>
+</tbody>
+</table></div>
 </div>
 <div class="refsect1">
 <a name="ClutterScriptable.object-hierarchy"></a><h2>Object Hierarchy</h2>
-<pre class="synopsis">
-  GInterface
-   +----ClutterScriptable
+<pre class="screen">    GInterface
+    <span class="lineart">╰──</span> ClutterScriptable
 </pre>
 </div>
 <div class="refsect1">
@@ -79,230 +115,250 @@ ClutterScriptable is implemented by
 </div>
 <div class="refsect1">
 <a name="ClutterScriptable.description"></a><h2>Description</h2>
-<p>
-The <a class="link" href="ClutterScriptable.html#ClutterScriptableIface" title="struct ClutterScriptableIface"><span class="type">ClutterScriptableIface</span></a> interface exposes the UI definition parsing
+<p>The <a class="link" href="ClutterScriptable.html#ClutterScriptableIface" title="struct ClutterScriptableIface"><span class="type">ClutterScriptableIface</span></a> interface exposes the UI definition parsing
 process to external classes. By implementing this interface, a class can
 override the UI definition parsing and transform complex data types into
-GObject properties, or allow custom properties.
-</p>
-<p>
-<a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> is available since Clutter 0.6
-</p>
+GObject properties, or allow custom properties.</p>
+<p><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> is available since Clutter 0.6</p>
 </div>
 <div class="refsect1">
-<a name="ClutterScriptable.details"></a><h2>Details</h2>
-<div class="refsect2">
-<a name="ClutterScriptable-struct"></a><h3>ClutterScriptable</h3>
-<pre class="programlisting">typedef struct _ClutterScriptable ClutterScriptable;</pre>
-<p>
-<a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> is an opaque structure whose members cannot be directly
-accessed
-</p>
-<p class="since">Since 0.6</p>
-</div>
-<hr>
+<a name="ClutterScriptable.functions_details"></a><h2>Functions</h2>
 <div class="refsect2">
-<a name="ClutterScriptableIface"></a><h3>struct ClutterScriptableIface</h3>
-<pre class="programlisting">struct ClutterScriptableIface {
-  void         (* set_id)              (ClutterScriptable *scriptable,
-                                        const gchar       *id_);
-  const gchar *(* get_id)              (ClutterScriptable *scriptable);
-  gboolean     (* parse_custom_node)   (ClutterScriptable *scriptable,
-                                        ClutterScript     *script,
-                                        GValue            *value,
-                                        const gchar       *name,
-                                        JsonNode          *node);
-  void         (* set_custom_property) (ClutterScriptable *scriptable,
-                                        ClutterScript     *script,
-                                        const gchar       *name,
-                                        const GValue      *value);
-};
-</pre>
-<p>
-Interface for implementing "scriptable" objects. An object implementing
-this interface can override the parsing and properties setting sequence
-when loading a UI definition data with <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
-</p>
-<div class="variablelist"><table border="0" class="variablelist">
+<a name="clutter-scriptable-set-id"></a><h3>clutter_scriptable_set_id ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_scriptable_set_id (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>,
+                           <em class="parameter"><code>const <span class="type">gchar</span> *id_</code></em>);</pre>
+<p>Sets <em class="parameter"><code>id_</code></em>
+ as the unique Clutter script it for this instance of
+<a class="link" href="ClutterScriptable.html#ClutterScriptableIface" title="struct ClutterScriptableIface"><span class="type">ClutterScriptableIface</span></a>.</p>
+<p>This name can be used by user interface designer applications to
+define a unique name for an object constructable using the UI
+definition language parsed by <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>.</p>
+<div class="refsect3">
+<a name="id-1.7.3.3.9.2.6"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
 <colgroup>
-<col align="left" valign="top">
-<col>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
 </colgroup>
 <tbody>
 <tr>
-<td><p><span class="term"><em class="structfield"><code><a name="ClutterScriptableIface.set-id"></a>set_id</code></em> ()</span></p></td>
-<td>virtual function for setting the id of a scriptable object</td>
+<td class="parameter_name"><p>scriptable</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a></p></td>
+<td class="parameter_annotations"> </td>
 </tr>
 <tr>
-<td><p><span class="term"><em class="structfield"><code><a name="ClutterScriptableIface.get-id"></a>get_id</code></em> ()</span></p></td>
-<td>virtual function for getting the id of a scriptable object</td>
-</tr>
-<tr>
-<td><p><span class="term"><em class="structfield"><code><a name="ClutterScriptableIface.parse-custom-node"></a>parse_custom_node</code></em> ()</span></p></td>
-<td>virtual function for parsing complex data containers
-into GObject properties</td>
-</tr>
-<tr>
-<td><p><span class="term"><em class="structfield"><code><a name="ClutterScriptableIface.set-custom-property"></a>set_custom_property</code></em> ()</span></p></td>
-<td>virtual function for setting a custom property</td>
+<td class="parameter_name"><p>id_</p></td>
+<td class="parameter_description"><p>the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> id of the object</p></td>
+<td class="parameter_annotations"> </td>
 </tr>
 </tbody>
 </table></div>
+</div>
 <p class="since">Since 0.6</p>
 </div>
 <hr>
 <div class="refsect2">
-<a name="clutter-scriptable-set-id"></a><h3>clutter_scriptable_set_id ()</h3>
-<pre class="programlisting"><span class="returnvalue">void</span>                clutter_scriptable_set_id           (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>,
-                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id_</code></em>);</pre>
-<p>
-Sets <em class="parameter"><code>id_</code></em> as the unique Clutter script it for this instance of
-<a class="link" href="ClutterScriptable.html#ClutterScriptableIface" title="struct ClutterScriptableIface"><span class="type">ClutterScriptableIface</span></a>.
-</p>
-<p>
-This name can be used by user interface designer applications to
-define a unique name for an object constructable using the UI
-definition language parsed by <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>.
-</p>
-<div class="variablelist"><table border="0" class="variablelist">
+<a name="clutter-scriptable-get-id"></a><h3>clutter_scriptable_get_id ()</h3>
+<pre class="programlisting">const <span class="returnvalue">gchar</span> *
+clutter_scriptable_get_id (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>);</pre>
+<p>Retrieves the id of <em class="parameter"><code>scriptable</code></em>
+ set using <a class="link" href="ClutterScriptable.html#clutter-scriptable-set-id" title="clutter_scriptable_set_id ()"><code class="function">clutter_scriptable_set_id()</code></a>.</p>
+<div class="refsect3">
+<a name="id-1.7.3.3.9.3.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
 <colgroup>
-<col align="left" valign="top">
-<col>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
 </colgroup>
-<tbody>
-<tr>
-<td><p><span class="term"><em class="parameter"><code>scriptable</code></em> :</span></p></td>
-<td>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a>
-</td>
-</tr>
-<tr>
-<td><p><span class="term"><em class="parameter"><code>id_</code></em> :</span></p></td>
-<td>the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> id of the object</td>
-</tr>
-</tbody>
+<tbody><tr>
+<td class="parameter_name"><p>scriptable</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
 </table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.3.3.9.3.6"></a><h4>Returns</h4>
+<p> the id of the object. The returned string is owned by
+the scriptable object and should never be modified of freed</p>
+<p></p>
+</div>
 <p class="since">Since 0.6</p>
 </div>
 <hr>
 <div class="refsect2">
-<a name="clutter-scriptable-get-id"></a><h3>clutter_scriptable_get_id ()</h3>
-<pre class="programlisting">const <span class="returnvalue">gchar</span> *       clutter_scriptable_get_id           (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>);</pre>
-<p>
-Retrieves the id of <em class="parameter"><code>scriptable</code></em> set using <a class="link" href="ClutterScriptable.html#clutter-scriptable-set-id" title="clutter_scriptable_set_id ()"><code class="function">clutter_scriptable_set_id()</code></a>.
-</p>
-<div class="variablelist"><table border="0" class="variablelist">
+<a name="clutter-scriptable-parse-custom-node"></a><h3>clutter_scriptable_parse_custom_node ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+clutter_scriptable_parse_custom_node (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>,
+                                      <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">GValue</span> *value</code></em>,
+                                      <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
+                                      <em class="parameter"><code><span class="type">JsonNode</span> *node</code></em>);</pre>
+<p>Parses the passed JSON node. The implementation must set the type
+of the passed <span class="type">GValue</span> pointer using <code class="function">g_value_init()</code>.</p>
+<div class="refsect3">
+<a name="id-1.7.3.3.9.4.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
 <colgroup>
-<col align="left" valign="top">
-<col>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
 </colgroup>
 <tbody>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>scriptable</code></em> :</span></p></td>
-<td>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a>
-</td>
+<td class="parameter_name"><p>scriptable</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>script</p></td>
+<td class="parameter_description"><p>the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> creating the scriptable instance</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>value</p></td>
+<td class="parameter_description"><p>the generic value to be set</p></td>
+<td class="parameter_annotations"> </td>
 </tr>
 <tr>
-<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
-<td>the id of the object. The returned string is owned by
-the scriptable object and should never be modified of freed</td>
+<td class="parameter_name"><p>name</p></td>
+<td class="parameter_description"><p>the name of the node</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>node</p></td>
+<td class="parameter_description"><p>the JSON node to be parsed</p></td>
+<td class="parameter_annotations"> </td>
 </tr>
 </tbody>
 </table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.3.3.9.4.6"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> if the node was successfully parsed, <code class="literal">FALSE</code> otherwise.</p>
+<p></p>
+</div>
 <p class="since">Since 0.6</p>
 </div>
 <hr>
 <div class="refsect2">
-<a name="clutter-scriptable-parse-custom-node"></a><h3>clutter_scriptable_parse_custom_node ()</h3>
-<pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_scriptable_parse_custom_node
-                                                        (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>,
-                                                         <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">GValue</span> *value</code></em>,
-                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
-                                                         <em class="parameter"><code><span class="type">JsonNode</span> *node</code></em>);</pre>
-<p>
-Parses the passed JSON node. The implementation must set the type
-of the passed <span class="type">GValue</span> pointer using <code class="function">g_value_init()</code>.
-</p>
-<div class="variablelist"><table border="0" class="variablelist">
+<a name="clutter-scriptable-set-custom-property"></a><h3>clutter_scriptable_set_custom_property ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_scriptable_set_custom_property
+                               (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>,
+                                <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>const <span class="type">GValue</span> *value</code></em>);</pre>
+<p>Overrides the common properties setting. The underlying virtual
+function should be used when implementing custom properties.</p>
+<div class="refsect3">
+<a name="id-1.7.3.3.9.5.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
 <colgroup>
-<col align="left" valign="top">
-<col>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
 </colgroup>
 <tbody>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>scriptable</code></em> :</span></p></td>
-<td>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a>
-</td>
-</tr>
-<tr>
-<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
-<td>the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> creating the scriptable instance</td>
+<td class="parameter_name"><p>scriptable</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a></p></td>
+<td class="parameter_annotations"> </td>
 </tr>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
-<td>the generic value to be set</td>
+<td class="parameter_name"><p>script</p></td>
+<td class="parameter_description"><p>the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> creating the scriptable instance</p></td>
+<td class="parameter_annotations"> </td>
 </tr>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
-<td>the name of the node</td>
+<td class="parameter_name"><p>name</p></td>
+<td class="parameter_description"><p>the name of the property</p></td>
+<td class="parameter_annotations"> </td>
 </tr>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
-<td>the JSON node to be parsed</td>
-</tr>
-<tr>
-<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
-<td>
-<code class="literal">TRUE</code> if the node was successfully parsed, <code class="literal">FALSE</code> otherwise.</td>
+<td class="parameter_name"><p>value</p></td>
+<td class="parameter_description"><p>the value of the property</p></td>
+<td class="parameter_annotations"> </td>
 </tr>
 </tbody>
 </table></div>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="ClutterScriptable.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="ClutterScriptable-struct"></a><h3>ClutterScriptable</h3>
+<pre class="programlisting">typedef struct _ClutterScriptable ClutterScriptable;</pre>
+<p><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> is an opaque structure whose members cannot be directly
+accessed</p>
 <p class="since">Since 0.6</p>
 </div>
 <hr>
 <div class="refsect2">
-<a name="clutter-scriptable-set-custom-property"></a><h3>clutter_scriptable_set_custom_property ()</h3>
-<pre class="programlisting"><span class="returnvalue">void</span>                clutter_scriptable_set_custom_property
-                                                        (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>,
-                                                         <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>const <span class="type">GValue</span> *value</code></em>);</pre>
-<p>
-Overrides the common properties setting. The underlying virtual
-function should be used when implementing custom properties.
-</p>
-<div class="variablelist"><table border="0" class="variablelist">
+<a name="ClutterScriptableIface"></a><h3>struct ClutterScriptableIface</h3>
+<pre class="programlisting">struct ClutterScriptableIface {
+  void         (* set_id)              (ClutterScriptable *scriptable,
+                                        const gchar       *id_);
+  const gchar *(* get_id)              (ClutterScriptable *scriptable);
+  gboolean     (* parse_custom_node)   (ClutterScriptable *scriptable,
+                                        ClutterScript     *script,
+                                        GValue            *value,
+                                        const gchar       *name,
+                                        JsonNode          *node);
+  void         (* set_custom_property) (ClutterScriptable *scriptable,
+                                        ClutterScript     *script,
+                                        const gchar       *name,
+                                        const GValue      *value);
+};
+</pre>
+<p>Interface for implementing "scriptable" objects. An object implementing
+this interface can override the parsing and properties setting sequence
+when loading a UI definition data with <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p>
+<div class="refsect3">
+<a name="id-1.7.3.3.10.3.5"></a><h4>Members</h4>
+<div class="informaltable"><table width="100%" border="0">
 <colgroup>
-<col align="left" valign="top">
-<col>
+<col width="300px" class="struct_members_name">
+<col class="struct_members_description">
+<col width="200px" class="struct_members_annotations">
 </colgroup>
 <tbody>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>scriptable</code></em> :</span></p></td>
-<td>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a>
-</td>
+<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterScriptableIface.set-id"></a>set_id</code></em> ()</p></td>
+<td class="struct_member_description"><p>virtual function for setting the id of a scriptable object</p></td>
+<td class="struct_member_annotations"> </td>
 </tr>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
-<td>the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> creating the scriptable instance</td>
+<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterScriptableIface.get-id"></a>get_id</code></em> ()</p></td>
+<td class="struct_member_description"><p>virtual function for getting the id of a scriptable object</p></td>
+<td class="struct_member_annotations"> </td>
 </tr>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
-<td>the name of the property</td>
+<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterScriptableIface.parse-custom-node"></a>parse_custom_node</code></em> ()</p></td>
+<td class="struct_member_description"><p>virtual function for parsing complex data containers
+into GObject properties</p></td>
+<td class="struct_member_annotations"> </td>
 </tr>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
-<td>the value of the property</td>
+<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterScriptableIface.set-custom-property"></a>set_custom_property</code></em> ()</p></td>
+<td class="struct_member_description"><p>virtual function for setting a custom property</p></td>
+<td class="struct_member_annotations"> </td>
 </tr>
 </tbody>
 </table></div>
+</div>
 <p class="since">Since 0.6</p>
 </div>
 </div>
 </div>
 <div class="footer">
 <hr>
-          Generated by GTK-Doc V1.19.1</div>
+          Generated by GTK-Doc V1.20.1</div>
 </body>
 </html>