RubyGems - clutter - Versions diffs - 2.0.0-x86-mingw32 - Mend

clutter 2.0.0-x86-mingw32

Files changed (656) hide show

data/vendor/local/share/gtk-doc/html/clutter/ClutterClone.html ADDED Viewed

@@ -0,0 +1,219 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>ClutterClone</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
+<link rel="home" href="index.html" title="Clutter Reference Manual">
+<link rel="up" href="ch02.html" title="Base actors">
+<link rel="prev" href="ClutterTexture.html" title="ClutterTexture">
+<link rel="next" href="ClutterText.html" title="ClutterText">
+<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
+<tr valign="middle">
+<td><a accesskey="p" href="ClutterTexture.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
+<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
+<th width="100%" align="center">Clutter Reference Manual</th>
+<td><a accesskey="n" href="ClutterText.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
+</tr>
+<tr><td colspan="5" class="shortcuts">
+<a href="#ClutterClone.synopsis" class="shortcut">Top</a>
+                   |
+                  <a href="#ClutterClone.description" class="shortcut">Description</a>
+                   |
+                  <a href="#ClutterClone.object-hierarchy" class="shortcut">Object Hierarchy</a>
+                   |
+                  <a href="#ClutterClone.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
+                   |
+                  <a href="#ClutterClone.properties" class="shortcut">Properties</a>
+</td></tr>
+</table>
+<div class="refentry">
+<a name="ClutterClone"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="ClutterClone.top_of_page"></a>ClutterClone</span></h2>
+<p>ClutterClone — An actor that displays a clone of a source actor</p>
+</td>
+<td valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsynopsisdiv">
+<a name="ClutterClone.synopsis"></a><h2>Synopsis</h2>
+<pre class="synopsis">struct              <a class="link" href="ClutterClone.html#ClutterClone-struct" title="struct ClutterClone">ClutterClone</a>;
+struct              <a class="link" href="ClutterClone.html#ClutterCloneClass" title="struct ClutterCloneClass">ClutterCloneClass</a>;
+<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="ClutterClone.html#clutter-clone-new" title="clutter_clone_new ()">clutter_clone_new</a>                   (<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *source</code></em>);
+<span class="returnvalue">void</span>                <a class="link" href="ClutterClone.html#clutter-clone-set-source" title="clutter_clone_set_source ()">clutter_clone_set_source</a>            (<em class="parameter"><code><a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a> *self</code></em>,
+                                                         <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *source</code></em>);
+<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="ClutterClone.html#clutter-clone-get-source" title="clutter_clone_get_source ()">clutter_clone_get_source</a>            (<em class="parameter"><code><a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a> *self</code></em>);
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterClone.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="synopsis">
+  GObject
+   +----GInitiallyUnowned
+         +----<a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
+               +----ClutterClone
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterClone.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
+<p>
+ClutterClone implements
+ <a class="link" href="ClutterContainer.html" title="ClutterContainer">ClutterContainer</a>,  <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>,  <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable">ClutterAnimatable</a> and  AtkImplementorIface.</p>
+</div>
+<div class="refsect1">
+<a name="ClutterClone.properties"></a><h2>Properties</h2>
+<pre class="synopsis">
+  "<a class="link" href="ClutterClone.html#ClutterClone--source" title='The "source" property'>source</a>"                   <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>*         : Read / Write / Construct
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterClone.description"></a><h2>Description</h2>
+<p>
+<a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a> is a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> which draws with the paint
+function of another actor, scaled to fit its own allocation.
+</p>
+<p>
+<a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a> can be used to efficiently clone any other actor.
+</p>
+<p>
+</p>
+<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+<h3 class="title">Note</h3>
+<p>This is different from <a class="link" href="ClutterTexture.html#clutter-texture-new-from-actor" title="clutter_texture_new_from_actor ()"><code class="function">clutter_texture_new_from_actor()</code></a>
+which requires support for FBOs in the underlying GL
+implementation.</p>
+</div>
+<p>
+</p>
+<p>
+<a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a> is available since Clutter 1.0
+</p>
+</div>
+<div class="refsect1">
+<a name="ClutterClone.details"></a><h2>Details</h2>
+<div class="refsect2">
+<a name="ClutterClone-struct"></a><h3>struct ClutterClone</h3>
+<pre class="programlisting">struct ClutterClone;</pre>
+<p>
+The <a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a> structure contains only private data
+and should be accessed using the provided API
+</p>
+<p class="since">Since 1.0</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterCloneClass"></a><h3>struct ClutterCloneClass</h3>
+<pre class="programlisting">struct ClutterCloneClass {
+};
+</pre>
+<p>
+The <a class="link" href="ClutterClone.html#ClutterCloneClass" title="struct ClutterCloneClass"><span class="type">ClutterCloneClass</span></a> structure contains only private data
+</p>
+<p class="since">Since 1.0</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-clone-new"></a><h3>clutter_clone_new ()</h3>
+<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_clone_new                   (<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *source</code></em>);</pre>
+<p>
+Creates a new <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> which clones <em class="parameter"><code>source</code></em>/
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
+<td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>, or <code class="literal">NULL</code>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>the newly created <a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a>
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.0</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-clone-set-source"></a><h3>clutter_clone_set_source ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                clutter_clone_set_source            (<em class="parameter"><code><a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a> *self</code></em>,
+                                                         <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *source</code></em>);</pre>
+<p>
+Sets <em class="parameter"><code>source</code></em> as the source actor to be cloned by <em class="parameter"><code>self</code></em>.
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
+<td>a <a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
+<td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.0</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-clone-get-source"></a><h3>clutter_clone_get_source ()</h3>
+<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_clone_get_source            (<em class="parameter"><code><a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a> *self</code></em>);</pre>
+<p>
+Retrieves the source <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> being cloned by <em class="parameter"><code>self</code></em>.
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
+<td>a <a class="link" href="ClutterClone.html" title="ClutterClone"><span class="type">ClutterClone</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>the actor source for the clone. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.0</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="ClutterClone.property-details"></a><h2>Property Details</h2>
+<div class="refsect2">
+<a name="ClutterClone--source"></a><h3>The <code class="literal">"source"</code> property</h3>
+<pre class="programlisting">  "source"                   <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>*         : Read / Write / Construct</pre>
+<p>
+This property specifies the source actor being cloned.
+</p>
+<p class="since">Since 1.0</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.18.1</div>
+</body>
+</html>

data/vendor/local/share/gtk-doc/html/clutter/ClutterColorizeEffect.html ADDED Viewed

@@ -0,0 +1,193 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>ClutterColorizeEffect</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
+<link rel="home" href="index.html" title="Clutter Reference Manual">
+<link rel="up" href="ch06.html" title="Effects">
+<link rel="prev" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect">
+<link rel="next" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect">
+<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
+<tr valign="middle">
+<td><a accesskey="p" href="ClutterBrightnessContrastEffect.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
+<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
+<th width="100%" align="center">Clutter Reference Manual</th>
+<td><a accesskey="n" href="ClutterDesaturateEffect.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
+</tr>
+<tr><td colspan="5" class="shortcuts">
+<a href="#ClutterColorizeEffect.synopsis" class="shortcut">Top</a>
+                   |
+                  <a href="#ClutterColorizeEffect.description" class="shortcut">Description</a>
+                   |
+                  <a href="#ClutterColorizeEffect.object-hierarchy" class="shortcut">Object Hierarchy</a>
+                   |
+                  <a href="#ClutterColorizeEffect.properties" class="shortcut">Properties</a>
+</td></tr>
+</table>
+<div class="refentry">
+<a name="ClutterColorizeEffect"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="ClutterColorizeEffect.top_of_page"></a>ClutterColorizeEffect</span></h2>
+<p>ClutterColorizeEffect — A colorization effect</p>
+</td>
+<td valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsynopsisdiv">
+<a name="ClutterColorizeEffect.synopsis"></a><h2>Synopsis</h2>
+<pre class="synopsis">                    <a class="link" href="ClutterColorizeEffect.html#ClutterColorizeEffect-struct" title="ClutterColorizeEffect">ClutterColorizeEffect</a>;
+<a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="returnvalue">ClutterEffect</span></a> *     <a class="link" href="ClutterColorizeEffect.html#clutter-colorize-effect-new" title="clutter_colorize_effect_new ()">clutter_colorize_effect_new</a>         (<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *tint</code></em>);
+<span class="returnvalue">void</span>                <a class="link" href="ClutterColorizeEffect.html#clutter-colorize-effect-set-tint" title="clutter_colorize_effect_set_tint ()">clutter_colorize_effect_set_tint</a>    (<em class="parameter"><code><a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> *effect</code></em>,
+                                                         <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *tint</code></em>);
+<span class="returnvalue">void</span>                <a class="link" href="ClutterColorizeEffect.html#clutter-colorize-effect-get-tint" title="clutter_colorize_effect_get_tint ()">clutter_colorize_effect_get_tint</a>    (<em class="parameter"><code><a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> *effect</code></em>,
+                                                         <em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *tint</code></em>);
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterColorizeEffect.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="synopsis">
+  GObject
+   +----GInitiallyUnowned
+         +----<a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta">ClutterActorMeta</a>
+               +----<a class="link" href="ClutterEffect.html" title="ClutterEffect">ClutterEffect</a>
+                     +----<a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect">ClutterOffscreenEffect</a>
+                           +----ClutterColorizeEffect
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterColorizeEffect.properties"></a><h2>Properties</h2>
+<pre class="synopsis">
+  "<a class="link" href="ClutterColorizeEffect.html#ClutterColorizeEffect--tint" title='The "tint" property'>tint</a>"                     <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterColorizeEffect.description"></a><h2>Description</h2>
+<p>
+<a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> is a sub-class of <a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="type">ClutterEffect</span></a> that
+colorizes an actor with the given tint.
+</p>
+<p>
+<a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> is available since Clutter 1.4
+</p>
+</div>
+<div class="refsect1">
+<a name="ClutterColorizeEffect.details"></a><h2>Details</h2>
+<div class="refsect2">
+<a name="ClutterColorizeEffect-struct"></a><h3>ClutterColorizeEffect</h3>
+<pre class="programlisting">typedef struct _ClutterColorizeEffect ClutterColorizeEffect;</pre>
+<p>
+<span class="structname">ClutterColorizeEffect</span> is an opaque structure
+whose members cannot be directly accessed
+</p>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-colorize-effect-new"></a><h3>clutter_colorize_effect_new ()</h3>
+<pre class="programlisting"><a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="returnvalue">ClutterEffect</span></a> *     clutter_colorize_effect_new         (<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *tint</code></em>);</pre>
+<p>
+Creates a new <a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> to be used with
+<a class="link" href="ClutterActor.html#clutter-actor-add-effect" title="clutter_actor_add_effect ()"><code class="function">clutter_actor_add_effect()</code></a>
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>tint</code></em> :</span></p></td>
+<td>the color to be used</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>the newly created <a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> or <code class="literal">NULL</code>
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-colorize-effect-set-tint"></a><h3>clutter_colorize_effect_set_tint ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                clutter_colorize_effect_set_tint    (<em class="parameter"><code><a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> *effect</code></em>,
+                                                         <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *tint</code></em>);</pre>
+<p>
+Sets the tint to be used when colorizing
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
+<td>a <a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>tint</code></em> :</span></p></td>
+<td>the color to be used</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-colorize-effect-get-tint"></a><h3>clutter_colorize_effect_get_tint ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                clutter_colorize_effect_get_tint    (<em class="parameter"><code><a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> *effect</code></em>,
+                                                         <em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *tint</code></em>);</pre>
+<p>
+Retrieves the tint used by <em class="parameter"><code>effect</code></em>
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
+<td>a <a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>tint</code></em> :</span></p></td>
+<td>return location for the color used. <span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.4</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="ClutterColorizeEffect.property-details"></a><h2>Property Details</h2>
+<div class="refsect2">
+<a name="ClutterColorizeEffect--tint"></a><h3>The <code class="literal">"tint"</code> property</h3>
+<pre class="programlisting">  "tint"                     <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write</pre>
+<p>
+The tint to apply to the actor
+</p>
+<p class="since">Since 1.4</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="ClutterColorizeEffect.see-also"></a><h2>See Also</h2>
+<a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="type">ClutterEffect</span></a>, <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.18.1</div>
+</body>
+</html>

data/vendor/local/share/gtk-doc/html/clutter/ClutterConstraint.html ADDED Viewed

@@ -0,0 +1,336 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>ClutterConstraint</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
+<link rel="home" href="index.html" title="Clutter Reference Manual">
+<link rel="up" href="ch01.html" title="Abstract classes and interfaces">
+<link rel="prev" href="ClutterAction.html" title="ClutterAction">
+<link rel="next" href="ClutterEffect.html" title="ClutterEffect">
+<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
+<tr valign="middle">
+<td><a accesskey="p" href="ClutterAction.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
+<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
+<th width="100%" align="center">Clutter Reference Manual</th>
+<td><a accesskey="n" href="ClutterEffect.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
+</tr>
+<tr><td colspan="5" class="shortcuts">
+<a href="#ClutterConstraint.synopsis" class="shortcut">Top</a>
+                   |
+                  <a href="#ClutterConstraint.description" class="shortcut">Description</a>
+                   |
+                  <a href="#ClutterConstraint.object-hierarchy" class="shortcut">Object Hierarchy</a>
+</td></tr>
+</table>
+<div class="refentry">
+<a name="ClutterConstraint"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="ClutterConstraint.top_of_page"></a>ClutterConstraint</span></h2>
+<p>ClutterConstraint — Abstract class for constraints on position or size</p>
+</td>
+<td valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsynopsisdiv">
+<a name="ClutterConstraint.synopsis"></a><h2>Synopsis</h2>
+<pre class="synopsis">                    <a class="link" href="ClutterConstraint.html#ClutterConstraint-struct" title="ClutterConstraint">ClutterConstraint</a>;
+struct              <a class="link" href="ClutterConstraint.html#ClutterConstraintClass" title="struct ClutterConstraintClass">ClutterConstraintClass</a>;
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterConstraint.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="synopsis">
+  GObject
+   +----GInitiallyUnowned
+         +----<a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta">ClutterActorMeta</a>
+               +----ClutterConstraint
+                     +----<a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint">ClutterAlignConstraint</a>
+                     +----<a class="link" href="ClutterBindConstraint.html" title="ClutterBindConstraint">ClutterBindConstraint</a>
+                     +----<a class="link" href="ClutterPathConstraint.html" title="ClutterPathConstraint">ClutterPathConstraint</a>
+                     +----<a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint">ClutterSnapConstraint</a>
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterConstraint.description"></a><h2>Description</h2>
+<p>
+<a class="link" href="ClutterConstraint.html" title="ClutterConstraint"><span class="type">ClutterConstraint</span></a> is a base abstract class for modifiers of a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>
+position or size.
+</p>
+<p>
+A <a class="link" href="ClutterConstraint.html" title="ClutterConstraint"><span class="type">ClutterConstraint</span></a> sub-class should contain the logic for modifying
+the position or size of the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to which it is applied, by
+updating the actor's allocation. Each <a class="link" href="ClutterConstraint.html" title="ClutterConstraint"><span class="type">ClutterConstraint</span></a> can change the
+allocation of the actor to which they are applied by overriding the
+<code class="function">ClutterConstraintClass.update_allocation()</code> virtual function.
+</p>
+<p>
+</p>
+<div class="refsect2">
+<a name="ClutterConstraint-usage"></a><h3>Using Constraints</h3>
+<p>Constraints can be used with fixed layout managers, like
+  <a class="link" href="ClutterFixedLayout.html" title="ClutterFixedLayout"><span class="type">ClutterFixedLayout</span></a>, or with actors implicitly using a fixed layout
+  manager, like <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> and <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>.</p>
+<p>Constraints provide a way to build user interfaces by using
+  relations between <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>s, without explicit fixed
+  positioning and sizing, similarly to how fluid layout managers like
+  <a class="link" href="ClutterBoxLayout.html" title="ClutterBoxLayout"><span class="type">ClutterBoxLayout</span></a> and <a class="link" href="ClutterTableLayout.html" title="ClutterTableLayout"><span class="type">ClutterTableLayout</span></a> lay out their children.</p>
+<p>Constraints are attached to a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>, and are available
+  for inspection using <a class="link" href="ClutterActor.html#clutter-actor-get-constraints" title="clutter_actor_get_constraints ()"><code class="function">clutter_actor_get_constraints()</code></a>.</p>
+<p>Clutter provides different implementation of the <a class="link" href="ClutterConstraint.html" title="ClutterConstraint"><span class="type">ClutterConstraint</span></a>
+  abstract class, for instance:</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a></span></p></td>
+<td>this constraint can be used to align an actor
+      to another one, on either the horizontal or the vertical axis; the
+      <a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a> uses a normalized offset between 0.0 (the
+      top or the left of the source actor, depending on the axis) and
+      1.0 (the bottom or the right of the source actor, depending on the
+      axis).</td>
+</tr>
+<tr>
+<td><p><span class="term"><a class="link" href="ClutterBindConstraint.html" title="ClutterBindConstraint"><span class="type">ClutterBindConstraint</span></a></span></p></td>
+<td>this constraint binds the X, Y, width or height
+      of an actor to the corresponding position or size of a source
+      actor; it can also apply an offset.</td>
+</tr>
+<tr>
+<td><p><span class="term"><a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a></span></p></td>
+<td>this constraint "snaps" together the edges of
+      two <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>s; if an actor uses two constraints on
+      both its horizontal or vertical edges then it can also expand to
+      fit the empty space.</td>
+</tr>
+</tbody>
+</table></div>
+<div class="example">
+<a name="ClutterConstraint-usage-example"></a><p class="title"><b>Example 2. Usage of constraints</b></p>
+<div class="example-contents">
+<p>The example below uses various <a class="link" href="ClutterConstraint.html" title="ClutterConstraint"><span class="type">ClutterConstraint</span></a>s to
+    lay out three actors on a resizable stage. Only the central actor has
+    an explicit size, and no actor has an explicit position.</p>
+<div class="orderedlist"><ol class="orderedlist" type="1">
+<li class="listitem">The <a class="link" href="ClutterRectangle.html" title="ClutterRectangle"><span class="type">ClutterRectangle</span></a> with <a class="link" href="ClutterActor.html#ClutterActor--name" title='The "name" property'><span class="type">"name"</span></a>
+      <span class="emphasis"><em>layerA</em></span> is explicitly sized to 100 pixels by 25
+      pixels, and it's added to the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>;</li>
+<li class="listitem">two <a class="link" href="ClutterAlignConstraint.html" title="ClutterAlignConstraint"><span class="type">ClutterAlignConstraint</span></a>s are used
+      to anchor <span class="emphasis"><em>layerA</em></span> to the center of the stage,
+      by using 0.5 as the alignment <a class="link" href="ClutterAlignConstraint.html#ClutterAlignConstraint--factor" title='The "factor" property'><span class="type">"factor"</span></a> on
+      both the X and Y axis.</li>
+<li class="listitem">the <a class="link" href="ClutterRectangle.html" title="ClutterRectangle"><span class="type">ClutterRectangle</span></a> with <a class="link" href="ClutterActor.html#ClutterActor--name" title='The "name" property'><span class="type">"name"</span></a>
+      <span class="emphasis"><em>layerB</em></span> is added to the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> with
+      no explicit size;</li>
+<li class="listitem">the <a class="link" href="ClutterActor.html#ClutterActor--x" title='The "x" property'><span class="type">"x"</span></a> and <a class="link" href="ClutterActor.html#ClutterActor--width" title='The "width" property'><span class="type">"width"</span></a>
+      of <span class="emphasis"><em>layerB</em></span> are bound to the same properties
+      of <span class="emphasis"><em>layerA</em></span> using two <a class="link" href="ClutterBindConstraint.html" title="ClutterBindConstraint"><span class="type">ClutterBindConstraint</span></a>
+      objects, thus keeping <span class="emphasis"><em>layerB</em></span> aligned to
+      <span class="emphasis"><em>layerA</em></span>;</li>
+<li class="listitem">the top edge of <span class="emphasis"><em>layerB</em></span> is
+      snapped together with the bottom edge of <span class="emphasis"><em>layerA</em></span>;
+      the bottom edge of <span class="emphasis"><em>layerB</em></span> is also snapped
+      together with the bottom edge of the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>; an offset is
+      given to the two <a class="link" href="ClutterSnapConstraint.html" title="ClutterSnapConstraint"><span class="type">ClutterSnapConstraint</span></a>s to allow for some
+      padding; since <span class="emphasis"><em>layerB</em></span> is snapped between two
+      different <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>s, its height is stretched to match
+      the gap;</li>
+<li class="listitem">the <a class="link" href="ClutterRectangle.html" title="ClutterRectangle"><span class="type">ClutterRectangle</span></a> with <a class="link" href="ClutterActor.html#ClutterActor--name" title='The "name" property'><span class="type">"name"</span></a>
+      <span class="emphasis"><em>layerC</em></span> mirrors <span class="emphasis"><em>layerB</em></span>,
+      snapping the top edge of the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> to the top edge of
+      <span class="emphasis"><em>layerC</em></span> and the top edge of
+      <span class="emphasis"><em>layerA</em></span> to the bottom edge of
+      <span class="emphasis"><em>layerC</em></span>;</li>
+</ol></div>
+<div class="figure">
+<a name="constraints-example"></a><p class="title"><b>Figure 3. Constraints</b></p>
+<div class="figure-contents"><div><img src="constraints-example.png" alt="Constraints"></div></div>
+</div>
+<br class="figure-break"><pre class="programlisting">
+#include &lt;stdlib.h&gt;
+#include &lt;clutter/clutter.h&gt;
+int
+main (int argc, char *argv[])
+{
+  ClutterActor *stage, *layer_a, *layer_b, *layer_c;
+  if (clutter_init (&amp;argc, &amp;argv) != CLUTTER_INIT_SUCCESS)
+    return 1;
+  /* the main container */
+  stage = clutter_stage_new ();
+  clutter_actor_set_name (stage, "stage");
+  clutter_stage_set_title (CLUTTER_STAGE (stage), "Snap Constraint");
+  clutter_actor_set_background_color (stage, CLUTTER_COLOR_Aluminium1);
+  clutter_stage_set_user_resizable (CLUTTER_STAGE (stage), TRUE);
+  g_signal_connect (stage, "destroy", G_CALLBACK (clutter_main_quit), NULL);
+  /* first layer, with a fixed (100, 25) size */
+  layer_a = clutter_actor_new ();
+  clutter_actor_set_background_color (layer_a, CLUTTER_COLOR_ScarletRed);
+  clutter_actor_set_name (layer_a, "layerA");
+  clutter_actor_set_size (layer_a, 100.0, 25.0);
+  clutter_actor_add_child (stage, layer_a);
+  /* the first layer is anchored to the middle of the stage */
+  clutter_actor_add_constraint (layer_a, clutter_align_constraint_new (stage, CLUTTER_ALIGN_BOTH, 0.5));
+  /* second layer, with no implicit size */
+  layer_b = clutter_actor_new ();
+  clutter_actor_set_background_color (layer_b, CLUTTER_COLOR_DarkButter);
+  clutter_actor_set_name (layer_b, "layerB");
+  clutter_actor_add_child (stage, layer_b);
+  /* the second layer tracks the X coordinate and the width of
+   * the first layer
+   */
+  clutter_actor_add_constraint (layer_b, clutter_bind_constraint_new (layer_a, CLUTTER_BIND_X, 0.0));
+  clutter_actor_add_constraint (layer_b, clutter_bind_constraint_new (layer_a, CLUTTER_BIND_WIDTH, 0.0));
+  /* the second layer is snapped between the bottom edge of
+   * the first layer, and the bottom edge of the stage; a
+   * spacing of 10 pixels in each direction is added for padding
+   */
+  clutter_actor_add_constraint (layer_b,
+                                clutter_snap_constraint_new (layer_a,
+                                                             CLUTTER_SNAP_EDGE_TOP,
+                                                             CLUTTER_SNAP_EDGE_BOTTOM,
+                                                             10.0));
+  clutter_actor_add_constraint (layer_b,
+                                clutter_snap_constraint_new (stage,
+                                                             CLUTTER_SNAP_EDGE_BOTTOM,
+                                                             CLUTTER_SNAP_EDGE_BOTTOM,
+                                                             -10.0));
+  /* the third layer, with no implicit size */
+  layer_c = clutter_actor_new ();
+  clutter_actor_set_background_color (layer_c, CLUTTER_COLOR_LightChameleon);
+  clutter_actor_set_name (layer_c, "layerC");
+  clutter_actor_add_child (stage, layer_c);
+  /* as for the second layer, the third layer tracks the X
+   * coordinate and width of the first layer
+   */
+  clutter_actor_add_constraint (layer_c, clutter_bind_constraint_new (layer_a, CLUTTER_BIND_X, 0.0));
+  clutter_actor_add_constraint (layer_c, clutter_bind_constraint_new (layer_a, CLUTTER_BIND_WIDTH, 0.0));
+  /* the third layer is snapped between the top edge of the stage
+   * and the top edge of the first layer; again, a spacing of
+   * 10 pixels in each direction is added for padding
+   */
+  clutter_actor_add_constraint (layer_c,
+                                clutter_snap_constraint_new (layer_a,
+                                                             CLUTTER_SNAP_EDGE_BOTTOM,
+                                                             CLUTTER_SNAP_EDGE_TOP,
+                                                             -10.0));
+  clutter_actor_add_constraint (layer_c,
+                                clutter_snap_constraint_new (stage,
+                                                             CLUTTER_SNAP_EDGE_TOP,
+                                                             CLUTTER_SNAP_EDGE_TOP,
+                                                             10.0));
+  clutter_actor_show (stage);
+  clutter_main ();
+  return EXIT_SUCCESS;
+}
+    </pre>
+<p>You can try resizing interactively the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> and verify
+    that the three <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>s maintain the same position and
+    size relative to each other, and to the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>.</p>
+</div>
+</div>
+<br class="example-break"><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
+<h3 class="title">Warning</h3>
+<p>It's important to note that Clutter does not avoid loops
+  or competing constraints; if two or more <a class="link" href="ClutterConstraint.html" title="ClutterConstraint"><span class="type">ClutterConstraint</span></a>s
+  are operating on the same positional or dimensional attributes of an
+  actor, or if the constraints on two different actors depend on each
+  other, then the behavior is undefined.</p>
+</div>
+</div>
+<p>
+</p>
+<p>
+</p>
+<div class="refsect2">
+<a name="ClutterConstraint-implementation"></a><h3>Implementing a ClutterConstraint</h3>
+<p>Creating a sub-class of <a class="link" href="ClutterConstraint.html" title="ClutterConstraint"><span class="type">ClutterConstraint</span></a> requires the
+  implementation of the <code class="function"><code class="function">update_allocation()</code></code>
+  virtual function.</p>
+<p>The <code class="function"><code class="function">update_allocation()</code></code> virtual function
+  is called during the allocation sequence of a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>, and
+  allows any <a class="link" href="ClutterConstraint.html" title="ClutterConstraint"><span class="type">ClutterConstraint</span></a> attached to that actor to modify the
+  allocation before it is passed to the <code class="function"><code class="function">allocate()</code></code>
+  implementation.</p>
+<p>The <a class="link" href="clutter-Base-geometric-types.html#ClutterActorBox" title="struct ClutterActorBox"><span class="type">ClutterActorBox</span></a> passed to the
+  <code class="function"><code class="function">update_allocation()</code></code> implementation contains the
+  original allocation of the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>, plus the eventual modifications
+  applied by the other <a class="link" href="ClutterConstraint.html" title="ClutterConstraint"><span class="type">ClutterConstraint</span></a>s.</p>
+<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+<h3 class="title">Note</h3>
+<p>Constraints are queried in the same order as they were
+  applied using <a class="link" href="ClutterActor.html#clutter-actor-add-constraint" title="clutter_actor_add_constraint ()"><code class="function">clutter_actor_add_constraint()</code></a> or
+  <a class="link" href="ClutterActor.html#clutter-actor-add-constraint-with-name" title="clutter_actor_add_constraint_with_name ()"><code class="function">clutter_actor_add_constraint_with_name()</code></a>.</p>
+</div>
+<p>It is not necessary for a <a class="link" href="ClutterConstraint.html" title="ClutterConstraint"><span class="type">ClutterConstraint</span></a> sub-class to chain
+  up to the parent's implementation.</p>
+<p>If a <a class="link" href="ClutterConstraint.html" title="ClutterConstraint"><span class="type">ClutterConstraint</span></a> is parametrized - i.e. if it contains
+  properties that affect the way the constraint is implemented - it should
+  call <a class="link" href="ClutterActor.html#clutter-actor-queue-relayout" title="clutter_actor_queue_relayout ()"><code class="function">clutter_actor_queue_relayout()</code></a> on the actor to which it is attached
+  to whenever any parameter is changed. The actor to which it is attached
+  can be recovered at any point using <a class="link" href="ClutterActorMeta.html#clutter-actor-meta-get-actor" title="clutter_actor_meta_get_actor ()"><code class="function">clutter_actor_meta_get_actor()</code></a>.</p>
+</div>
+<p>
+</p>
+<p>
+<a class="link" href="ClutterConstraint.html" title="ClutterConstraint"><span class="type">ClutterConstraint</span></a> is available since Clutter 1.4
+</p>
+</div>
+<div class="refsect1">
+<a name="ClutterConstraint.details"></a><h2>Details</h2>
+<div class="refsect2">
+<a name="ClutterConstraint-struct"></a><h3>ClutterConstraint</h3>
+<pre class="programlisting">typedef struct _ClutterConstraint ClutterConstraint;</pre>
+<p>
+The <span class="structname">ClutterConstraint</span> structure contains only
+private data and should be accessed using the provided API
+</p>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterConstraintClass"></a><h3>struct ClutterConstraintClass</h3>
+<pre class="programlisting">struct ClutterConstraintClass {
+};
+</pre>
+<p>
+The <span class="structname">ClutterConstraintClass</span> structure contains
+only private data
+</p>
+<p class="since">Since 1.4</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="ClutterConstraint.see-also"></a><h2>See Also</h2>
+<a class="link" href="ClutterAction.html" title="ClutterAction"><span class="type">ClutterAction</span></a>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.18.1</div>
+</body>
+</html>