doc/reference/clutter/html/ClutterActorMeta.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   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">
  13 </head>
  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="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>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#ClutterActorMeta.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterActorMeta.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterActorMeta.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterActorMeta.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="ClutterActorMeta"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="ClutterActorMeta.top_of_page"></a>ClutterActorMeta</span></h2>
  38 <p>ClutterActorMeta — Base class of actor modifiers</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  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 <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
  48 const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <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><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> is_enabled</code></em>);
  51 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <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>);
  52
  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>);
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="ClutterActorMeta.object-hierarchy"></a><h2>Object Hierarchy</h2>
  58 <pre class="synopsis">
  59   <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  60    +----<a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
  61          +----ClutterActorMeta
  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>
  65 </pre>
  66 </div>
  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>"                  <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  72   "<a class="link" href="ClutterActorMeta.html#ClutterActorMeta--name" title='The "name" property'>name</a>"                     <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  73 </pre>
  74 </div>
  75 <div class="refsect1">
  76 <a name="ClutterActorMeta.description"></a><h2>Description</h2>
  77 <p>
  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.
  80 </p>
  81 <p>
  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
  83 any time.
  84 </p>
  85 <p>
  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 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> before applying
  88 any kind of modification.
  89 </p>
  90 <p>
  91 <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> is available since Clutter 1.4
  92 </p>
  93 </div>
  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>
  99 <p>
 100 The <span class="structname">ClutterActorMeta</span> structure contains only
 101 private data and should be accessed using the provided API
 102 </p>
 103 <p class="since">Since 1.4</p>
 104 </div>
 105 <hr>
 106 <div class="refsect2">
 107 <a name="ClutterActorMetaClass"></a><h3>struct ClutterActorMetaClass</h3>
 108 <pre class="programlisting">struct ClutterActorMetaClass {
 109   /**
 110    * ClutterActorMetaClass::set_actor:
 111    * @meta: a #ClutterActorMeta
 112    * @actor: (allow-none): the actor attached to @meta, or %NULL
 113    *
 114    * Virtual function, called when @meta is attached or detached
 115    * from a #ClutterActor.
 116    */
 117   void (* set_actor) (ClutterActorMeta *meta,
 118                       ClutterActor     *actor);
 119 };
 120 </pre>
 121 <p>
 122 The <span class="structname">ClutterActorMetaClass</span> structure contains
 123 only private data
 124 </p>
 125 <div class="variablelist"><table border="0">
 126 <col align="left" valign="top">
 127 <tbody><tr>
 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>
 131 </td>
 132 </tr></tbody>
 133 </table></div>
 134 <p class="since">Since 1.4</p>
 135 </div>
 136 <hr>
 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 <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
 141 <p>
 142 Sets the name of <em class="parameter"><code>meta</code></em>
 143 </p>
 144 <p>
 145 The name can be used to identify the <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> instance
 146 </p>
 147 <div class="variablelist"><table border="0">
 148 <col align="left" valign="top">
 149 <tbody>
 150 <tr>
 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>
 153 </td>
 154 </tr>
 155 <tr>
 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>
 158 </td>
 159 </tr>
 160 </tbody>
 161 </table></div>
 162 <p class="since">Since 1.4</p>
 163 </div>
 164 <hr>
 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 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       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>
 168 <p>
 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>
 170 </p>
 171 <div class="variablelist"><table border="0">
 172 <col align="left" valign="top">
 173 <tbody>
 174 <tr>
 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>
 177 </td>
 178 </tr>
 179 <tr>
 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>
 185 </td>
 186 </tr>
 187 </tbody>
 188 </table></div>
 189 <p class="since">Since 1.4</p>
 190 </div>
 191 <hr>
 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><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> is_enabled</code></em>);</pre>
 196 <p>
 197 Sets whether <em class="parameter"><code>meta</code></em> should be enabled or not
 198 </p>
 199 <div class="variablelist"><table border="0">
 200 <col align="left" valign="top">
 201 <tbody>
 202 <tr>
 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>
 205 </td>
 206 </tr>
 207 <tr>
 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>
 210 </tr>
 211 </tbody>
 212 </table></div>
 213 <p class="since">Since 1.4</p>
 214 </div>
 215 <hr>
 216 <div class="refsect2">
 217 <a name="clutter-actor-meta-get-enabled"></a><h3>clutter_actor_meta_get_enabled ()</h3>
 218 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>
 219 <p>
 220 Retrieves whether <em class="parameter"><code>meta</code></em> is enabled
 221 </p>
 222 <div class="variablelist"><table border="0">
 223 <col align="left" valign="top">
 224 <tbody>
 225 <tr>
 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>
 228 </td>
 229 </tr>
 230 <tr>
 231 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 232 <td>
 233 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> instance is enabled</td>
 234 </tr>
 235 </tbody>
 236 </table></div>
 237 <p class="since">Since 1.4</p>
 238 </div>
 239 <hr>
 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>
 243 <p>
 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>
 245 </p>
 246 <div class="variablelist"><table border="0">
 247 <col align="left" valign="top">
 248 <tbody>
 249 <tr>
 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>
 252 </td>
 253 </tr>
 254 <tr>
 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>
 257 </td>
 258 </tr>
 259 </tbody>
 260 </table></div>
 261 <p class="since">Since 1.4</p>
 262 </div>
 263 </div>
 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>
 269 <p>
 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
 271 </p>
 272 <p class="since">Since 1.4</p>
 273 </div>
 274 <hr>
 275 <div class="refsect2">
 276 <a name="ClutterActorMeta--enabled"></a><h3>The <code class="literal">"enabled"</code> property</h3>
 277 <pre class="programlisting">  "enabled"                  <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 278 <p>
 279 Whether or not the <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a> is enabled
 280 </p>
 281 <p>Default value: TRUE</p>
 282 <p class="since">Since 1.4</p>
 283 </div>
 284 <hr>
 285 <div class="refsect2">
 286 <a name="ClutterActorMeta--name"></a><h3>The <code class="literal">"name"</code> property</h3>
 287 <pre class="programlisting">  "name"                     <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 288 <p>
 289 The unique name to access the <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta"><span class="type">ClutterActorMeta</span></a>
 290 </p>
 291 <p>Default value: NULL</p>
 292 <p class="since">Since 1.4</p>
 293 </div>
 294 </div>
 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>
 298 </div>
 299 </div>
 300 <div class="footer">
 301 <hr>
 302           Generated by GTK-Doc V1.18.1</div>
 303 </body>
 304 </html>