RubyGems - clutter - Versions diffs - 2.2.4-x64-mingw32 - Mend

clutter 2.2.4-x64-mingw32

Files changed (744) hide show

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

@@ -0,0 +1,364 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Clutter Reference Manual: ClutterScriptable</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<link rel="home" href="index.html" title="Clutter Reference Manual">
+<link rel="up" href="ch11.html" title="User interface definition">
+<link rel="prev" href="ClutterScript.html" title="ClutterScript">
+<link rel="next" href="ch12.html" title="Generic list model">
+<meta name="generator" content="GTK-Doc V1.20.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="5"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span>
+                  <a href="#ClutterScriptable.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
+                  <a href="#ClutterScriptable.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites">  <span class="dim">|</span>
+                  <a href="#ClutterScriptable.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations">  <span class="dim">|</span>
+                  <a href="#ClutterScriptable.implementations" class="shortcut">Known Implementations</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="ch11.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="ClutterScript.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="ch12.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="ClutterScriptable"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="ClutterScriptable.top_of_page"></a>ClutterScriptable</span></h2>
+<p>ClutterScriptable — Override the UI definition parsing</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="ClutterScriptable.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_return">
+<col class="functions_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="function_type">
+<span class="returnvalue">void</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterScriptable.html#clutter-scriptable-set-id" title="clutter_scriptable_set_id ()">clutter_scriptable_set_id</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">const <span class="returnvalue">gchar</span> *
+</td>
+<td class="function_name">
+<a class="link" href="ClutterScriptable.html#clutter-scriptable-get-id" title="clutter_scriptable_get_id ()">clutter_scriptable_get_id</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterScriptable.html#clutter-scriptable-parse-custom-node" title="clutter_scriptable_parse_custom_node ()">clutter_scriptable_parse_custom_node</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">void</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterScriptable.html#clutter-scriptable-set-custom-property" title="clutter_scriptable_set_custom_property ()">clutter_scriptable_set_custom_property</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="ClutterScriptable.other"></a><h2>Types and Values</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="name">
+<col class="description">
+</colgroup>
+<tbody>
+<tr>
+<td class="datatype_keyword"> </td>
+<td class="function_name"><a class="link" href="ClutterScriptable.html#ClutterScriptable-struct" title="ClutterScriptable">ClutterScriptable</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword">struct</td>
+<td class="function_name"><a class="link" href="ClutterScriptable.html#ClutterScriptableIface" title="struct ClutterScriptableIface">ClutterScriptableIface</a></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="ClutterScriptable.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="screen">    GInterface
+    <span class="lineart">╰──</span> ClutterScriptable
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterScriptable.prerequisites"></a><h2>Prerequisites</h2>
+<p>
+ClutterScriptable requires
+ GObject.</p>
+</div>
+<div class="refsect1">
+<a name="ClutterScriptable.implementations"></a><h2>Known Implementations</h2>
+<p>
+ClutterScriptable is implemented by
+ <a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>,  <a class="link" href="ClutterAlpha.html" title="ClutterAlpha">ClutterAlpha</a>,  <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation">ClutterAnimation</a>,  <a class="link" href="ClutterAnimator.html" title="ClutterAnimator">ClutterAnimator</a>,  <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a>,  <a class="link" href="ClutterBehaviourDepth.html" title="ClutterBehaviourDepth">ClutterBehaviourDepth</a>,  <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse">ClutterBehaviourEllipse</a>,  <a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity">ClutterBehaviourOpacity</a>,  <a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath">ClutterBehaviourPath</a>,  <a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate">ClutterBehaviourRotate</a>,  <a class="link" href="ClutterBehaviourScale.html" title="ClutterBehaviourScale">ClutterBehaviourScale</a>,  <a class="link" href="ClutterBox.html" title="ClutterBox">ClutterBox</a>,  <a class="link" href="ClutterCairoTexture.html" title="ClutterCairoTexture">ClutterCairoTexture</a>,  <a class="link" href="ClutterClone.html" title="ClutterClone">ClutterClone</a>,  <a class="link" href="ClutterGroup.html" title="ClutterGroup">ClutterGroup</a>,  <a class="link" href="clutter-Value-intervals.html#ClutterInterval">ClutterInterval</a>,  <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition">ClutterKeyframeTransition</a>,  <a class="link" href="ClutterListModel.html" title="ClutterListModel">ClutterListModel</a>,  <a class="link" href="ClutterModel.html" title="ClutterModel">ClutterModel</a>,  <a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition">ClutterPropertyTransition</a>,  <a class="link" href="ClutterRectangle.html" title="ClutterRectangle">ClutterRectangle</a>,  <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor">ClutterScrollActor</a>,  <a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a>,  <a class="link" href="ClutterState.html" title="ClutterState">ClutterState</a>,  <a class="link" href="ClutterText.html" title="ClutterText">ClutterText</a>,  <a class="link" href="ClutterTexture.html" title="ClutterTexture">ClutterTexture</a>,  <a class="link" href="ClutterTimeline.html" title="ClutterTimeline">ClutterTimeline</a>,  <a class="link" href="ClutterTransition.html" title="ClutterTransition">ClutterTransition</a> and  <a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup">ClutterTransitionGroup</a>.</p>
+</div>
+<div class="refsect1">
+<a name="ClutterScriptable.description"></a><h2>Description</h2>
+<p>The <a class="link" href="ClutterScriptable.html#ClutterScriptableIface" title="struct ClutterScriptableIface"><span class="type">ClutterScriptableIface</span></a> interface exposes the UI definition parsing
+process to external classes. By implementing this interface, a class can
+override the UI definition parsing and transform complex data types into
+GObject properties, or allow custom properties.</p>
+<p><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> is available since Clutter 0.6</p>
+</div>
+<div class="refsect1">
+<a name="ClutterScriptable.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="clutter-scriptable-set-id"></a><h3>clutter_scriptable_set_id ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_scriptable_set_id (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>,
+                           <em class="parameter"><code>const <span class="type">gchar</span> *id_</code></em>);</pre>
+<p>Sets <em class="parameter"><code>id_</code></em>
+ as the unique Clutter script it for this instance of
+<a class="link" href="ClutterScriptable.html#ClutterScriptableIface" title="struct ClutterScriptableIface"><span class="type">ClutterScriptableIface</span></a>.</p>
+<p>This name can be used by user interface designer applications to
+define a unique name for an object constructable using the UI
+definition language parsed by <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>.</p>
+<div class="refsect3">
+<a name="id-1.7.3.3.9.2.6"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>scriptable</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>id_</p></td>
+<td class="parameter_description"><p>the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> id of the object</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-scriptable-get-id"></a><h3>clutter_scriptable_get_id ()</h3>
+<pre class="programlisting">const <span class="returnvalue">gchar</span> *
+clutter_scriptable_get_id (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>);</pre>
+<p>Retrieves the id of <em class="parameter"><code>scriptable</code></em>
+ set using <a class="link" href="ClutterScriptable.html#clutter-scriptable-set-id" title="clutter_scriptable_set_id ()"><code class="function">clutter_scriptable_set_id()</code></a>.</p>
+<div class="refsect3">
+<a name="id-1.7.3.3.9.3.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>scriptable</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.3.3.9.3.6"></a><h4>Returns</h4>
+<p> the id of the object. The returned string is owned by
+the scriptable object and should never be modified of freed</p>
+<p></p>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-scriptable-parse-custom-node"></a><h3>clutter_scriptable_parse_custom_node ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+clutter_scriptable_parse_custom_node (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>,
+                                      <em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
+                                      <em class="parameter"><code><span class="type">GValue</span> *value</code></em>,
+                                      <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
+                                      <em class="parameter"><code><span class="type">JsonNode</span> *node</code></em>);</pre>
+<p>Parses the passed JSON node. The implementation must set the type
+of the passed <span class="type">GValue</span> pointer using <code class="function">g_value_init()</code>.</p>
+<div class="refsect3">
+<a name="id-1.7.3.3.9.4.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>scriptable</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>script</p></td>
+<td class="parameter_description"><p>the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> creating the scriptable instance</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>value</p></td>
+<td class="parameter_description"><p>the generic value to be set</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>name</p></td>
+<td class="parameter_description"><p>the name of the node</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>node</p></td>
+<td class="parameter_description"><p>the JSON node to be parsed</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.3.3.9.4.6"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> if the node was successfully parsed, <code class="literal">FALSE</code> otherwise.</p>
+<p></p>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-scriptable-set-custom-property"></a><h3>clutter_scriptable_set_custom_property ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_scriptable_set_custom_property
+                               (<em class="parameter"><code><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> *scriptable</code></em>,
+                                <em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
+                                <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
+                                <em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);</pre>
+<p>Overrides the common properties setting. The underlying virtual
+function should be used when implementing custom properties.</p>
+<div class="refsect3">
+<a name="id-1.7.3.3.9.5.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>scriptable</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>script</p></td>
+<td class="parameter_description"><p>the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> creating the scriptable instance</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>name</p></td>
+<td class="parameter_description"><p>the name of the property</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>value</p></td>
+<td class="parameter_description"><p>the value of the property</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="ClutterScriptable.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="ClutterScriptable-struct"></a><h3>ClutterScriptable</h3>
+<pre class="programlisting">typedef struct _ClutterScriptable ClutterScriptable;</pre>
+<p><a class="link" href="ClutterScriptable.html" title="ClutterScriptable"><span class="type">ClutterScriptable</span></a> is an opaque structure whose members cannot be directly
+accessed</p>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterScriptableIface"></a><h3>struct ClutterScriptableIface</h3>
+<pre class="programlisting">struct ClutterScriptableIface {
+  void         (* set_id)              (ClutterScriptable *scriptable,
+                                        const gchar       *id_);
+  const gchar *(* get_id)              (ClutterScriptable *scriptable);
+  gboolean     (* parse_custom_node)   (ClutterScriptable *scriptable,
+                                        ClutterScript     *script,
+                                        GValue            *value,
+                                        const gchar       *name,
+                                        JsonNode          *node);
+  void         (* set_custom_property) (ClutterScriptable *scriptable,
+                                        ClutterScript     *script,
+                                        const gchar       *name,
+                                        const GValue      *value);
+};
+</pre>
+<p>Interface for implementing "scriptable" objects. An object implementing
+this interface can override the parsing and properties setting sequence
+when loading a UI definition data with <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p>
+<div class="refsect3">
+<a name="id-1.7.3.3.10.3.5"></a><h4>Members</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="300px" class="struct_members_name">
+<col class="struct_members_description">
+<col width="200px" class="struct_members_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterScriptableIface.set-id"></a>set_id</code></em> ()</p></td>
+<td class="struct_member_description"><p>virtual function for setting the id of a scriptable object</p></td>
+<td class="struct_member_annotations"> </td>
+</tr>
+<tr>
+<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterScriptableIface.get-id"></a>get_id</code></em> ()</p></td>
+<td class="struct_member_description"><p>virtual function for getting the id of a scriptable object</p></td>
+<td class="struct_member_annotations"> </td>
+</tr>
+<tr>
+<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterScriptableIface.parse-custom-node"></a>parse_custom_node</code></em> ()</p></td>
+<td class="struct_member_description"><p>virtual function for parsing complex data containers
+into GObject properties</p></td>
+<td class="struct_member_annotations"> </td>
+</tr>
+<tr>
+<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterScriptableIface.set-custom-property"></a>set_custom_property</code></em> ()</p></td>
+<td class="struct_member_description"><p>virtual function for setting a custom property</p></td>
+<td class="struct_member_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.20.1</div>
+</body>
+</html>

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

@@ -0,0 +1,385 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Clutter Reference Manual: ClutterScrollActor</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<link rel="home" href="index.html" title="Clutter Reference Manual">
+<link rel="up" href="ch02.html" title="Base actors">
+<link rel="prev" href="ClutterText.html" title="ClutterText">
+<link rel="next" href="ch03.html" title="Layout managers">
+<meta name="generator" content="GTK-Doc V1.20.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="5"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span>
+                  <a href="#ClutterScrollActor.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
+                  <a href="#ClutterScrollActor.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span>
+                  <a href="#ClutterScrollActor.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span>
+                  <a href="#ClutterScrollActor.properties" class="shortcut">Properties</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="ClutterText.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="ch03.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="ClutterScrollActor"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="ClutterScrollActor.top_of_page"></a>ClutterScrollActor</span></h2>
+<p>ClutterScrollActor — An actor for displaying a portion of its children</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="ClutterScrollActor.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_return">
+<col class="functions_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="function_type">
+<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="ClutterScrollActor.html#clutter-scroll-actor-new" title="clutter_scroll_actor_new ()">clutter_scroll_actor_new</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">void</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterScrollActor.html#clutter-scroll-actor-set-scroll-mode" title="clutter_scroll_actor_set_scroll_mode ()">clutter_scroll_actor_set_scroll_mode</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="ClutterScrollActor.html#ClutterScrollMode" title="enum ClutterScrollMode"><span class="returnvalue">ClutterScrollMode</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterScrollActor.html#clutter-scroll-actor-get-scroll-mode" title="clutter_scroll_actor_get_scroll_mode ()">clutter_scroll_actor_get_scroll_mode</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">void</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterScrollActor.html#clutter-scroll-actor-scroll-to-point" title="clutter_scroll_actor_scroll_to_point ()">clutter_scroll_actor_scroll_to_point</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">void</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterScrollActor.html#clutter-scroll-actor-scroll-to-rect" title="clutter_scroll_actor_scroll_to_rect ()">clutter_scroll_actor_scroll_to_rect</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="ClutterScrollActor.properties"></a><h2>Properties</h2>
+<div class="informaltable"><table border="0">
+<colgroup>
+<col width="150px" class="properties_type">
+<col width="300px" class="properties_name">
+<col width="200px" class="properties_flags">
+</colgroup>
+<tbody><tr>
+<td class="property_type"><a class="link" href="ClutterScrollActor.html#ClutterScrollMode" title="enum ClutterScrollMode"><span class="type">ClutterScrollMode</span></a></td>
+<td class="property_name"><a class="link" href="ClutterScrollActor.html#ClutterScrollActor--scroll-mode" title="The “scroll-mode” property">scroll-mode</a></td>
+<td class="property_flags">Read / Write</td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="ClutterScrollActor.other"></a><h2>Types and Values</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="name">
+<col class="description">
+</colgroup>
+<tbody>
+<tr>
+<td class="datatype_keyword"> </td>
+<td class="function_name"><a class="link" href="ClutterScrollActor.html#ClutterScrollActor-struct" title="ClutterScrollActor">ClutterScrollActor</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword">struct</td>
+<td class="function_name"><a class="link" href="ClutterScrollActor.html#ClutterScrollActorClass" title="struct ClutterScrollActorClass">ClutterScrollActorClass</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword">enum</td>
+<td class="function_name"><a class="link" href="ClutterScrollActor.html#ClutterScrollMode" title="enum ClutterScrollMode">ClutterScrollMode</a></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="ClutterScrollActor.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="screen">    GObject
+    <span class="lineart">╰──</span> GInitiallyUnowned
+        <span class="lineart">╰──</span> <a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
+            <span class="lineart">╰──</span> ClutterScrollActor
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterScrollActor.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
+<p>
+ClutterScrollActor 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="ClutterScrollActor.description"></a><h2>Description</h2>
+<p><a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> is an actor that can be used to display a portion
+of the contents of its children.</p>
+<p>The extent of the area of a <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> is defined by the size
+of its children; the visible region of the children of a <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a>
+is set by using <a class="link" href="ClutterScrollActor.html#clutter-scroll-actor-scroll-to-point" title="clutter_scroll_actor_scroll_to_point ()"><code class="function">clutter_scroll_actor_scroll_to_point()</code></a> or by using
+<a class="link" href="ClutterScrollActor.html#clutter-scroll-actor-scroll-to-rect" title="clutter_scroll_actor_scroll_to_rect ()"><code class="function">clutter_scroll_actor_scroll_to_rect()</code></a> to define a point or a rectangle
+acting as the origin, respectively.</p>
+<p><a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> does not provide pointer or keyboard event handling,
+nor does it provide visible scroll handles.</p>
+<p>See <a class="ulink" href="https://git.gnome.org/browse/clutter/tree/examples/scroll-actor.c?h=clutter-1.18" target="_top">scroll-actor.c</a>
+for an example of how to use <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a>.</p>
+<p><a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> is available since Clutter 1.12.</p>
+</div>
+<div class="refsect1">
+<a name="ClutterScrollActor.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="clutter-scroll-actor-new"></a><h3>clutter_scroll_actor_new ()</h3>
+<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
+clutter_scroll_actor_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>Creates a new <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a>.</p>
+<div class="refsect3">
+<a name="id-1.5.3.5.9.2.5"></a><h4>Returns</h4>
+<p> The newly created <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a>
+instance.</p>
+<p></p>
+</div>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-scroll-actor-set-scroll-mode"></a><h3>clutter_scroll_actor_set_scroll_mode ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_scroll_actor_set_scroll_mode (<em class="parameter"><code><a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> *actor</code></em>,
+                                      <em class="parameter"><code><a class="link" href="ClutterScrollActor.html#ClutterScrollMode" title="enum ClutterScrollMode"><span class="type">ClutterScrollMode</span></a> mode</code></em>);</pre>
+<p>Sets the <a class="link" href="ClutterScrollActor.html#ClutterScrollActor--scroll-mode" title="The “scroll-mode” property"><span class="type">“scroll-mode”</span></a> property.</p>
+<div class="refsect3">
+<a name="id-1.5.3.5.9.3.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>actor</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>mode</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterScrollActor.html#ClutterScrollMode" title="enum ClutterScrollMode"><span class="type">ClutterScrollMode</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-scroll-actor-get-scroll-mode"></a><h3>clutter_scroll_actor_get_scroll_mode ()</h3>
+<pre class="programlisting"><a class="link" href="ClutterScrollActor.html#ClutterScrollMode" title="enum ClutterScrollMode"><span class="returnvalue">ClutterScrollMode</span></a>
+clutter_scroll_actor_get_scroll_mode (<em class="parameter"><code><a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> *actor</code></em>);</pre>
+<p>Retrieves the <a class="link" href="ClutterScrollActor.html#ClutterScrollActor--scroll-mode" title="The “scroll-mode” property"><span class="type">“scroll-mode”</span></a> property</p>
+<div class="refsect3">
+<a name="id-1.5.3.5.9.4.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>actor</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.5.3.5.9.4.6"></a><h4>Returns</h4>
+<p> the scrolling mode</p>
+<p></p>
+</div>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-scroll-actor-scroll-to-point"></a><h3>clutter_scroll_actor_scroll_to_point ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_scroll_actor_scroll_to_point (<em class="parameter"><code><a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> *actor</code></em>,
+                                      <em class="parameter"><code>const <a class="link" href="clutter-Base-geometric-types.html#ClutterPoint" title="struct ClutterPoint"><span class="type">ClutterPoint</span></a> *point</code></em>);</pre>
+<p>Scrolls the contents of <em class="parameter"><code>actor</code></em>
+ so that <em class="parameter"><code>point</code></em>
+ is the new origin
+of the visible area.</p>
+<p>The coordinates of <em class="parameter"><code>point</code></em>
+ must be relative to the <em class="parameter"><code>actor</code></em>
+.</p>
+<p>This function will use the currently set easing state of the <em class="parameter"><code>actor</code></em>
+to transition from the current scroll origin to the new one.</p>
+<div class="refsect3">
+<a name="id-1.5.3.5.9.5.7"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>actor</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>point</p></td>
+<td class="parameter_description"><p>a <a class="link" href="clutter-Base-geometric-types.html#ClutterPoint" title="struct ClutterPoint"><span class="type">ClutterPoint</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-scroll-actor-scroll-to-rect"></a><h3>clutter_scroll_actor_scroll_to_rect ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_scroll_actor_scroll_to_rect (<em class="parameter"><code><a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> *actor</code></em>,
+                                     <em class="parameter"><code>const <a class="link" href="clutter-Base-geometric-types.html#ClutterRect" title="struct ClutterRect"><span class="type">ClutterRect</span></a> *rect</code></em>);</pre>
+<p>Scrolls <em class="parameter"><code>actor</code></em>
+ so that <em class="parameter"><code>rect</code></em>
+ is in the visible portion.</p>
+<div class="refsect3">
+<a name="id-1.5.3.5.9.6.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>actor</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>rect</p></td>
+<td class="parameter_description"><p>a <a class="link" href="clutter-Base-geometric-types.html#ClutterRect" title="struct ClutterRect"><span class="type">ClutterRect</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 1.12</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="ClutterScrollActor.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="ClutterScrollActor-struct"></a><h3>ClutterScrollActor</h3>
+<pre class="programlisting">typedef struct _ClutterScrollActor ClutterScrollActor;</pre>
+<p>The <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> structure contains only
+private data, and should be accessed using the provided API.</p>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterScrollActorClass"></a><h3>struct ClutterScrollActorClass</h3>
+<pre class="programlisting">struct ClutterScrollActorClass {
+};
+</pre>
+<p>The <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> structure contains only
+private data.</p>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterScrollMode"></a><h3>enum ClutterScrollMode</h3>
+<p>Scroll modes.</p>
+<div class="refsect3">
+<a name="id-1.5.3.5.10.4.4"></a><h4>Members</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="300px" class="enum_members_name">
+<col class="enum_members_description">
+<col width="200px" class="enum_members_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="enum_member_name"><p><a name="CLUTTER-SCROLL-NONE:CAPS"></a>CLUTTER_SCROLL_NONE</p></td>
+<td class="enum_member_description">
+<p>Ignore scrolling</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="CLUTTER-SCROLL-HORIZONTALLY:CAPS"></a>CLUTTER_SCROLL_HORIZONTALLY</p></td>
+<td class="enum_member_description">
+<p>Scroll only horizontally</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="CLUTTER-SCROLL-VERTICALLY:CAPS"></a>CLUTTER_SCROLL_VERTICALLY</p></td>
+<td class="enum_member_description">
+<p>Scroll only vertically</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="CLUTTER-SCROLL-BOTH:CAPS"></a>CLUTTER_SCROLL_BOTH</p></td>
+<td class="enum_member_description">
+<p>Scroll in both directions</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 1.12</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="ClutterScrollActor.property-details"></a><h2>Property Details</h2>
+<div class="refsect2">
+<a name="ClutterScrollActor--scroll-mode"></a><h3>The <code class="literal">“scroll-mode”</code> property</h3>
+<pre class="programlisting">  “scroll-mode”              <a class="link" href="ClutterScrollActor.html#ClutterScrollMode" title="enum ClutterScrollMode"><span class="type">ClutterScrollMode</span></a></pre>
+<p>The scrollin direction.</p>
+<p>Flags: Read / Write</p>
+<p>Default value: CLUTTER_SCROLL_HORIZONTALLY | CLUTTER_SCROLL_VERTICALLY</p>
+<p class="since">Since 1.12</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.20.1</div>
+</body>
+</html>