doc/reference/clutter/html/ClutterSnapConstraint.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>ClutterSnapConstraint</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="ch05.html" title="Constraints">
   9 <link rel="prev" href="ClutterPathConstraint.html" title="ClutterPathConstraint">
  10 <link rel="next" href="ch06.html" title="Effects">
  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="ClutterPathConstraint.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch05.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="ch06.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="#ClutterSnapConstraint.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterSnapConstraint.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterSnapConstraint.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterSnapConstraint.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="ClutterSnapConstraint"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="ClutterSnapConstraint.top_of_page"></a>ClutterSnapConstraint</span></h2>
  38 <p>ClutterSnapConstraint — A constraint snapping two actors together</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="ClutterSnapConstraint.synopsis"></a><h2>Synopsis</h2>
  44 <pre class="synopsis">enum                <a class="link" href="ClutterSnapConstraint.html#ClutterSnapEdge" title="enum ClutterSnapEdge">ClutterSnapEdge</a>;
  45                     <a class="link" href="ClutterSnapConstraint.html#ClutterSnapConstraint-struct" title="ClutterSnapConstraint">ClutterSnapConstraint</a>;
  46 <a class="link" href="ClutterConstraint.html" title="ClutterConstraint"><span class="returnvalue">ClutterConstraint</span></a> * <a class="link" href="ClutterSnapConstraint.html#clutter-snap-constraint-new" title="clutter_snap_constraint_new ()">clutter_snap_constraint_new</a>         (<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *source</code></em>,
  47                                                          <em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html#ClutterSnapEdge" title="enum ClutterSnapEdge"><span class="type">ClutterSnapEdge</span></a> from_edge</code></em>,
  48                                                          <em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html#ClutterSnapEdge" title="enum ClutterSnapEdge"><span class="type">ClutterSnapEdge</span></a> to_edge</code></em>,
  49                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> offset</code></em>);
  50 <span class="returnvalue">void</span>                <a class="link" href="ClutterSnapConstraint.html#clutter-snap-constraint-set-source" title="clutter_snap_constraint_set_source ()">clutter_snap_constraint_set_source</a>  (<em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a> *constraint</code></em>,
  51                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *source</code></em>);
  52 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="ClutterSnapConstraint.html#clutter-snap-constraint-get-source" title="clutter_snap_constraint_get_source ()">clutter_snap_constraint_get_source</a>  (<em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a> *constraint</code></em>);
  53 <span class="returnvalue">void</span>                <a class="link" href="ClutterSnapConstraint.html#clutter-snap-constraint-set-edges" title="clutter_snap_constraint_set_edges ()">clutter_snap_constraint_set_edges</a>   (<em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a> *constraint</code></em>,
  54                                                          <em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html#ClutterSnapEdge" title="enum ClutterSnapEdge"><span class="type">ClutterSnapEdge</span></a> from_edge</code></em>,
  55                                                          <em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html#ClutterSnapEdge" title="enum ClutterSnapEdge"><span class="type">ClutterSnapEdge</span></a> to_edge</code></em>);
  56 <span class="returnvalue">void</span>                <a class="link" href="ClutterSnapConstraint.html#clutter-snap-constraint-get-edges" title="clutter_snap_constraint_get_edges ()">clutter_snap_constraint_get_edges</a>   (<em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a> *constraint</code></em>,
  57                                                          <em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html#ClutterSnapEdge" title="enum ClutterSnapEdge"><span class="type">ClutterSnapEdge</span></a> *from_edge</code></em>,
  58                                                          <em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html#ClutterSnapEdge" title="enum ClutterSnapEdge"><span class="type">ClutterSnapEdge</span></a> *to_edge</code></em>);
  59 <span class="returnvalue">void</span>                <a class="link" href="ClutterSnapConstraint.html#clutter-snap-constraint-set-offset" title="clutter_snap_constraint_set_offset ()">clutter_snap_constraint_set_offset</a>  (<em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a> *constraint</code></em>,
  60                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> offset</code></em>);
  61 <a href="../glib/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a>              <a class="link" href="ClutterSnapConstraint.html#clutter-snap-constraint-get-offset" title="clutter_snap_constraint_get_offset ()">clutter_snap_constraint_get_offset</a>  (<em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a> *constraint</code></em>);
  62 </pre>
  63 </div>
  64 <div class="refsect1">
  65 <a name="ClutterSnapConstraint.object-hierarchy"></a><h2>Object Hierarchy</h2>
  66 <pre class="synopsis">
  67   <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  68    +----<a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
  69          +----<a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta">ClutterActorMeta</a>
  70                +----<a class="link" href="ClutterConstraint.html" title="ClutterConstraint">ClutterConstraint</a>
  71                      +----ClutterSnapConstraint
  72 </pre>
  73 </div>
  74 <div class="refsect1">
  75 <a name="ClutterSnapConstraint.properties"></a><h2>Properties</h2>
  76 <pre class="synopsis">
  77   "<a class="link" href="ClutterSnapConstraint.html#ClutterSnapConstraint--from-edge" title='The "from-edge" property'>from-edge</a>"                <a class="link" href="ClutterSnapConstraint.html#ClutterSnapEdge" title="enum ClutterSnapEdge"><span class="type">ClutterSnapEdge</span></a>       : Read / Write / Construct
  78   "<a class="link" href="ClutterSnapConstraint.html#ClutterSnapConstraint--offset" title='The "offset" property'>offset</a>"                   <a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write / Construct
  79   "<a class="link" href="ClutterSnapConstraint.html#ClutterSnapConstraint--source" title='The "source" property'>source</a>"                   <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>*         : Read / Write / Construct
  80   "<a class="link" href="ClutterSnapConstraint.html#ClutterSnapConstraint--to-edge" title='The "to-edge" property'>to-edge</a>"                  <a class="link" href="ClutterSnapConstraint.html#ClutterSnapEdge" title="enum ClutterSnapEdge"><span class="type">ClutterSnapEdge</span></a>       : Read / Write / Construct
  81 </pre>
  82 </div>
  83 <div class="refsect1">
  84 <a name="ClutterSnapConstraint.description"></a><h2>Description</h2>
  85 <p>
  86 <a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a> is a constraint the snaps the edges of two
  87 actors together, expanding the actor's allocation if necessary.
  88 </p>
  89 <p>
  90 An offset can be applied to the constraint, to provide spacing.
  91 </p>
  92 <p>
  93 <a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a> is available since Clutter 1.6
  94 </p>
  95 </div>
  96 <div class="refsect1">
  97 <a name="ClutterSnapConstraint.details"></a><h2>Details</h2>
  98 <div class="refsect2">
  99 <a name="ClutterSnapEdge"></a><h3>enum ClutterSnapEdge</h3>
 100 <pre class="programlisting">typedef enum {
 101   CLUTTER_SNAP_EDGE_TOP,
 102   CLUTTER_SNAP_EDGE_RIGHT,
 103   CLUTTER_SNAP_EDGE_BOTTOM,
 104   CLUTTER_SNAP_EDGE_LEFT
 105 } ClutterSnapEdge;
 106 </pre>
 107 <p>
 108 The edge to snap
 109 </p>
 110 <div class="variablelist"><table border="0">
 111 <col align="left" valign="top">
 112 <tbody>
 113 <tr>
 114 <td><p><a name="CLUTTER-SNAP-EDGE-TOP:CAPS"></a><span class="term"><code class="literal">CLUTTER_SNAP_EDGE_TOP</code></span></p></td>
 115 <td>the top edge
 116 </td>
 117 </tr>
 118 <tr>
 119 <td><p><a name="CLUTTER-SNAP-EDGE-RIGHT:CAPS"></a><span class="term"><code class="literal">CLUTTER_SNAP_EDGE_RIGHT</code></span></p></td>
 120 <td>the right edge
 121 </td>
 122 </tr>
 123 <tr>
 124 <td><p><a name="CLUTTER-SNAP-EDGE-BOTTOM:CAPS"></a><span class="term"><code class="literal">CLUTTER_SNAP_EDGE_BOTTOM</code></span></p></td>
 125 <td>the bottom edge
 126 </td>
 127 </tr>
 128 <tr>
 129 <td><p><a name="CLUTTER-SNAP-EDGE-LEFT:CAPS"></a><span class="term"><code class="literal">CLUTTER_SNAP_EDGE_LEFT</code></span></p></td>
 130 <td>the left edge
 131 </td>
 132 </tr>
 133 </tbody>
 134 </table></div>
 135 <p class="since">Since 1.6</p>
 136 </div>
 137 <hr>
 138 <div class="refsect2">
 139 <a name="ClutterSnapConstraint-struct"></a><h3>ClutterSnapConstraint</h3>
 140 <pre class="programlisting">typedef struct _ClutterSnapConstraint ClutterSnapConstraint;</pre>
 141 <p>
 142 <span class="structname">ClutterSnapConstraint</span> is an opaque structure
 143 whose members cannot be directly accesses
 144 </p>
 145 <p class="since">Since 1.6</p>
 146 </div>
 147 <hr>
 148 <div class="refsect2">
 149 <a name="clutter-snap-constraint-new"></a><h3>clutter_snap_constraint_new ()</h3>
 150 <pre class="programlisting"><a class="link" href="ClutterConstraint.html" title="ClutterConstraint"><span class="returnvalue">ClutterConstraint</span></a> * clutter_snap_constraint_new         (<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *source</code></em>,
 151                                                          <em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html#ClutterSnapEdge" title="enum ClutterSnapEdge"><span class="type">ClutterSnapEdge</span></a> from_edge</code></em>,
 152                                                          <em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html#ClutterSnapEdge" title="enum ClutterSnapEdge"><span class="type">ClutterSnapEdge</span></a> to_edge</code></em>,
 153                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> offset</code></em>);</pre>
 154 <p>
 155 Creates a new <a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a> that will snap a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>
 156 to the <em class="parameter"><code>edge</code></em> of <em class="parameter"><code>source</code></em>, with the given <em class="parameter"><code>offset</code></em>.
 157 </p>
 158 <div class="variablelist"><table border="0">
 159 <col align="left" valign="top">
 160 <tbody>
 161 <tr>
 162 <td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 163 <td>the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to use as the source of
 164 the constraint, 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="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 165 </td>
 166 </tr>
 167 <tr>
 168 <td><p><span class="term"><em class="parameter"><code>from_edge</code></em> :</span></p></td>
 169 <td>the edge of the actor to use in the constraint</td>
 170 </tr>
 171 <tr>
 172 <td><p><span class="term"><em class="parameter"><code>to_edge</code></em> :</span></p></td>
 173 <td>the edge of <em class="parameter"><code>source</code></em> to use in the constraint</td>
 174 </tr>
 175 <tr>
 176 <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
 177 <td>the offset to apply to the constraint, in pixels</td>
 178 </tr>
 179 <tr>
 180 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 181 <td>the newly created <a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a>
 182 </td>
 183 </tr>
 184 </tbody>
 185 </table></div>
 186 <p class="since">Since 1.6</p>
 187 </div>
 188 <hr>
 189 <div class="refsect2">
 190 <a name="clutter-snap-constraint-set-source"></a><h3>clutter_snap_constraint_set_source ()</h3>
 191 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_snap_constraint_set_source  (<em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a> *constraint</code></em>,
 192                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *source</code></em>);</pre>
 193 <p>
 194 Sets the source <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> for the constraint
 195 </p>
 196 <div class="variablelist"><table border="0">
 197 <col align="left" valign="top">
 198 <tbody>
 199 <tr>
 200 <td><p><span class="term"><em class="parameter"><code>constraint</code></em> :</span></p></td>
 201 <td>a <a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a>
 202 </td>
 203 </tr>
 204 <tr>
 205 <td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 206 <td>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> to unset the source. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 207 </td>
 208 </tr>
 209 </tbody>
 210 </table></div>
 211 <p class="since">Since 1.6</p>
 212 </div>
 213 <hr>
 214 <div class="refsect2">
 215 <a name="clutter-snap-constraint-get-source"></a><h3>clutter_snap_constraint_get_source ()</h3>
 216 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_snap_constraint_get_source  (<em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a> *constraint</code></em>);</pre>
 217 <p>
 218 Retrieves the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> set using <a class="link" href="ClutterSnapConstraint.html#clutter-snap-constraint-set-source" title="clutter_snap_constraint_set_source ()"><code class="function">clutter_snap_constraint_set_source()</code></a>
 219 </p>
 220 <div class="variablelist"><table border="0">
 221 <col align="left" valign="top">
 222 <tbody>
 223 <tr>
 224 <td><p><span class="term"><em class="parameter"><code>constraint</code></em> :</span></p></td>
 225 <td>a <a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a>
 226 </td>
 227 </tr>
 228 <tr>
 229 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 230 <td>a pointer to the source actor. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 231 </td>
 232 </tr>
 233 </tbody>
 234 </table></div>
 235 <p class="since">Since 1.6</p>
 236 </div>
 237 <hr>
 238 <div class="refsect2">
 239 <a name="clutter-snap-constraint-set-edges"></a><h3>clutter_snap_constraint_set_edges ()</h3>
 240 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_snap_constraint_set_edges   (<em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a> *constraint</code></em>,
 241                                                          <em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html#ClutterSnapEdge" title="enum ClutterSnapEdge"><span class="type">ClutterSnapEdge</span></a> from_edge</code></em>,
 242                                                          <em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html#ClutterSnapEdge" title="enum ClutterSnapEdge"><span class="type">ClutterSnapEdge</span></a> to_edge</code></em>);</pre>
 243 <p>
 244 Sets the edges to be used by the <em class="parameter"><code>constraint</code></em>
 245 </p>
 246 <p>
 247 The <em class="parameter"><code>from_edge</code></em> is the edge on the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to which <em class="parameter"><code>constraint</code></em>
 248 has been added. The <em class="parameter"><code>to_edge</code></em> is the edge of the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> inside
 249 the <a class="link" href="ClutterSnapConstraint.html#ClutterSnapConstraint--source" title='The "source" property'><span class="type">"source"</span></a> property.
 250 </p>
 251 <div class="variablelist"><table border="0">
 252 <col align="left" valign="top">
 253 <tbody>
 254 <tr>
 255 <td><p><span class="term"><em class="parameter"><code>constraint</code></em> :</span></p></td>
 256 <td>a <a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a>
 257 </td>
 258 </tr>
 259 <tr>
 260 <td><p><span class="term"><em class="parameter"><code>from_edge</code></em> :</span></p></td>
 261 <td>the edge on the actor</td>
 262 </tr>
 263 <tr>
 264 <td><p><span class="term"><em class="parameter"><code>to_edge</code></em> :</span></p></td>
 265 <td>the edge on the source</td>
 266 </tr>
 267 </tbody>
 268 </table></div>
 269 <p class="since">Since 1.6</p>
 270 </div>
 271 <hr>
 272 <div class="refsect2">
 273 <a name="clutter-snap-constraint-get-edges"></a><h3>clutter_snap_constraint_get_edges ()</h3>
 274 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_snap_constraint_get_edges   (<em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a> *constraint</code></em>,
 275                                                          <em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html#ClutterSnapEdge" title="enum ClutterSnapEdge"><span class="type">ClutterSnapEdge</span></a> *from_edge</code></em>,
 276                                                          <em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html#ClutterSnapEdge" title="enum ClutterSnapEdge"><span class="type">ClutterSnapEdge</span></a> *to_edge</code></em>);</pre>
 277 <p>
 278 Retrieves the edges used by the <em class="parameter"><code>constraint</code></em>
 279 </p>
 280 <div class="variablelist"><table border="0">
 281 <col align="left" valign="top">
 282 <tbody>
 283 <tr>
 284 <td><p><span class="term"><em class="parameter"><code>constraint</code></em> :</span></p></td>
 285 <td>a <a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a>
 286 </td>
 287 </tr>
 288 <tr>
 289 <td><p><span class="term"><em class="parameter"><code>from_edge</code></em> :</span></p></td>
 290 <td>return location for the actor's edge, 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="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 291 </td>
 292 </tr>
 293 <tr>
 294 <td><p><span class="term"><em class="parameter"><code>to_edge</code></em> :</span></p></td>
 295 <td>return location for the source's edge, 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="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 296 </td>
 297 </tr>
 298 </tbody>
 299 </table></div>
 300 <p class="since">Since 1.6</p>
 301 </div>
 302 <hr>
 303 <div class="refsect2">
 304 <a name="clutter-snap-constraint-set-offset"></a><h3>clutter_snap_constraint_set_offset ()</h3>
 305 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_snap_constraint_set_offset  (<em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a> *constraint</code></em>,
 306                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> offset</code></em>);</pre>
 307 <p>
 308 Sets the offset to be applied to the constraint
 309 </p>
 310 <div class="variablelist"><table border="0">
 311 <col align="left" valign="top">
 312 <tbody>
 313 <tr>
 314 <td><p><span class="term"><em class="parameter"><code>constraint</code></em> :</span></p></td>
 315 <td>a <a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a>
 316 </td>
 317 </tr>
 318 <tr>
 319 <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
 320 <td>the offset to apply, in pixels</td>
 321 </tr>
 322 </tbody>
 323 </table></div>
 324 <p class="since">Since 1.6</p>
 325 </div>
 326 <hr>
 327 <div class="refsect2">
 328 <a name="clutter-snap-constraint-get-offset"></a><h3>clutter_snap_constraint_get_offset ()</h3>
 329 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a>              clutter_snap_constraint_get_offset  (<em class="parameter"><code><a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a> *constraint</code></em>);</pre>
 330 <p>
 331 Retrieves the offset set using <a class="link" href="ClutterSnapConstraint.html#clutter-snap-constraint-set-offset" title="clutter_snap_constraint_set_offset ()"><code class="function">clutter_snap_constraint_set_offset()</code></a>
 332 </p>
 333 <div class="variablelist"><table border="0">
 334 <col align="left" valign="top">
 335 <tbody>
 336 <tr>
 337 <td><p><span class="term"><em class="parameter"><code>constraint</code></em> :</span></p></td>
 338 <td>a <a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a>
 339 </td>
 340 </tr>
 341 <tr>
 342 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 343 <td>the offset, in pixels</td>
 344 </tr>
 345 </tbody>
 346 </table></div>
 347 <p class="since">Since 1.6</p>
 348 </div>
 349 </div>
 350 <div class="refsect1">
 351 <a name="ClutterSnapConstraint.property-details"></a><h2>Property Details</h2>
 352 <div class="refsect2">
 353 <a name="ClutterSnapConstraint--from-edge"></a><h3>The <code class="literal">"from-edge"</code> property</h3>
 354 <pre class="programlisting">  "from-edge"                <a class="link" href="ClutterSnapConstraint.html#ClutterSnapEdge" title="enum ClutterSnapEdge"><span class="type">ClutterSnapEdge</span></a>       : Read / Write / Construct</pre>
 355 <p>
 356 The edge of the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> that should be snapped
 357 </p>
 358 <p>Default value: CLUTTER_SNAP_EDGE_RIGHT</p>
 359 <p class="since">Since 1.6</p>
 360 </div>
 361 <hr>
 362 <div class="refsect2">
 363 <a name="ClutterSnapConstraint--offset"></a><h3>The <code class="literal">"offset"</code> property</h3>
 364 <pre class="programlisting">  "offset"                   <a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write / Construct</pre>
 365 <p>
 366 The offset, in pixels, between <a class="link" href="ClutterSnapConstraint.html#ClutterSnapConstraint--from-edge" title='The "from-edge" property'><span class="type">"from-edge"</span></a>
 367 and <a class="link" href="ClutterSnapConstraint.html#ClutterSnapConstraint--to-edge" title='The "to-edge" property'><span class="type">"to-edge"</span></a>
 368 </p>
 369 <p>Default value: 0</p>
 370 <p class="since">Since 1.6</p>
 371 </div>
 372 <hr>
 373 <div class="refsect2">
 374 <a name="ClutterSnapConstraint--source"></a><h3>The <code class="literal">"source"</code> property</h3>
 375 <pre class="programlisting">  "source"                   <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>*         : Read / Write / Construct</pre>
 376 <p>
 377 The <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> used as the source for the constraint
 378 </p>
 379 <p class="since">Since 1.6</p>
 380 </div>
 381 <hr>
 382 <div class="refsect2">
 383 <a name="ClutterSnapConstraint--to-edge"></a><h3>The <code class="literal">"to-edge"</code> property</h3>
 384 <pre class="programlisting">  "to-edge"                  <a class="link" href="ClutterSnapConstraint.html#ClutterSnapEdge" title="enum ClutterSnapEdge"><span class="type">ClutterSnapEdge</span></a>       : Read / Write / Construct</pre>
 385 <p>
 386 The edge of the <a class="link" href="ClutterSnapConstraint.html#ClutterSnapConstraint--source" title='The "source" property'><span class="type">"source"</span></a> that should be snapped
 387 </p>
 388 <p>Default value: CLUTTER_SNAP_EDGE_RIGHT</p>
 389 <p class="since">Since 1.6</p>
 390 </div>
 391 </div>
 392 </div>
 393 <div class="footer">
 394 <hr>
 395           Generated by GTK-Doc V1.18.1</div>
 396 </body>
 397 </html>