doc/reference/clutter/html/ClutterLayoutMeta.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>ClutterLayoutMeta</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="ClutterLayoutManager.html" title="ClutterLayoutManager">
  10 <link rel="next" href="ClutterActorMeta.html" title="ClutterActorMeta">
  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="ClutterLayoutManager.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="ClutterActorMeta.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="#ClutterLayoutMeta.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterLayoutMeta.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterLayoutMeta.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterLayoutMeta.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="ClutterLayoutMeta"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="ClutterLayoutMeta.top_of_page"></a>ClutterLayoutMeta</span></h2>
  38 <p>ClutterLayoutMeta — Wrapper for actors inside a layout manager</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="ClutterLayoutMeta.synopsis"></a><h2>Synopsis</h2>
  44 <pre class="synopsis">                    <a class="link" href="ClutterLayoutMeta.html#ClutterLayoutMeta-struct" title="ClutterLayoutMeta">ClutterLayoutMeta</a>;
  45 struct              <a class="link" href="ClutterLayoutMeta.html#ClutterLayoutMetaClass" title="struct ClutterLayoutMetaClass">ClutterLayoutMetaClass</a>;
  46 <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="returnvalue">ClutterLayoutManager</span></a> * <a class="link" href="ClutterLayoutMeta.html#clutter-layout-meta-get-manager" title="clutter_layout_meta_get_manager ()">clutter_layout_meta_get_manager</a>  (<em class="parameter"><code><a class="link" href="ClutterLayoutMeta.html" title="ClutterLayoutMeta"><span class="type">ClutterLayoutMeta</span></a> *data</code></em>);
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="ClutterLayoutMeta.object-hierarchy"></a><h2>Object Hierarchy</h2>
  51 <pre class="synopsis">
  52   GObject
  53    +----<a class="link" href="ClutterChildMeta.html" title="ClutterChildMeta">ClutterChildMeta</a>
  54          +----ClutterLayoutMeta
  55 </pre>
  56 </div>
  57 <div class="refsect1">
  58 <a name="ClutterLayoutMeta.properties"></a><h2>Properties</h2>
  59 <pre class="synopsis">
  60   "<a class="link" href="ClutterLayoutMeta.html#ClutterLayoutMeta--manager" title='The "manager" property'>manager</a>"                  <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a>*  : Read / Write / Construct Only
  61 </pre>
  62 </div>
  63 <div class="refsect1">
  64 <a name="ClutterLayoutMeta.description"></a><h2>Description</h2>
  65 <p>
  66 <a class="link" href="ClutterLayoutMeta.html" title="ClutterLayoutMeta"><span class="type">ClutterLayoutMeta</span></a> is a wrapper object created by <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a>
  67 implementations in order to store child-specific data and properties.
  68 </p>
  69 <p>
  70 A <a class="link" href="ClutterLayoutMeta.html" title="ClutterLayoutMeta"><span class="type">ClutterLayoutMeta</span></a> wraps a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> inside a <a class="link" href="ClutterContainer.html" title="ClutterContainer"><span class="type">ClutterContainer</span></a>
  71 using a <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a>.
  72 </p>
  73 <p>
  74 <a class="link" href="ClutterLayoutMeta.html" title="ClutterLayoutMeta"><span class="type">ClutterLayoutMeta</span></a> is available since Clutter 1.2
  75 </p>
  76 </div>
  77 <div class="refsect1">
  78 <a name="ClutterLayoutMeta.details"></a><h2>Details</h2>
  79 <div class="refsect2">
  80 <a name="ClutterLayoutMeta-struct"></a><h3>ClutterLayoutMeta</h3>
  81 <pre class="programlisting">typedef struct {
  82   ClutterLayoutManager *manager;
  83 } ClutterLayoutMeta;
  84 </pre>
  85 <p>
  86 Sub-class of <a class="link" href="ClutterChildMeta.html" title="ClutterChildMeta"><span class="type">ClutterChildMeta</span></a> specific for layout managers
  87 </p>
  88 <p>
  89 A <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> sub-class should create a <a class="link" href="ClutterLayoutMeta.html" title="ClutterLayoutMeta"><span class="type">ClutterLayoutMeta</span></a>
  90 instance by overriding the <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a>::<code class="function">create_child_meta()</code>
  91 virtual function
  92 </p>
  93 <div class="variablelist"><table border="0">
  94 <col align="left" valign="top">
  95 <tbody><tr>
  96 <td><p><span class="term"><a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> *<em class="structfield"><code><a name="ClutterLayoutMeta-struct.manager"></a>manager</code></em>;</span></p></td>
  97 <td>the layout manager handling this data</td>
  98 </tr></tbody>
  99 </table></div>
 100 <p class="since">Since 1.2</p>
 101 </div>
 102 <hr>
 103 <div class="refsect2">
 104 <a name="ClutterLayoutMetaClass"></a><h3>struct ClutterLayoutMetaClass</h3>
 105 <pre class="programlisting">struct ClutterLayoutMetaClass {
 106 };
 107 </pre>
 108 <p>
 109 The <a class="link" href="ClutterLayoutMeta.html#ClutterLayoutMetaClass" title="struct ClutterLayoutMetaClass"><span class="type">ClutterLayoutMetaClass</span></a> contains only private data and
 110 should never be accessed directly
 111 </p>
 112 <p class="since">Since 1.2</p>
 113 </div>
 114 <hr>
 115 <div class="refsect2">
 116 <a name="clutter-layout-meta-get-manager"></a><h3>clutter_layout_meta_get_manager ()</h3>
 117 <pre class="programlisting"><a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="returnvalue">ClutterLayoutManager</span></a> * clutter_layout_meta_get_manager  (<em class="parameter"><code><a class="link" href="ClutterLayoutMeta.html" title="ClutterLayoutMeta"><span class="type">ClutterLayoutMeta</span></a> *data</code></em>);</pre>
 118 <p>
 119 Retrieves the actor wrapped by <em class="parameter"><code>data</code></em>
 120 </p>
 121 <div class="variablelist"><table border="0">
 122 <col align="left" valign="top">
 123 <tbody>
 124 <tr>
 125 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 126 <td>a <a class="link" href="ClutterLayoutMeta.html" title="ClutterLayoutMeta"><span class="type">ClutterLayoutMeta</span></a>
 127 </td>
 128 </tr>
 129 <tr>
 130 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 131 <td>a <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 132 </td>
 133 </tr>
 134 </tbody>
 135 </table></div>
 136 <p class="since">Since 1.2</p>
 137 </div>
 138 </div>
 139 <div class="refsect1">
 140 <a name="ClutterLayoutMeta.property-details"></a><h2>Property Details</h2>
 141 <div class="refsect2">
 142 <a name="ClutterLayoutMeta--manager"></a><h3>The <code class="literal">"manager"</code> property</h3>
 143 <pre class="programlisting">  "manager"                  <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a>*  : Read / Write / Construct Only</pre>
 144 <p>
 145 The <a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> that created this <a class="link" href="ClutterLayoutMeta.html" title="ClutterLayoutMeta"><span class="type">ClutterLayoutMeta</span></a>.
 146 </p>
 147 <p class="since">Since 1.2</p>
 148 </div>
 149 </div>
 150 </div>
 151 <div class="footer">
 152 <hr>
 153           Generated by GTK-Doc V1.18.1</div>
 154 </body>
 155 </html>