← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Emilio Pozuelo Monfort
  • Date: 2014-03-26 11:51:28 UTC
  • mfrom: (1.5.1) (4.1.30 experimental)
  • Revision ID: package-import@ubuntu.com-20140326115128-timmbsde8734o6wz
Tags: 1.18.0-1
* New upstream release.
* debian/control.in:
  + Bump gtk-doc-tools build dependency.
  + Also break libcogl15.
  + Standards-Version is 3.9.5, no changes needed.
* debian/libclutter-1.0-0.symbols:
  + Drop a few symbols that were accidentally exported in the DSO because
    they had a clutter_ prefix but were not in the public headers.
  + Add one new symbol.
  + Drop unnecessary debian revisions from some symbols.
* debian/control.in,
  debian/rules,
  debian/libclutter-1.0-0.symbols:
  + Temporarily disable evdev input support. It was only enabled in 1.17.6-1
    in experimental and there is nothing using it yet, and I would like to
    wait a bit before uploading libinput to unstable as the ABI isn't stable
    yet.
* d/p/0001-wayland-Add-missing-CLUTTER_AVAILABLE-annotations.patch:
  + Add missing annotations so that a few symbols are exported in the DSO.

* Upload to unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/clutter/html/ClutterScriptable.html
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>ClutterScriptable</title>
 
5
<title>Clutter Reference Manual: ClutterScriptable</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="Clutter Reference Manual">
8
8
<link rel="up" href="ch11.html" title="User interface definition">
9
9
<link rel="prev" href="ClutterScript.html" title="ClutterScript">
10
10
<link rel="next" href="ch12.html" title="Generic list model">
11
 
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.20.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="ClutterScript.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="ch11.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">Clutter Reference Manual</th>
21
 
<td><a accesskey="n" href="ch12.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#ClutterScriptable.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#ClutterScriptable.description" class="shortcut">Description</a>
27
 
                   | 
28
 
                  <a href="#ClutterScriptable.object-hierarchy" class="shortcut">Object Hierarchy</a>
29
 
                   | 
30
 
                  <a href="#ClutterScriptable.prerequisites" class="shortcut">Prerequisites</a>
31
 
                   | 
32
 
                  <a href="#ClutterScriptable.implementations" class="shortcut">Known Implementations</a>
33
 
</td></tr>
34
 
</table>
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
 
16
<td width="100%" align="left" class="shortcuts">
 
17
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
 
18
                  <a href="#ClutterScriptable.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
 
19
                  <a href="#ClutterScriptable.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites">  <span class="dim">|</span> 
 
20
                  <a href="#ClutterScriptable.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations">  <span class="dim">|</span> 
 
21
                  <a href="#ClutterScriptable.implementations" class="shortcut">Known Implementations</a></span>
 
22
</td>
 
23
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
 
24
<td><a accesskey="u" href="ch11.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
 
25
<td><a accesskey="p" href="ClutterScript.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
 
26
<td><a accesskey="n" href="ch12.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 
27
</tr></table>
35
28
<div class="refentry">
36
29
<a name="ClutterScriptable"></a><div class="titlepage"></div>
37
30
<div class="refnamediv"><table width="100%"><tr>
39
32
<h2><span class="refentrytitle"><a name="ClutterScriptable.top_of_page"></a>ClutterScriptable</span></h2>
40
33
<p>ClutterScriptable — Override the UI definition parsing</p>
41
34
</td>
42
 
<td valign="top" align="right"></td>
 
35
<td class="gallery_image" valign="top" align="right"></td>
43
36
</tr></table></div>
44
 
<div class="refsynopsisdiv">
45
 
<a name="ClutterScriptable.synopsis"></a><h2>Synopsis</h2>
46
 
<pre class="synopsis">                    <a class="link" href="ClutterScriptable.html#ClutterScriptable-struct" title="ClutterScriptable">ClutterScriptable</a>;
47
 
struct              <a class="link" href="ClutterScriptable.html#ClutterScriptableIface" title="struct ClutterScriptableIface">ClutterScriptableIface</a>;
48
 
<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>,
49
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id_</code></em>);
50
 
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>);
51
 
<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>
52
 
                                                        (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>,
53
 
                                                         <em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
54
 
                                                         <em class="parameter"><code><span class="type">GValue</span> *value</code></em>,
55
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
56
 
                                                         <em class="parameter"><code><span class="type">JsonNode</span> *node</code></em>);
57
 
<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>
58
 
                                                        (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>,
59
 
                                                         <em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
60
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
61
 
                                                         <em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);
62
 
</pre>
 
37
<div class="refsect1">
 
38
<a name="ClutterScriptable.functions"></a><h2>Functions</h2>
 
39
<div class="informaltable"><table width="100%" border="0">
 
40
<colgroup>
 
41
<col width="150px" class="functions_return">
 
42
<col class="functions_name">
 
43
</colgroup>
 
44
<tbody>
 
45
<tr>
 
46
<td class="function_type">
 
47
<span class="returnvalue">void</span>
 
48
</td>
 
49
<td class="function_name">
 
50
<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>
 
51
</td>
 
52
</tr>
 
53
<tr>
 
54
<td class="function_type">const <span class="returnvalue">gchar</span> *
 
55
</td>
 
56
<td class="function_name">
 
57
<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>
 
58
</td>
 
59
</tr>
 
60
<tr>
 
61
<td class="function_type">
 
62
<span class="returnvalue">gboolean</span>
 
63
</td>
 
64
<td class="function_name">
 
65
<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>
 
66
</td>
 
67
</tr>
 
68
<tr>
 
69
<td class="function_type">
 
70
<span class="returnvalue">void</span>
 
71
</td>
 
72
<td class="function_name">
 
73
<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>
 
74
</td>
 
75
</tr>
 
76
</tbody>
 
77
</table></div>
 
78
</div>
 
79
<div class="refsect1">
 
80
<a name="ClutterScriptable.other"></a><h2>Types and Values</h2>
 
81
<div class="informaltable"><table width="100%" border="0">
 
82
<colgroup>
 
83
<col width="150px" class="name">
 
84
<col class="description">
 
85
</colgroup>
 
86
<tbody>
 
87
<tr>
 
88
<td class="datatype_keyword"> </td>
 
89
<td class="function_name"><a class="link" href="ClutterScriptable.html#ClutterScriptable-struct" title="ClutterScriptable">ClutterScriptable</a></td>
 
90
</tr>
 
91
<tr>
 
92
<td class="datatype_keyword">struct</td>
 
93
<td class="function_name"><a class="link" href="ClutterScriptable.html#ClutterScriptableIface" title="struct ClutterScriptableIface">ClutterScriptableIface</a></td>
 
94
</tr>
 
95
</tbody>
 
96
</table></div>
63
97
</div>
64
98
<div class="refsect1">
65
99
<a name="ClutterScriptable.object-hierarchy"></a><h2>Object Hierarchy</h2>
66
 
<pre class="synopsis">
67
 
  GInterface
68
 
   +----ClutterScriptable
 
100
<pre class="screen">    GInterface
 
101
    <span class="lineart">╰──</span> ClutterScriptable
69
102
</pre>
70
103
</div>
71
104
<div class="refsect1">
78
111
<a name="ClutterScriptable.implementations"></a><h2>Known Implementations</h2>
79
112
<p>
80
113
ClutterScriptable is implemented by
81
 
 <a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>,  <a class="link" href="ClutterAlpha.html" title="ClutterAlpha">ClutterAlpha</a>,  <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation">ClutterAnimation</a>,  <a class="link" href="ClutterAnimator.html" title="ClutterAnimator">ClutterAnimator</a>,  <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a>,  <a class="link" href="ClutterBehaviourDepth.html" title="ClutterBehaviourDepth">ClutterBehaviourDepth</a>,  <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse">ClutterBehaviourEllipse</a>,  <a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity">ClutterBehaviourOpacity</a>,  <a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath">ClutterBehaviourPath</a>,  <a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate">ClutterBehaviourRotate</a>,  <a class="link" href="ClutterBehaviourScale.html" title="ClutterBehaviourScale">ClutterBehaviourScale</a>,  <a class="link" href="ClutterBox.html" title="ClutterBox">ClutterBox</a>,  <a class="link" href="ClutterCairoTexture.html" title="ClutterCairoTexture">ClutterCairoTexture</a>,  <a class="link" href="ClutterClone.html" title="ClutterClone">ClutterClone</a>,  <a class="link" href="ClutterGroup.html" title="ClutterGroup">ClutterGroup</a>,  <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition">ClutterKeyframeTransition</a>,  <a class="link" href="ClutterListModel.html" title="ClutterListModel">ClutterListModel</a>,  <a class="link" href="ClutterModel.html" title="ClutterModel">ClutterModel</a>,  <a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition">ClutterPropertyTransition</a>,  <a class="link" href="ClutterRectangle.html" title="ClutterRectangle">ClutterRectangle</a>,  <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor">ClutterScrollActor</a>,  <a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a>,  <a class="link" href="ClutterState.html" title="ClutterState">ClutterState</a>,  <a class="link" href="ClutterText.html" title="ClutterText">ClutterText</a>,  <a class="link" href="ClutterTexture.html" title="ClutterTexture">ClutterTexture</a>,  <a class="link" href="ClutterTimeline.html" title="ClutterTimeline">ClutterTimeline</a>,  <a class="link" href="ClutterTransition.html" title="ClutterTransition">ClutterTransition</a> and  <a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup">ClutterTransitionGroup</a>.</p>
 
114
 <a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>,  <a class="link" href="ClutterAlpha.html" title="ClutterAlpha">ClutterAlpha</a>,  <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation">ClutterAnimation</a>,  <a class="link" href="ClutterAnimator.html" title="ClutterAnimator">ClutterAnimator</a>,  <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a>,  <a class="link" href="ClutterBehaviourDepth.html" title="ClutterBehaviourDepth">ClutterBehaviourDepth</a>,  <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse">ClutterBehaviourEllipse</a>,  <a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity">ClutterBehaviourOpacity</a>,  <a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath">ClutterBehaviourPath</a>,  <a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate">ClutterBehaviourRotate</a>,  <a class="link" href="ClutterBehaviourScale.html" title="ClutterBehaviourScale">ClutterBehaviourScale</a>,  <a class="link" href="ClutterBox.html" title="ClutterBox">ClutterBox</a>,  <a class="link" href="ClutterCairoTexture.html" title="ClutterCairoTexture">ClutterCairoTexture</a>,  <a class="link" href="ClutterClone.html" title="ClutterClone">ClutterClone</a>,  <a class="link" href="ClutterGroup.html" title="ClutterGroup">ClutterGroup</a>,  <a class="link" href="clutter-Value-intervals.html#ClutterInterval">ClutterInterval</a>,  <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition">ClutterKeyframeTransition</a>,  <a class="link" href="ClutterListModel.html" title="ClutterListModel">ClutterListModel</a>,  <a class="link" href="ClutterModel.html" title="ClutterModel">ClutterModel</a>,  <a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition">ClutterPropertyTransition</a>,  <a class="link" href="ClutterRectangle.html" title="ClutterRectangle">ClutterRectangle</a>,  <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor">ClutterScrollActor</a>,  <a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a>,  <a class="link" href="ClutterState.html" title="ClutterState">ClutterState</a>,  <a class="link" href="ClutterText.html" title="ClutterText">ClutterText</a>,  <a class="link" href="ClutterTexture.html" title="ClutterTexture">ClutterTexture</a>,  <a class="link" href="ClutterTimeline.html" title="ClutterTimeline">ClutterTimeline</a>,  <a class="link" href="ClutterTransition.html" title="ClutterTransition">ClutterTransition</a> and  <a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup">ClutterTransitionGroup</a>.</p>
82
115
</div>
83
116
<div class="refsect1">
84
117
<a name="ClutterScriptable.description"></a><h2>Description</h2>
85
 
<p>
86
 
The <a class="link" href="ClutterScriptable.html#ClutterScriptableIface" title="struct ClutterScriptableIface"><span class="type">ClutterScriptableIface</span></a> interface exposes the UI definition parsing
 
118
<p>The <a class="link" href="ClutterScriptable.html#ClutterScriptableIface" title="struct ClutterScriptableIface"><span class="type">ClutterScriptableIface</span></a> interface exposes the UI definition parsing
87
119
process to external classes. By implementing this interface, a class can
88
120
override the UI definition parsing and transform complex data types into
89
 
GObject properties, or allow custom properties.
90
 
</p>
91
 
<p>
92
 
<a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> is available since Clutter 0.6
93
 
</p>
94
 
</div>
95
 
<div class="refsect1">
96
 
<a name="ClutterScriptable.details"></a><h2>Details</h2>
 
121
GObject properties, or allow custom properties.</p>
 
122
<p><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> is available since Clutter 0.6</p>
 
123
</div>
 
124
<div class="refsect1">
 
125
<a name="ClutterScriptable.functions_details"></a><h2>Functions</h2>
 
126
<div class="refsect2">
 
127
<a name="clutter-scriptable-set-id"></a><h3>clutter_scriptable_set_id ()</h3>
 
128
<pre class="programlisting"><span class="returnvalue">void</span>
 
129
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>,
 
130
                           <em class="parameter"><code>const <span class="type">gchar</span> *id_</code></em>);</pre>
 
131
<p>Sets <em class="parameter"><code>id_</code></em>
 
132
 as the unique Clutter script it for this instance of
 
133
<a class="link" href="ClutterScriptable.html#ClutterScriptableIface" title="struct ClutterScriptableIface"><span class="type">ClutterScriptableIface</span></a>.</p>
 
134
<p>This name can be used by user interface designer applications to
 
135
define a unique name for an object constructable using the UI
 
136
definition language parsed by <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>.</p>
 
137
<div class="refsect3">
 
138
<a name="id-1.7.3.3.9.2.6"></a><h4>Parameters</h4>
 
139
<div class="informaltable"><table width="100%" border="0">
 
140
<colgroup>
 
141
<col width="150px" class="parameters_name">
 
142
<col class="parameters_description">
 
143
<col width="200px" class="parameters_annotations">
 
144
</colgroup>
 
145
<tbody>
 
146
<tr>
 
147
<td class="parameter_name"><p>scriptable</p></td>
 
148
<td class="parameter_description"><p>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a></p></td>
 
149
<td class="parameter_annotations"> </td>
 
150
</tr>
 
151
<tr>
 
152
<td class="parameter_name"><p>id_</p></td>
 
153
<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>
 
154
<td class="parameter_annotations"> </td>
 
155
</tr>
 
156
</tbody>
 
157
</table></div>
 
158
</div>
 
159
<p class="since">Since 0.6</p>
 
160
</div>
 
161
<hr>
 
162
<div class="refsect2">
 
163
<a name="clutter-scriptable-get-id"></a><h3>clutter_scriptable_get_id ()</h3>
 
164
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
 
165
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>
 
166
<p>Retrieves the id of <em class="parameter"><code>scriptable</code></em>
 
167
 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>
 
168
<div class="refsect3">
 
169
<a name="id-1.7.3.3.9.3.5"></a><h4>Parameters</h4>
 
170
<div class="informaltable"><table width="100%" border="0">
 
171
<colgroup>
 
172
<col width="150px" class="parameters_name">
 
173
<col class="parameters_description">
 
174
<col width="200px" class="parameters_annotations">
 
175
</colgroup>
 
176
<tbody><tr>
 
177
<td class="parameter_name"><p>scriptable</p></td>
 
178
<td class="parameter_description"><p>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a></p></td>
 
179
<td class="parameter_annotations"> </td>
 
180
</tr></tbody>
 
181
</table></div>
 
182
</div>
 
183
<div class="refsect3">
 
184
<a name="id-1.7.3.3.9.3.6"></a><h4>Returns</h4>
 
185
<p> the id of the object. The returned string is owned by
 
186
the scriptable object and should never be modified of freed</p>
 
187
<p></p>
 
188
</div>
 
189
<p class="since">Since 0.6</p>
 
190
</div>
 
191
<hr>
 
192
<div class="refsect2">
 
193
<a name="clutter-scriptable-parse-custom-node"></a><h3>clutter_scriptable_parse_custom_node ()</h3>
 
194
<pre class="programlisting"><span class="returnvalue">gboolean</span>
 
195
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>,
 
196
                                      <em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
 
197
                                      <em class="parameter"><code><span class="type">GValue</span> *value</code></em>,
 
198
                                      <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
 
199
                                      <em class="parameter"><code><span class="type">JsonNode</span> *node</code></em>);</pre>
 
200
<p>Parses the passed JSON node. The implementation must set the type
 
201
of the passed <span class="type">GValue</span> pointer using <code class="function">g_value_init()</code>.</p>
 
202
<div class="refsect3">
 
203
<a name="id-1.7.3.3.9.4.5"></a><h4>Parameters</h4>
 
204
<div class="informaltable"><table width="100%" border="0">
 
205
<colgroup>
 
206
<col width="150px" class="parameters_name">
 
207
<col class="parameters_description">
 
208
<col width="200px" class="parameters_annotations">
 
209
</colgroup>
 
210
<tbody>
 
211
<tr>
 
212
<td class="parameter_name"><p>scriptable</p></td>
 
213
<td class="parameter_description"><p>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a></p></td>
 
214
<td class="parameter_annotations"> </td>
 
215
</tr>
 
216
<tr>
 
217
<td class="parameter_name"><p>script</p></td>
 
218
<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>
 
219
<td class="parameter_annotations"> </td>
 
220
</tr>
 
221
<tr>
 
222
<td class="parameter_name"><p>value</p></td>
 
223
<td class="parameter_description"><p>the generic value to be set</p></td>
 
224
<td class="parameter_annotations"> </td>
 
225
</tr>
 
226
<tr>
 
227
<td class="parameter_name"><p>name</p></td>
 
228
<td class="parameter_description"><p>the name of the node</p></td>
 
229
<td class="parameter_annotations"> </td>
 
230
</tr>
 
231
<tr>
 
232
<td class="parameter_name"><p>node</p></td>
 
233
<td class="parameter_description"><p>the JSON node to be parsed</p></td>
 
234
<td class="parameter_annotations"> </td>
 
235
</tr>
 
236
</tbody>
 
237
</table></div>
 
238
</div>
 
239
<div class="refsect3">
 
240
<a name="id-1.7.3.3.9.4.6"></a><h4>Returns</h4>
 
241
<p> <code class="literal">TRUE</code> if the node was successfully parsed, <code class="literal">FALSE</code> otherwise.</p>
 
242
<p></p>
 
243
</div>
 
244
<p class="since">Since 0.6</p>
 
245
</div>
 
246
<hr>
 
247
<div class="refsect2">
 
248
<a name="clutter-scriptable-set-custom-property"></a><h3>clutter_scriptable_set_custom_property ()</h3>
 
249
<pre class="programlisting"><span class="returnvalue">void</span>
 
250
clutter_scriptable_set_custom_property
 
251
                               (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>,
 
252
                                <em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
 
253
                                <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
 
254
                                <em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);</pre>
 
255
<p>Overrides the common properties setting. The underlying virtual
 
256
function should be used when implementing custom properties.</p>
 
257
<div class="refsect3">
 
258
<a name="id-1.7.3.3.9.5.5"></a><h4>Parameters</h4>
 
259
<div class="informaltable"><table width="100%" border="0">
 
260
<colgroup>
 
261
<col width="150px" class="parameters_name">
 
262
<col class="parameters_description">
 
263
<col width="200px" class="parameters_annotations">
 
264
</colgroup>
 
265
<tbody>
 
266
<tr>
 
267
<td class="parameter_name"><p>scriptable</p></td>
 
268
<td class="parameter_description"><p>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a></p></td>
 
269
<td class="parameter_annotations"> </td>
 
270
</tr>
 
271
<tr>
 
272
<td class="parameter_name"><p>script</p></td>
 
273
<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>
 
274
<td class="parameter_annotations"> </td>
 
275
</tr>
 
276
<tr>
 
277
<td class="parameter_name"><p>name</p></td>
 
278
<td class="parameter_description"><p>the name of the property</p></td>
 
279
<td class="parameter_annotations"> </td>
 
280
</tr>
 
281
<tr>
 
282
<td class="parameter_name"><p>value</p></td>
 
283
<td class="parameter_description"><p>the value of the property</p></td>
 
284
<td class="parameter_annotations"> </td>
 
285
</tr>
 
286
</tbody>
 
287
</table></div>
 
288
</div>
 
289
<p class="since">Since 0.6</p>
 
290
</div>
 
291
</div>
 
292
<div class="refsect1">
 
293
<a name="ClutterScriptable.other_details"></a><h2>Types and Values</h2>
97
294
<div class="refsect2">
98
295
<a name="ClutterScriptable-struct"></a><h3>ClutterScriptable</h3>
99
296
<pre class="programlisting">typedef struct _ClutterScriptable ClutterScriptable;</pre>
100
 
<p>
101
 
<a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> is an opaque structure whose members cannot be directly
102
 
accessed
103
 
</p>
 
297
<p><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> is an opaque structure whose members cannot be directly
 
298
accessed</p>
104
299
<p class="since">Since 0.6</p>
105
300
</div>
106
301
<hr>
122
317
                                        const GValue      *value);
123
318
};
124
319
</pre>
125
 
<p>
126
 
Interface for implementing "scriptable" objects. An object implementing
 
320
<p>Interface for implementing "scriptable" objects. An object implementing
127
321
this interface can override the parsing and properties setting sequence
128
 
when loading a UI definition data with <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
129
 
</p>
130
 
<div class="variablelist"><table border="0" class="variablelist">
131
 
<colgroup>
132
 
<col align="left" valign="top">
133
 
<col>
134
 
</colgroup>
135
 
<tbody>
136
 
<tr>
137
 
<td><p><span class="term"><em class="structfield"><code><a name="ClutterScriptableIface.set-id"></a>set_id</code></em> ()</span></p></td>
138
 
<td>virtual function for setting the id of a scriptable object</td>
139
 
</tr>
140
 
<tr>
141
 
<td><p><span class="term"><em class="structfield"><code><a name="ClutterScriptableIface.get-id"></a>get_id</code></em> ()</span></p></td>
142
 
<td>virtual function for getting the id of a scriptable object</td>
143
 
</tr>
144
 
<tr>
145
 
<td><p><span class="term"><em class="structfield"><code><a name="ClutterScriptableIface.parse-custom-node"></a>parse_custom_node</code></em> ()</span></p></td>
146
 
<td>virtual function for parsing complex data containers
147
 
into GObject properties</td>
148
 
</tr>
149
 
<tr>
150
 
<td><p><span class="term"><em class="structfield"><code><a name="ClutterScriptableIface.set-custom-property"></a>set_custom_property</code></em> ()</span></p></td>
151
 
<td>virtual function for setting a custom property</td>
152
 
</tr>
153
 
</tbody>
154
 
</table></div>
155
 
<p class="since">Since 0.6</p>
156
 
</div>
157
 
<hr>
158
 
<div class="refsect2">
159
 
<a name="clutter-scriptable-set-id"></a><h3>clutter_scriptable_set_id ()</h3>
160
 
<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>,
161
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id_</code></em>);</pre>
162
 
<p>
163
 
Sets <em class="parameter"><code>id_</code></em> as the unique Clutter script it for this instance of
164
 
<a class="link" href="ClutterScriptable.html#ClutterScriptableIface" title="struct ClutterScriptableIface"><span class="type">ClutterScriptableIface</span></a>.
165
 
</p>
166
 
<p>
167
 
This name can be used by user interface designer applications to
168
 
define a unique name for an object constructable using the UI
169
 
definition language parsed by <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>.
170
 
</p>
171
 
<div class="variablelist"><table border="0" class="variablelist">
172
 
<colgroup>
173
 
<col align="left" valign="top">
174
 
<col>
175
 
</colgroup>
176
 
<tbody>
177
 
<tr>
178
 
<td><p><span class="term"><em class="parameter"><code>scriptable</code></em> :</span></p></td>
179
 
<td>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a>
180
 
</td>
181
 
</tr>
182
 
<tr>
183
 
<td><p><span class="term"><em class="parameter"><code>id_</code></em> :</span></p></td>
184
 
<td>the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> id of the object</td>
185
 
</tr>
186
 
</tbody>
187
 
</table></div>
188
 
<p class="since">Since 0.6</p>
189
 
</div>
190
 
<hr>
191
 
<div class="refsect2">
192
 
<a name="clutter-scriptable-get-id"></a><h3>clutter_scriptable_get_id ()</h3>
193
 
<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>
194
 
<p>
195
 
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>.
196
 
</p>
197
 
<div class="variablelist"><table border="0" class="variablelist">
198
 
<colgroup>
199
 
<col align="left" valign="top">
200
 
<col>
201
 
</colgroup>
202
 
<tbody>
203
 
<tr>
204
 
<td><p><span class="term"><em class="parameter"><code>scriptable</code></em> :</span></p></td>
205
 
<td>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a>
206
 
</td>
207
 
</tr>
208
 
<tr>
209
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
210
 
<td>the id of the object. The returned string is owned by
211
 
the scriptable object and should never be modified of freed</td>
212
 
</tr>
213
 
</tbody>
214
 
</table></div>
215
 
<p class="since">Since 0.6</p>
216
 
</div>
217
 
<hr>
218
 
<div class="refsect2">
219
 
<a name="clutter-scriptable-parse-custom-node"></a><h3>clutter_scriptable_parse_custom_node ()</h3>
220
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_scriptable_parse_custom_node
221
 
                                                        (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>,
222
 
                                                         <em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
223
 
                                                         <em class="parameter"><code><span class="type">GValue</span> *value</code></em>,
224
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
225
 
                                                         <em class="parameter"><code><span class="type">JsonNode</span> *node</code></em>);</pre>
226
 
<p>
227
 
Parses the passed JSON node. The implementation must set the type
228
 
of the passed <span class="type">GValue</span> pointer using <code class="function">g_value_init()</code>.
229
 
</p>
230
 
<div class="variablelist"><table border="0" class="variablelist">
231
 
<colgroup>
232
 
<col align="left" valign="top">
233
 
<col>
234
 
</colgroup>
235
 
<tbody>
236
 
<tr>
237
 
<td><p><span class="term"><em class="parameter"><code>scriptable</code></em> :</span></p></td>
238
 
<td>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a>
239
 
</td>
240
 
</tr>
241
 
<tr>
242
 
<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
243
 
<td>the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> creating the scriptable instance</td>
244
 
</tr>
245
 
<tr>
246
 
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
247
 
<td>the generic value to be set</td>
248
 
</tr>
249
 
<tr>
250
 
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
251
 
<td>the name of the node</td>
252
 
</tr>
253
 
<tr>
254
 
<td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
255
 
<td>the JSON node to be parsed</td>
256
 
</tr>
257
 
<tr>
258
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
259
 
<td>
260
 
<code class="literal">TRUE</code> if the node was successfully parsed, <code class="literal">FALSE</code> otherwise.</td>
261
 
</tr>
262
 
</tbody>
263
 
</table></div>
264
 
<p class="since">Since 0.6</p>
265
 
</div>
266
 
<hr>
267
 
<div class="refsect2">
268
 
<a name="clutter-scriptable-set-custom-property"></a><h3>clutter_scriptable_set_custom_property ()</h3>
269
 
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_scriptable_set_custom_property
270
 
                                                        (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>,
271
 
                                                         <em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
272
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
273
 
                                                         <em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);</pre>
274
 
<p>
275
 
Overrides the common properties setting. The underlying virtual
276
 
function should be used when implementing custom properties.
277
 
</p>
278
 
<div class="variablelist"><table border="0" class="variablelist">
279
 
<colgroup>
280
 
<col align="left" valign="top">
281
 
<col>
282
 
</colgroup>
283
 
<tbody>
284
 
<tr>
285
 
<td><p><span class="term"><em class="parameter"><code>scriptable</code></em> :</span></p></td>
286
 
<td>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a>
287
 
</td>
288
 
</tr>
289
 
<tr>
290
 
<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
291
 
<td>the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> creating the scriptable instance</td>
292
 
</tr>
293
 
<tr>
294
 
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
295
 
<td>the name of the property</td>
296
 
</tr>
297
 
<tr>
298
 
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
299
 
<td>the value of the property</td>
300
 
</tr>
301
 
</tbody>
302
 
</table></div>
 
322
when loading a UI definition data with <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p>
 
323
<div class="refsect3">
 
324
<a name="id-1.7.3.3.10.3.5"></a><h4>Members</h4>
 
325
<div class="informaltable"><table width="100%" border="0">
 
326
<colgroup>
 
327
<col width="300px" class="struct_members_name">
 
328
<col class="struct_members_description">
 
329
<col width="200px" class="struct_members_annotations">
 
330
</colgroup>
 
331
<tbody>
 
332
<tr>
 
333
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterScriptableIface.set-id"></a>set_id</code></em> ()</p></td>
 
334
<td class="struct_member_description"><p>virtual function for setting the id of a scriptable object</p></td>
 
335
<td class="struct_member_annotations"> </td>
 
336
</tr>
 
337
<tr>
 
338
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterScriptableIface.get-id"></a>get_id</code></em> ()</p></td>
 
339
<td class="struct_member_description"><p>virtual function for getting the id of a scriptable object</p></td>
 
340
<td class="struct_member_annotations"> </td>
 
341
</tr>
 
342
<tr>
 
343
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterScriptableIface.parse-custom-node"></a>parse_custom_node</code></em> ()</p></td>
 
344
<td class="struct_member_description"><p>virtual function for parsing complex data containers
 
345
into GObject properties</p></td>
 
346
<td class="struct_member_annotations"> </td>
 
347
</tr>
 
348
<tr>
 
349
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterScriptableIface.set-custom-property"></a>set_custom_property</code></em> ()</p></td>
 
350
<td class="struct_member_description"><p>virtual function for setting a custom property</p></td>
 
351
<td class="struct_member_annotations"> </td>
 
352
</tr>
 
353
</tbody>
 
354
</table></div>
 
355
</div>
303
356
<p class="since">Since 0.6</p>
304
357
</div>
305
358
</div>
306
359
</div>
307
360
<div class="footer">
308
361
<hr>
309
 
          Generated by GTK-Doc V1.18.1</div>
 
362
          Generated by GTK-Doc V1.20.1</div>
310
363
</body>
311
364
</html>
 
 
b'\\ No newline at end of file'