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

clutter 2.0.0-x86-mingw32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (656) hide show

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

@@ -0,0 +1,785 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>ClutterPanAction</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="ch04.html" title="Actions">
+<link rel="prev" href="ClutterGestureAction.html" title="ClutterGestureAction">
+<link rel="next" href="ClutterSwipeAction.html" title="ClutterSwipeAction">
+<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="ClutterGestureAction.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
+<td><a accesskey="u" href="ch04.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="ClutterSwipeAction.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
+</tr>
+<tr><td colspan="5" class="shortcuts">
+<a href="#ClutterPanAction.synopsis" class="shortcut">Top</a>
+                   |
+                  <a href="#ClutterPanAction.description" class="shortcut">Description</a>
+                   |
+                  <a href="#ClutterPanAction.object-hierarchy" class="shortcut">Object Hierarchy</a>
+                   |
+                  <a href="#ClutterPanAction.properties" class="shortcut">Properties</a>
+                   |
+                  <a href="#ClutterPanAction.signals" class="shortcut">Signals</a>
+</td></tr>
+</table>
+<div class="refentry">
+<a name="ClutterPanAction"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="ClutterPanAction.top_of_page"></a>ClutterPanAction</span></h2>
+<p>ClutterPanAction — Action for pan gestures</p>
+</td>
+<td valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsynopsisdiv">
+<a name="ClutterPanAction.synopsis"></a><h2>Synopsis</h2>
+<pre class="synopsis">struct              <a class="link" href="ClutterPanAction.html#ClutterPanAction-struct" title="struct ClutterPanAction">ClutterPanAction</a>;
+struct              <a class="link" href="ClutterPanAction.html#ClutterPanActionClass" title="struct ClutterPanActionClass">ClutterPanActionClass</a>;
+<a class="link" href="ClutterAction.html" title="ClutterAction"><span class="returnvalue">ClutterAction</span></a> *     <a class="link" href="ClutterPanAction.html#clutter-pan-action-new" title="clutter_pan_action_new ()">clutter_pan_action_new</a>              (<em class="parameter"><code><span class="type">void</span></code></em>);
+enum                <a class="link" href="ClutterPanAction.html#ClutterPanAxis" title="enum ClutterPanAxis">ClutterPanAxis</a>;
+<span class="returnvalue">void</span>                <a class="link" href="ClutterPanAction.html#clutter-pan-action-set-pan-axis" title="clutter_pan_action_set_pan_axis ()">clutter_pan_action_set_pan_axis</a>     (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>,
+                                                         <em class="parameter"><code><a class="link" href="ClutterPanAction.html#ClutterPanAxis" title="enum ClutterPanAxis"><span class="type">ClutterPanAxis</span></a> axis</code></em>);
+<a class="link" href="ClutterPanAction.html#ClutterPanAxis" title="enum ClutterPanAxis"><span class="returnvalue">ClutterPanAxis</span></a>      <a class="link" href="ClutterPanAction.html#clutter-pan-action-get-pan-axis" title="clutter_pan_action_get_pan_axis ()">clutter_pan_action_get_pan_axis</a>     (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>);
+<span class="returnvalue">void</span>                <a class="link" href="ClutterPanAction.html#clutter-pan-action-set-interpolate" title="clutter_pan_action_set_interpolate ()">clutter_pan_action_set_interpolate</a>  (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>,
+                                                         <em class="parameter"><code><span class="type">gboolean</span> should_interpolate</code></em>);
+<span class="returnvalue">gboolean</span>            <a class="link" href="ClutterPanAction.html#clutter-pan-action-get-interpolate" title="clutter_pan_action_get_interpolate ()">clutter_pan_action_get_interpolate</a>  (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>);
+<span class="returnvalue">void</span>                <a class="link" href="ClutterPanAction.html#clutter-pan-action-set-deceleration" title="clutter_pan_action_set_deceleration ()">clutter_pan_action_set_deceleration</a> (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> rate</code></em>);
+<span class="returnvalue">gdouble</span>             <a class="link" href="ClutterPanAction.html#clutter-pan-action-get-deceleration" title="clutter_pan_action_get_deceleration ()">clutter_pan_action_get_deceleration</a> (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>);
+<span class="returnvalue">void</span>                <a class="link" href="ClutterPanAction.html#clutter-pan-action-set-acceleration-factor" title="clutter_pan_action_set_acceleration_factor ()">clutter_pan_action_set_acceleration_factor</a>
+                                                        (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> factor</code></em>);
+<span class="returnvalue">gdouble</span>             <a class="link" href="ClutterPanAction.html#clutter-pan-action-get-acceleration-factor" title="clutter_pan_action_get_acceleration_factor ()">clutter_pan_action_get_acceleration_factor</a>
+                                                        (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>);
+<span class="returnvalue">void</span>                <a class="link" href="ClutterPanAction.html#clutter-pan-action-get-interpolated-coords" title="clutter_pan_action_get_interpolated_coords ()">clutter_pan_action_get_interpolated_coords</a>
+                                                        (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *interpolated_x</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *interpolated_y</code></em>);
+<span class="returnvalue">gfloat</span>              <a class="link" href="ClutterPanAction.html#clutter-pan-action-get-interpolated-delta" title="clutter_pan_action_get_interpolated_delta ()">clutter_pan_action_get_interpolated_delta</a>
+                                                        (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *delta_x</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *delta_y</code></em>);
+<span class="returnvalue">void</span>                <a class="link" href="ClutterPanAction.html#clutter-pan-action-get-motion-coords" title="clutter_pan_action_get_motion_coords ()">clutter_pan_action_get_motion_coords</a>
+                                                        (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>,
+                                                         <em class="parameter"><code><span class="type">guint</span> point</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *motion_x</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *motion_y</code></em>);
+<span class="returnvalue">gfloat</span>              <a class="link" href="ClutterPanAction.html#clutter-pan-action-get-motion-delta" title="clutter_pan_action_get_motion_delta ()">clutter_pan_action_get_motion_delta</a> (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>,
+                                                         <em class="parameter"><code><span class="type">guint</span> point</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *delta_x</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *delta_y</code></em>);
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterPanAction.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="ClutterAction.html" title="ClutterAction">ClutterAction</a>
+                     +----<a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction">ClutterGestureAction</a>
+                           +----ClutterPanAction
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterPanAction.properties"></a><h2>Properties</h2>
+<pre class="synopsis">
+  "<a class="link" href="ClutterPanAction.html#ClutterPanAction--acceleration-factor" title='The "acceleration-factor" property'>acceleration-factor</a>"      <span class="type">gdouble</span>               : Read / Write
+  "<a class="link" href="ClutterPanAction.html#ClutterPanAction--deceleration" title='The "deceleration" property'>deceleration</a>"             <span class="type">gdouble</span>               : Read / Write
+  "<a class="link" href="ClutterPanAction.html#ClutterPanAction--interpolate" title='The "interpolate" property'>interpolate</a>"              <span class="type">gboolean</span>              : Read / Write
+  "<a class="link" href="ClutterPanAction.html#ClutterPanAction--pan-axis" title='The "pan-axis" property'>pan-axis</a>"                 <a class="link" href="ClutterPanAction.html#ClutterPanAxis" title="enum ClutterPanAxis"><span class="type">ClutterPanAxis</span></a>        : Read / Write
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterPanAction.signals"></a><h2>Signals</h2>
+<pre class="synopsis">
+  "<a class="link" href="ClutterPanAction.html#ClutterPanAction-pan" title='The "pan" signal'>pan</a>"                                            : <code class="literal">Run Last</code>
+  "<a class="link" href="ClutterPanAction.html#ClutterPanAction-pan-stopped" title='The "pan-stopped" signal'>pan-stopped</a>"                                    : <code class="literal">Run Last</code>
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterPanAction.description"></a><h2>Description</h2>
+<p>
+<a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> is a sub-class of <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> that implements
+the logic for recognizing pan gestures.
+</p>
+<p>
+The simplest usage of <a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> consists in adding it to
+a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> with a child and setting it as reactive; for instance,
+the following code:
+</p>
+<p>
+</p>
+<div class="informalexample">
+  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
+    <tbody>
+      <tr>
+        <td class="listing_lines" align="right"><pre>1
+2</pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="function"><a href="ClutterActor.html#clutter-actor-add-action">clutter_actor_add_action</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">actor</span><span class="symbol">,</span><span class="normal"> </span><span class="function"><a href="ClutterPanAction.html#clutter-pan-action-new">clutter_pan_action_new</a></span><span class="normal"> </span><span class="symbol">());</span>
+<span class="function"><a href="ClutterActor.html#clutter-actor-set-reactive">clutter_actor_set_reactive</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">actor</span><span class="symbol">,</span><span class="normal"> TRUE</span><span class="symbol">);</span></pre></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+<p>
+</p>
+<p>
+will automatically result in the actor children to be moved
+when dragging.
+</p>
+</div>
+<div class="refsect1">
+<a name="ClutterPanAction.details"></a><h2>Details</h2>
+<div class="refsect2">
+<a name="ClutterPanAction-struct"></a><h3>struct ClutterPanAction</h3>
+<pre class="programlisting">struct ClutterPanAction;</pre>
+<p>
+The <span class="structname">ClutterPanAction</span> 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="ClutterPanActionClass"></a><h3>struct ClutterPanActionClass</h3>
+<pre class="programlisting">struct ClutterPanActionClass {
+  gboolean (* pan)               (ClutterPanAction    *action,
+                                  ClutterActor        *actor,
+                                  gboolean             is_interpolated);
+  void     (* pan_stopped)       (ClutterPanAction    *action,
+                                  ClutterActor        *actor);
+};
+</pre>
+<p>
+The <span class="structname">ClutterPanActionClass</span> structure contains
+only private data.
+</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="structfield"><code><a name="ClutterPanActionClass.pan"></a>pan</code></em> ()</span></p></td>
+<td>class handler for the <a class="link" href="ClutterPanAction.html#ClutterPanAction-pan" title='The "pan" signal'><span class="type">"pan"</span></a> signal</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="structfield"><code><a name="ClutterPanActionClass.pan-stopped"></a>pan_stopped</code></em> ()</span></p></td>
+<td>class handler for the <a class="link" href="ClutterPanAction.html#ClutterPanAction-pan-stopped" title='The "pan-stopped" signal'><span class="type">"pan-stopped"</span></a> signal</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-pan-action-new"></a><h3>clutter_pan_action_new ()</h3>
+<pre class="programlisting"><a class="link" href="ClutterAction.html" title="ClutterAction"><span class="returnvalue">ClutterAction</span></a> *     clutter_pan_action_new              (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>
+Creates a new <a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> 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"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>the newly created <a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a>
+</td>
+</tr></tbody>
+</table></div>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterPanAxis"></a><h3>enum ClutterPanAxis</h3>
+<pre class="programlisting">typedef enum {
+ /*&lt; prefix=CLUTTER_PAN &gt;*/
+  CLUTTER_PAN_AXIS_NONE = 0,
+  CLUTTER_PAN_X_AXIS,
+  CLUTTER_PAN_Y_AXIS
+} ClutterPanAxis;
+</pre>
+<p>
+The axis of the constraint that should be applied on the
+panning action
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><a name="CLUTTER-PAN-AXIS-NONE:CAPS"></a><span class="term"><code class="literal">CLUTTER_PAN_AXIS_NONE</code></span></p></td>
+<td>No constraint
+</td>
+</tr>
+<tr>
+<td><p><a name="CLUTTER-PAN-X-AXIS:CAPS"></a><span class="term"><code class="literal">CLUTTER_PAN_X_AXIS</code></span></p></td>
+<td>Set a constraint on the X axis
+</td>
+</tr>
+<tr>
+<td><p><a name="CLUTTER-PAN-Y-AXIS:CAPS"></a><span class="term"><code class="literal">CLUTTER_PAN_Y_AXIS</code></span></p></td>
+<td>Set a constraint on the Y axis
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-pan-action-set-pan-axis"></a><h3>clutter_pan_action_set_pan_axis ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                clutter_pan_action_set_pan_axis     (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>,
+                                                         <em class="parameter"><code><a class="link" href="ClutterPanAction.html#ClutterPanAxis" title="enum ClutterPanAxis"><span class="type">ClutterPanAxis</span></a> axis</code></em>);</pre>
+<p>
+Restricts the panning action to a specific axis
+</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="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>axis</code></em> :</span></p></td>
+<td>the axis to constraint the panning to</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-pan-action-get-pan-axis"></a><h3>clutter_pan_action_get_pan_axis ()</h3>
+<pre class="programlisting"><a class="link" href="ClutterPanAction.html#ClutterPanAxis" title="enum ClutterPanAxis"><span class="returnvalue">ClutterPanAxis</span></a>      clutter_pan_action_get_pan_axis     (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>);</pre>
+<p>
+Retrieves the axis constraint set by <a class="link" href="ClutterPanAction.html#clutter-pan-action-set-pan-axis" title="clutter_pan_action_set_pan_axis ()"><code class="function">clutter_pan_action_set_pan_axis()</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>self</code></em> :</span></p></td>
+<td>a <a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>the axis constraint</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-pan-action-set-interpolate"></a><h3>clutter_pan_action_set_interpolate ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                clutter_pan_action_set_interpolate  (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>,
+                                                         <em class="parameter"><code><span class="type">gboolean</span> should_interpolate</code></em>);</pre>
+<p>
+Sets whether the action should emit interpolated ::pan events
+after the drag has ended, to emulate the gesture kinetic inertia.
+</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="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>should_interpolate</code></em> :</span></p></td>
+<td>whether to enable interpolated pan events</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-pan-action-get-interpolate"></a><h3>clutter_pan_action_get_interpolate ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_pan_action_get_interpolate  (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>);</pre>
+<p>
+Checks if the action should emit ::pan events even after releasing
+the pointer during a panning gesture, to emulate some kind of
+kinetic inertia.
+</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="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>
+<code class="literal">TRUE</code> if interpolated events emission is active.</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-pan-action-set-deceleration"></a><h3>clutter_pan_action_set_deceleration ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                clutter_pan_action_set_deceleration (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> rate</code></em>);</pre>
+<p>
+Sets the deceleration rate of the interpolated ::pan events generated
+after a pan gesture. This is approximately the value that the momentum
+at the time of releasing the pointer is divided by every 60th of a second.
+</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="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>rate</code></em> :</span></p></td>
+<td>The deceleration rate</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-pan-action-get-deceleration"></a><h3>clutter_pan_action_get_deceleration ()</h3>
+<pre class="programlisting"><span class="returnvalue">gdouble</span>             clutter_pan_action_get_deceleration (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>);</pre>
+<p>
+Retrieves the deceleration rate of interpolated ::pan events.
+</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="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>The deceleration rate of the interpolated events.</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-pan-action-set-acceleration-factor"></a><h3>clutter_pan_action_set_acceleration_factor ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                clutter_pan_action_set_acceleration_factor
+                                                        (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> factor</code></em>);</pre>
+<p>
+Factor applied to the momentum velocity at the time of releasing the
+pointer when generating interpolated ::pan events.
+</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="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>factor</code></em> :</span></p></td>
+<td>The acceleration factor</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-pan-action-get-acceleration-factor"></a><h3>clutter_pan_action_get_acceleration_factor ()</h3>
+<pre class="programlisting"><span class="returnvalue">gdouble</span>             clutter_pan_action_get_acceleration_factor
+                                                        (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>);</pre>
+<p>
+Retrieves the initial acceleration factor for interpolated ::pan events.
+</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="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>The initial acceleration factor for interpolated events.</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-pan-action-get-interpolated-coords"></a><h3>clutter_pan_action_get_interpolated_coords ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                clutter_pan_action_get_interpolated_coords
+                                                        (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *interpolated_x</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *interpolated_y</code></em>);</pre>
+<p>
+Retrieves the coordinates, in stage space, of the latest interpolated
+event, analogous to <a class="link" href="ClutterGestureAction.html#clutter-gesture-action-get-motion-coords" title="clutter_gesture_action_get_motion_coords ()"><code class="function">clutter_gesture_action_get_motion_coords()</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>self</code></em> :</span></p></td>
+<td>A <a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>interpolated_x</code></em> :</span></p></td>
+<td>return location for the latest
+interpolated event's X coordinate. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>interpolated_y</code></em> :</span></p></td>
+<td>return location for the latest
+interpolated event's Y coordinate. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<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.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-pan-action-get-interpolated-delta"></a><h3>clutter_pan_action_get_interpolated_delta ()</h3>
+<pre class="programlisting"><span class="returnvalue">gfloat</span>              clutter_pan_action_get_interpolated_delta
+                                                        (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *delta_x</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *delta_y</code></em>);</pre>
+<p>
+Retrieves the delta, in stage space, since the latest interpolated
+event, analogous to <a class="link" href="ClutterGestureAction.html#clutter-gesture-action-get-motion-delta" title="clutter_gesture_action_get_motion_delta ()"><code class="function">clutter_gesture_action_get_motion_delta()</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>self</code></em> :</span></p></td>
+<td>A <a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>delta_x</code></em> :</span></p></td>
+<td>return location for the X delta since
+the latest interpolated event. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>delta_y</code></em> :</span></p></td>
+<td>return location for the Y delta since
+the latest interpolated event. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>the distance since the latest interpolated event</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-pan-action-get-motion-coords"></a><h3>clutter_pan_action_get_motion_coords ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                clutter_pan_action_get_motion_coords
+                                                        (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>,
+                                                         <em class="parameter"><code><span class="type">guint</span> point</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *motion_x</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *motion_y</code></em>);</pre>
+<p>
+Retrieves the coordinates, in stage space, dependent on the current state
+of the <a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a>. If it is inactive, both fields will be
+set to 0. If it is panning by user action, the values will be equivalent
+to those returned by <a class="link" href="ClutterGestureAction.html#clutter-gesture-action-get-motion-coords" title="clutter_gesture_action_get_motion_coords ()"><code class="function">clutter_gesture_action_get_motion_coords()</code></a>.
+If it is interpolating with some form of kinetic scrolling, the values
+will be equivalent to those returned by
+<a class="link" href="ClutterPanAction.html#clutter-pan-action-get-interpolated-coords" title="clutter_pan_action_get_interpolated_coords ()"><code class="function">clutter_pan_action_get_interpolated_coords()</code></a>. This is a convenience
+method designed to be used in replacement "pan" signal handlers.
+</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="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>point</code></em> :</span></p></td>
+<td>the touch point index, with 0 being the first touch
+point received by the action</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>motion_x</code></em> :</span></p></td>
+<td>return location for the X coordinate. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>motion_y</code></em> :</span></p></td>
+<td>return location for the Y coordinate. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<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.14</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-pan-action-get-motion-delta"></a><h3>clutter_pan_action_get_motion_delta ()</h3>
+<pre class="programlisting"><span class="returnvalue">gfloat</span>              clutter_pan_action_get_motion_delta (<em class="parameter"><code><a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *self</code></em>,
+                                                         <em class="parameter"><code><span class="type">guint</span> point</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *delta_x</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *delta_y</code></em>);</pre>
+<p>
+Retrieves the delta, in stage space, dependent on the current state
+of the <a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a>. If it is inactive, both fields will be
+set to 0. If it is panning by user action, the values will be equivalent
+to those returned by <a class="link" href="ClutterGestureAction.html#clutter-gesture-action-get-motion-delta" title="clutter_gesture_action_get_motion_delta ()"><code class="function">clutter_gesture_action_get_motion_delta()</code></a>.
+If it is interpolating with some form of kinetic scrolling, the values
+will be equivalent to those returned by
+<a class="link" href="ClutterPanAction.html#clutter-pan-action-get-interpolated-delta" title="clutter_pan_action_get_interpolated_delta ()"><code class="function">clutter_pan_action_get_interpolated_delta()</code></a>. This is a convenience
+method designed to be used in replacement "pan" signal handlers.
+</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="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>point</code></em> :</span></p></td>
+<td>the touch point index, with 0 being the first touch
+point received by the action</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>delta_x</code></em> :</span></p></td>
+<td>return location for the X delta. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>delta_y</code></em> :</span></p></td>
+<td>return location for the Y delta. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<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.14</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="ClutterPanAction.property-details"></a><h2>Property Details</h2>
+<div class="refsect2">
+<a name="ClutterPanAction--acceleration-factor"></a><h3>The <code class="literal">"acceleration-factor"</code> property</h3>
+<pre class="programlisting">  "acceleration-factor"      <span class="type">gdouble</span>               : Read / Write</pre>
+<p>
+The initial acceleration factor
+</p>
+<p>
+The kinetic momentum measured at the time of releasing the pointer will
+be multiplied by the factor specified by this property before being used
+to generate interpolated ::pan events.
+</p>
+<p>Allowed values: &gt;= 1</p>
+<p>Default value: 1</p>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterPanAction--deceleration"></a><h3>The <code class="literal">"deceleration"</code> property</h3>
+<pre class="programlisting">  "deceleration"             <span class="type">gdouble</span>               : Read / Write</pre>
+<p>
+The rate at which the interpolated panning will decelerate in
+</p>
+<p>
+<a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> will emit interpolated ::pan events with decreasing
+scroll deltas, using the rate specified by this property.
+</p>
+<p>Allowed values: [1e-15,1]</p>
+<p>Default value: 0.95</p>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterPanAction--interpolate"></a><h3>The <code class="literal">"interpolate"</code> property</h3>
+<pre class="programlisting">  "interpolate"              <span class="type">gboolean</span>              : Read / Write</pre>
+<p>
+Whether interpolated events emission is enabled.
+</p>
+<p>Default value: FALSE</p>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterPanAction--pan-axis"></a><h3>The <code class="literal">"pan-axis"</code> property</h3>
+<pre class="programlisting">  "pan-axis"                 <a class="link" href="ClutterPanAction.html#ClutterPanAxis" title="enum ClutterPanAxis"><span class="type">ClutterPanAxis</span></a>        : Read / Write</pre>
+<p>
+Constraints the panning action to the specified axis
+</p>
+<p>Default value: CLUTTER_PAN_AXIS_NONE</p>
+<p class="since">Since 1.12</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="ClutterPanAction.signal-details"></a><h2>Signal Details</h2>
+<div class="refsect2">
+<a name="ClutterPanAction-pan"></a><h3>The <code class="literal">"pan"</code> signal</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>            user_function                      (<a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *action,
+                                                        <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>     *actor,
+                                                        <span class="type">gboolean</span>          is_interpolated,
+                                                        <span class="type">gpointer</span>          user_data)            : <code class="literal">Run Last</code></pre>
+<p>
+The ::pan signal is emitted to keep track of the motion during
+a pan gesture. <em class="parameter"><code>is_interpolated</code></em> is set to <code class="literal">TRUE</code> during the
+interpolation phase of the pan, after the drag has ended and
+the :interpolate property was set to <code class="literal">TRUE</code>.
+</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>action</code></em> :</span></p></td>
+<td>the <a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> that emitted the signal</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
+<td>the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> attached to the <em class="parameter"><code>action</code></em>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>is_interpolated</code></em> :</span></p></td>
+<td>if the event is the result of interpolating
+the motion velocity at the end of the drag</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
+<td>user data set when the signal handler was connected.</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>
+<code class="literal">TRUE</code> if the pan should continue, and <code class="literal">FALSE</code> if
+the pan should be cancelled.</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterPanAction-pan-stopped"></a><h3>The <code class="literal">"pan-stopped"</code> signal</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> *action,
+                                                        <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>     *actor,
+                                                        <span class="type">gpointer</span>          user_data)      : <code class="literal">Run Last</code></pre>
+<p>
+The ::pan-stopped signal is emitted at the end of the interpolation
+phase of the pan action, only when :interpolate is set to <code class="literal">TRUE</code>.
+</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>action</code></em> :</span></p></td>
+<td>the <a class="link" href="ClutterPanAction.html" title="ClutterPanAction"><span class="type">ClutterPanAction</span></a> that emitted the signal</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
+<td>the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> attached to the <em class="parameter"><code>action</code></em>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
+<td>user data set when the signal handler was connected.</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.12</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.18.1</div>
+</body>
+</html>