1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>ClutterActorMeta</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="Clutter Reference Manual">
8 <link rel="up" href="ch01.html" title="Abstract classes and interfaces">
9 <link rel="prev" href="ClutterLayoutMeta.html" title="ClutterLayoutMeta">
10 <link rel="next" href="ClutterAction.html" title="ClutterAction">
11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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">
17 <td><a accesskey="p" href="ClutterLayoutMeta.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch01.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="ClutterAction.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#ClutterActorMeta.synopsis" class="shortcut">Top</a>
26 <a href="#ClutterActorMeta.description" class="shortcut">Description</a>
28 <a href="#ClutterActorMeta.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#ClutterActorMeta.properties" class="shortcut">Properties</a>
33 <div class="refentry">
34 <a name="ClutterActorMeta"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
37 <h2><span class="refentrytitle"><a name="ClutterActorMeta.top_of_page"></a>ClutterActorMeta</span></h2>
38 <p>ClutterActorMeta — Base class of actor modifiers</p>
40 <td valign="top" align="right"></td>
42 <div class="refsynopsisdiv">
43 <a name="ClutterActorMeta.synopsis"></a><h2>Synopsis</h2>
44 <pre class="synopsis"> <a class="link" href="ClutterActorMeta.html#ClutterActorMeta-struct" title="ClutterActorMeta">ClutterActorMeta</a>;
45 struct <a class="link" href="ClutterActorMeta.html#ClutterActorMetaClass" title="struct ClutterActorMetaClass">ClutterActorMetaClass</a>;
46 <span class="returnvalue">void</span> <a class="link" href="ClutterActorMeta.html#clutter-actor-meta-set-name" title="clutter_actor_meta_set_name ()">clutter_actor_meta_set_name</a> (<em class="parameter"><code><a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> *meta</code></em>,
47 <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
48 const <span class="returnvalue">gchar</span> * <a class="link" href="ClutterActorMeta.html#clutter-actor-meta-get-name" title="clutter_actor_meta_get_name ()">clutter_actor_meta_get_name</a> (<em class="parameter"><code><a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> *meta</code></em>);
49 <span class="returnvalue">void</span> <a class="link" href="ClutterActorMeta.html#clutter-actor-meta-set-enabled" title="clutter_actor_meta_set_enabled ()">clutter_actor_meta_set_enabled</a> (<em class="parameter"><code><a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> *meta</code></em>,
50 <em class="parameter"><code><span class="type">gboolean</span> is_enabled</code></em>);
51 <span class="returnvalue">gboolean</span> <a class="link" href="ClutterActorMeta.html#clutter-actor-meta-get-enabled" title="clutter_actor_meta_get_enabled ()">clutter_actor_meta_get_enabled</a> (<em class="parameter"><code><a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> *meta</code></em>);
53 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> * <a class="link" href="ClutterActorMeta.html#clutter-actor-meta-get-actor" title="clutter_actor_meta_get_actor ()">clutter_actor_meta_get_actor</a> (<em class="parameter"><code><a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> *meta</code></em>);
56 <div class="refsect1">
57 <a name="ClutterActorMeta.object-hierarchy"></a><h2>Object Hierarchy</h2>
58 <pre class="synopsis">
60 +----GInitiallyUnowned
62 +----<a class="link" href="ClutterAction.html" title="ClutterAction">ClutterAction</a>
63 +----<a class="link" href="ClutterConstraint.html" title="ClutterConstraint">ClutterConstraint</a>
64 +----<a class="link" href="ClutterEffect.html" title="ClutterEffect">ClutterEffect</a>
67 <div class="refsect1">
68 <a name="ClutterActorMeta.properties"></a><h2>Properties</h2>
69 <pre class="synopsis">
70 "<a class="link" href="ClutterActorMeta.html#ClutterActorMeta--actor" title='The "actor" property'>actor</a>" <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>* : Read
71 "<a class="link" href="ClutterActorMeta.html#ClutterActorMeta--enabled" title='The "enabled" property'>enabled</a>" <span class="type">gboolean</span> : Read / Write
72 "<a class="link" href="ClutterActorMeta.html#ClutterActorMeta--name" title='The "name" property'>name</a>" <span class="type">gchar</span>* : Read / Write
75 <div class="refsect1">
76 <a name="ClutterActorMeta.description"></a><h2>Description</h2>
78 <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> is an abstract class providing a common API for
79 modifiers of <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> behaviour, appearance or layout.
82 A <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> can only be owned by a single <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> at
86 Every sub-class of <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> should check if the
87 <a class="link" href="ClutterActorMeta.html#ClutterActorMeta--enabled" title='The "enabled" property'><span class="type">"enabled"</span></a> property is set to <code class="literal">TRUE</code> before applying
88 any kind of modification.
91 <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> is available since Clutter 1.4
94 <div class="refsect1">
95 <a name="ClutterActorMeta.details"></a><h2>Details</h2>
96 <div class="refsect2">
97 <a name="ClutterActorMeta-struct"></a><h3>ClutterActorMeta</h3>
98 <pre class="programlisting">typedef struct _ClutterActorMeta ClutterActorMeta;</pre>
100 The <span class="structname">ClutterActorMeta</span> structure contains only
101 private data and should be accessed using the provided API
103 <p class="since">Since 1.4</p>
106 <div class="refsect2">
107 <a name="ClutterActorMetaClass"></a><h3>struct ClutterActorMetaClass</h3>
108 <pre class="programlisting">struct ClutterActorMetaClass {
110 * ClutterActorMetaClass::set_actor:
111 * @meta: a #ClutterActorMeta
112 * @actor: (allow-none): the actor attached to @meta, or %NULL
114 * Virtual function, called when @meta is attached or detached
115 * from a #ClutterActor.
117 void (* set_actor) (ClutterActorMeta *meta,
118 ClutterActor *actor);
122 The <span class="structname">ClutterActorMetaClass</span> structure contains
125 <div class="variablelist"><table border="0">
126 <col align="left" valign="top">
128 <td><p><span class="term"><em class="structfield"><code><a name="ClutterActorMetaClass.set-actor"></a>set_actor</code></em> ()</span></p></td>
129 <td>virtual function, invoked when attaching and detaching
130 a <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> instance to a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>
134 <p class="since">Since 1.4</p>
137 <div class="refsect2">
138 <a name="clutter-actor-meta-set-name"></a><h3>clutter_actor_meta_set_name ()</h3>
139 <pre class="programlisting"><span class="returnvalue">void</span> clutter_actor_meta_set_name (<em class="parameter"><code><a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> *meta</code></em>,
140 <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
142 Sets the name of <em class="parameter"><code>meta</code></em>
145 The name can be used to identify the <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> instance
147 <div class="variablelist"><table border="0">
148 <col align="left" valign="top">
151 <td><p><span class="term"><em class="parameter"><code>meta</code></em> :</span></p></td>
152 <td>a <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a>
156 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
157 <td>the name of <em class="parameter"><code>meta</code></em>
162 <p class="since">Since 1.4</p>
165 <div class="refsect2">
166 <a name="clutter-actor-meta-get-name"></a><h3>clutter_actor_meta_get_name ()</h3>
167 <pre class="programlisting">const <span class="returnvalue">gchar</span> * clutter_actor_meta_get_name (<em class="parameter"><code><a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> *meta</code></em>);</pre>
169 Retrieves the name set using <a class="link" href="ClutterActorMeta.html#clutter-actor-meta-set-name" title="clutter_actor_meta_set_name ()"><code class="function">clutter_actor_meta_set_name()</code></a>
171 <div class="variablelist"><table border="0">
172 <col align="left" valign="top">
175 <td><p><span class="term"><em class="parameter"><code>meta</code></em> :</span></p></td>
176 <td>a <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a>
180 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
181 <td>the name of the <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a>
182 instance, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if none was set. The returned string is owned
183 by the <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> instance and it should not be modified
184 or freed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
189 <p class="since">Since 1.4</p>
192 <div class="refsect2">
193 <a name="clutter-actor-meta-set-enabled"></a><h3>clutter_actor_meta_set_enabled ()</h3>
194 <pre class="programlisting"><span class="returnvalue">void</span> clutter_actor_meta_set_enabled (<em class="parameter"><code><a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> *meta</code></em>,
195 <em class="parameter"><code><span class="type">gboolean</span> is_enabled</code></em>);</pre>
197 Sets whether <em class="parameter"><code>meta</code></em> should be enabled or not
199 <div class="variablelist"><table border="0">
200 <col align="left" valign="top">
203 <td><p><span class="term"><em class="parameter"><code>meta</code></em> :</span></p></td>
204 <td>a <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a>
208 <td><p><span class="term"><em class="parameter"><code>is_enabled</code></em> :</span></p></td>
209 <td>whether <em class="parameter"><code>meta</code></em> is enabled</td>
213 <p class="since">Since 1.4</p>
216 <div class="refsect2">
217 <a name="clutter-actor-meta-get-enabled"></a><h3>clutter_actor_meta_get_enabled ()</h3>
218 <pre class="programlisting"><span class="returnvalue">gboolean</span> clutter_actor_meta_get_enabled (<em class="parameter"><code><a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> *meta</code></em>);</pre>
220 Retrieves whether <em class="parameter"><code>meta</code></em> is enabled
222 <div class="variablelist"><table border="0">
223 <col align="left" valign="top">
226 <td><p><span class="term"><em class="parameter"><code>meta</code></em> :</span></p></td>
227 <td>a <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a>
231 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
233 <code class="literal">TRUE</code> if the <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> instance is enabled</td>
237 <p class="since">Since 1.4</p>
240 <div class="refsect2">
241 <a name="clutter-actor-meta-get-actor"></a><h3>clutter_actor_meta_get_actor ()</h3>
242 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> * clutter_actor_meta_get_actor (<em class="parameter"><code><a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> *meta</code></em>);</pre>
244 Retrieves a pointer to the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> that owns <em class="parameter"><code>meta</code></em>
246 <div class="variablelist"><table border="0">
247 <col align="left" valign="top">
250 <td><p><span class="term"><em class="parameter"><code>meta</code></em> :</span></p></td>
251 <td>a <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a>
255 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
256 <td>a pointer to a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
261 <p class="since">Since 1.4</p>
264 <div class="refsect1">
265 <a name="ClutterActorMeta.property-details"></a><h2>Property Details</h2>
266 <div class="refsect2">
267 <a name="ClutterActorMeta--actor"></a><h3>The <code class="literal">"actor"</code> property</h3>
268 <pre class="programlisting"> "actor" <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>* : Read</pre>
270 The <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> attached to the <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> instance
272 <p class="since">Since 1.4</p>
275 <div class="refsect2">
276 <a name="ClutterActorMeta--enabled"></a><h3>The <code class="literal">"enabled"</code> property</h3>
277 <pre class="programlisting"> "enabled" <span class="type">gboolean</span> : Read / Write</pre>
279 Whether or not the <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> is enabled
281 <p>Default value: TRUE</p>
282 <p class="since">Since 1.4</p>
285 <div class="refsect2">
286 <a name="ClutterActorMeta--name"></a><h3>The <code class="literal">"name"</code> property</h3>
287 <pre class="programlisting"> "name" <span class="type">gchar</span>* : Read / Write</pre>
289 The unique name to access the <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a>
291 <p>Default value: NULL</p>
292 <p class="since">Since 1.4</p>
295 <div class="refsect1">
296 <a name="ClutterActorMeta.see-also"></a><h2>See Also</h2>
297 <a class="link" href="ClutterAction.html" title="ClutterAction"><span class="type">ClutterAction</span></a>, <a class="link" href="ClutterConstraint.html" title="ClutterConstraint"><span class="type">ClutterConstraint</span></a>
302 Generated by GTK-Doc V1.18.1</div>