doc/reference/clutter/html/ClutterContent.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>ClutterContent</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="ClutterEffect.html" title="ClutterEffect">
  10 <link rel="next" href="ch02.html" title="Base actors">
  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="ClutterEffect.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="ch02.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="#ClutterContent.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterContent.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterContent.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterContent.prerequisites" class="shortcut">Prerequisites</a>
  31                    |
  32                   <a href="#ClutterContent.implementations" class="shortcut">Known Implementations</a>
  33                    |
  34                   <a href="#ClutterContent.signals" class="shortcut">Signals</a>
  35 </td></tr>
  36 </table>
  37 <div class="refentry">
  38 <a name="ClutterContent"></a><div class="titlepage"></div>
  39 <div class="refnamediv"><table width="100%"><tr>
  40 <td valign="top">
  41 <h2><span class="refentrytitle"><a name="ClutterContent.top_of_page"></a>ClutterContent</span></h2>
  42 <p>ClutterContent — Delegate for painting the content of an actor</p>
  43 </td>
  44 <td valign="top" align="right"></td>
  45 </tr></table></div>
  46 <div class="refsynopsisdiv">
  47 <a name="ClutterContent.synopsis"></a><h2>Synopsis</h2>
  48 <pre class="synopsis">                    <a class="link" href="ClutterContent.html#ClutterContent-struct" title="ClutterContent">ClutterContent</a>;
  49 struct              <a class="link" href="ClutterContent.html#ClutterContentIface" title="struct ClutterContentIface">ClutterContentIface</a>;
  50 <span class="returnvalue">gboolean</span>            <a class="link" href="ClutterContent.html#clutter-content-get-preferred-size" title="clutter_content_get_preferred_size ()">clutter_content_get_preferred_size</a>  (<em class="parameter"><code><a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> *content</code></em>,
  51                                                          <em class="parameter"><code><span class="type">gfloat</span> *width</code></em>,
  52                                                          <em class="parameter"><code><span class="type">gfloat</span> *height</code></em>);
  53 <span class="returnvalue">void</span>                <a class="link" href="ClutterContent.html#clutter-content-invalidate" title="clutter_content_invalidate ()">clutter_content_invalidate</a>          (<em class="parameter"><code><a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> *content</code></em>);
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="ClutterContent.object-hierarchy"></a><h2>Object Hierarchy</h2>
  58 <pre class="synopsis">
  59   GInterface
  60    +----ClutterContent
  61 </pre>
  62 </div>
  63 <div class="refsect1">
  64 <a name="ClutterContent.prerequisites"></a><h2>Prerequisites</h2>
  65 <p>
  66 ClutterContent requires
  67  GObject.</p>
  68 </div>
  69 <div class="refsect1">
  70 <a name="ClutterContent.implementations"></a><h2>Known Implementations</h2>
  71 <p>
  72 ClutterContent is implemented by
  73  <a class="link" href="ClutterCanvas.html" title="ClutterCanvas">ClutterCanvas</a>.</p>
  74 </div>
  75 <div class="refsect1">
  76 <a name="ClutterContent.signals"></a><h2>Signals</h2>
  77 <pre class="synopsis">
  78   "<a class="link" href="ClutterContent.html#ClutterContent-attached" title='The "attached" signal'>attached</a>"                                       : <code class="literal">Run First</code>
  79   "<a class="link" href="ClutterContent.html#ClutterContent-detached" title='The "detached" signal'>detached</a>"                                       : <code class="literal">Run First</code>
  80 </pre>
  81 </div>
  82 <div class="refsect1">
  83 <a name="ClutterContent.description"></a><h2>Description</h2>
  84 <p>
  85 <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> is an interface to implement types responsible for
  86 painting the content of a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>.
  87 </p>
  88 <p>
  89 Multiple actors can use the same <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> instance, in order
  90 to share the resources associated with painting the same content.
  91 </p>
  92 <p>
  93 <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> is available since Clutter 1.10.
  94 </p>
  95 </div>
  96 <div class="refsect1">
  97 <a name="ClutterContent.details"></a><h2>Details</h2>
  98 <div class="refsect2">
  99 <a name="ClutterContent-struct"></a><h3>ClutterContent</h3>
 100 <pre class="programlisting">typedef struct _ClutterContent ClutterContent;</pre>
 101 <p>
 102 The <span class="structname">ClutterContent</span> structure is an opaque type
 103 whose members cannot be acccessed directly.
 104 </p>
 105 <p class="since">Since 1.10</p>
 106 </div>
 107 <hr>
 108 <div class="refsect2">
 109 <a name="ClutterContentIface"></a><h3>struct ClutterContentIface</h3>
 110 <pre class="programlisting">struct ClutterContentIface {
 111   gboolean      (* get_preferred_size)  (ClutterContent   *content,
 112                                          gfloat           *width,
 113                                          gfloat           *height);
 114   void          (* paint_content)       (ClutterContent   *content,
 115                                          ClutterActor     *actor,
 116                                          ClutterPaintNode *node);
 117
 118   void          (* attached)            (ClutterContent   *content,
 119                                          ClutterActor     *actor);
 120   void          (* detached)            (ClutterContent   *content,
 121                                          ClutterActor     *actor);
 122
 123   void          (* invalidate)          (ClutterContent   *content);
 124 };
 125 </pre>
 126 <p>
 127 The <span class="structname">ClutterContentIface</span> structure contains only
 128 private data.
 129 </p>
 130 <div class="variablelist"><table border="0">
 131 <col align="left" valign="top">
 132 <tbody>
 133 <tr>
 134 <td><p><span class="term"><em class="structfield"><code><a name="ClutterContentIface.get-preferred-size"></a>get_preferred_size</code></em> ()</span></p></td>
 135 <td>virtual function; should be overridden by subclasses
 136 of <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> that have a natural size</td>
 137 </tr>
 138 <tr>
 139 <td><p><span class="term"><em class="structfield"><code><a name="ClutterContentIface.paint-content"></a>paint_content</code></em> ()</span></p></td>
 140 <td>virtual function; called each time the content needs to
 141 paint itself</td>
 142 </tr>
 143 <tr>
 144 <td><p><span class="term"><em class="structfield"><code><a name="ClutterContentIface.attached"></a>attached</code></em> ()</span></p></td>
 145 <td>virtual function; called each time a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> is attached
 146 to a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>.</td>
 147 </tr>
 148 <tr>
 149 <td><p><span class="term"><em class="structfield"><code><a name="ClutterContentIface.detached"></a>detached</code></em> ()</span></p></td>
 150 <td>virtual function; called each time a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> is detached
 151 from a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>.</td>
 152 </tr>
 153 <tr>
 154 <td><p><span class="term"><em class="structfield"><code><a name="ClutterContentIface.invalidate"></a>invalidate</code></em> ()</span></p></td>
 155 <td>virtual function; called each time a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> state
 156 is changed.</td>
 157 </tr>
 158 </tbody>
 159 </table></div>
 160 <p class="since">Since 1.10</p>
 161 </div>
 162 <hr>
 163 <div class="refsect2">
 164 <a name="clutter-content-get-preferred-size"></a><h3>clutter_content_get_preferred_size ()</h3>
 165 <pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_content_get_preferred_size  (<em class="parameter"><code><a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> *content</code></em>,
 166                                                          <em class="parameter"><code><span class="type">gfloat</span> *width</code></em>,
 167                                                          <em class="parameter"><code><span class="type">gfloat</span> *height</code></em>);</pre>
 168 <p>
 169 Retrieves the natural size of the <em class="parameter"><code>content</code></em>, if any.
 170 </p>
 171 <p>
 172 The natural size of a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> is defined as the size the content
 173 would have regardless of the allocation of the actor that is painting it,
 174 for instance the size of an image data.
 175 </p>
 176 <div class="variablelist"><table border="0">
 177 <col align="left" valign="top">
 178 <tbody>
 179 <tr>
 180 <td><p><span class="term"><em class="parameter"><code>content</code></em> :</span></p></td>
 181 <td>a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a>
 182 </td>
 183 </tr>
 184 <tr>
 185 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
 186 <td>return location for the natural width of the content. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 187 </td>
 188 </tr>
 189 <tr>
 190 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
 191 <td>return location for the natural height of the content. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 192 </td>
 193 </tr>
 194 <tr>
 195 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 196 <td>
 197 <code class="literal">TRUE</code> if the content has a preferred size, and <code class="literal">FALSE</code>
 198 otherwise</td>
 199 </tr>
 200 </tbody>
 201 </table></div>
 202 <p class="since">Since 1.10</p>
 203 </div>
 204 <hr>
 205 <div class="refsect2">
 206 <a name="clutter-content-invalidate"></a><h3>clutter_content_invalidate ()</h3>
 207 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_content_invalidate          (<em class="parameter"><code><a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> *content</code></em>);</pre>
 208 <p>
 209 Invalidates a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a>.
 210 </p>
 211 <p>
 212 This function should be called by <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> implementations when
 213 they change the way a the content should be painted regardless of the
 214 actor state.
 215 </p>
 216 <div class="variablelist"><table border="0">
 217 <col align="left" valign="top">
 218 <tbody><tr>
 219 <td><p><span class="term"><em class="parameter"><code>content</code></em> :</span></p></td>
 220 <td>a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a>
 221 </td>
 222 </tr></tbody>
 223 </table></div>
 224 <p class="since">Since 1.10</p>
 225 </div>
 226 </div>
 227 <div class="refsect1">
 228 <a name="ClutterContent.signal-details"></a><h2>Signal Details</h2>
 229 <div class="refsect2">
 230 <a name="ClutterContent-attached"></a><h3>The <code class="literal">"attached"</code> signal</h3>
 231 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> *content,
 232                                                         <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>   *actor,
 233                                                         <span class="type">gpointer</span>        user_data)      : <code class="literal">Run First</code></pre>
 234 <p>
 235 This signal is emitted each time a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> implementation is
 236 assigned to a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>.
 237 </p>
 238 <div class="variablelist"><table border="0">
 239 <col align="left" valign="top">
 240 <tbody>
 241 <tr>
 242 <td><p><span class="term"><em class="parameter"><code>content</code></em> :</span></p></td>
 243 <td>the object that emitted the signal</td>
 244 </tr>
 245 <tr>
 246 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
 247 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>
 248 </td>
 249 </tr>
 250 <tr>
 251 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 252 <td>user data set when the signal handler was connected.</td>
 253 </tr>
 254 </tbody>
 255 </table></div>
 256 <p class="since">Since 1.10</p>
 257 </div>
 258 <hr>
 259 <div class="refsect2">
 260 <a name="ClutterContent-detached"></a><h3>The <code class="literal">"detached"</code> signal</h3>
 261 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> *content,
 262                                                         <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>   *actor,
 263                                                         <span class="type">gpointer</span>        user_data)      : <code class="literal">Run First</code></pre>
 264 <p>
 265 This signal is emitted each time a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> implementation is
 266 removed from a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>.
 267 </p>
 268 <div class="variablelist"><table border="0">
 269 <col align="left" valign="top">
 270 <tbody>
 271 <tr>
 272 <td><p><span class="term"><em class="parameter"><code>content</code></em> :</span></p></td>
 273 <td>the object that emitted the signal</td>
 274 </tr>
 275 <tr>
 276 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
 277 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>
 278 </td>
 279 </tr>
 280 <tr>
 281 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 282 <td>user data set when the signal handler was connected.</td>
 283 </tr>
 284 </tbody>
 285 </table></div>
 286 <p class="since">Since 1.10</p>
 287 </div>
 288 </div>
 289 </div>
 290 <div class="footer">
 291 <hr>
 292           Generated by GTK-Doc V1.18.1</div>
 293 </body>
 294 </html>