<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>ClutterGestureAction: Clutter Reference Manual</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="ch04.html" title="Actions"> <link rel="prev" href="ClutterDropAction.html" title="ClutterDropAction"> <link rel="next" href="ClutterPanAction.html" title="ClutterPanAction"> <meta name="generator" content="GTK-Doc V1.24 (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="#ClutterGestureAction.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> <a href="#ClutterGestureAction.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> <a href="#ClutterGestureAction.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> <a href="#ClutterGestureAction.signals" class="shortcut">Signals</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="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> <td><a accesskey="p" href="ClutterDropAction.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> <td><a accesskey="n" href="ClutterPanAction.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="refentry"> <a name="ClutterGestureAction"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> <h2><span class="refentrytitle"><a name="ClutterGestureAction.top_of_page"></a>ClutterGestureAction</span></h2> <p>ClutterGestureAction — Action for gesture gestures</p> </td> <td class="gallery_image" valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> <a name="ClutterGestureAction.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="ClutterAction.html" title="ClutterAction"><span class="returnvalue">ClutterAction</span></a> * </td> <td class="function_name"> <a class="link" href="ClutterGestureAction.html#clutter-gesture-action-new" title="clutter_gesture_action_new ()">clutter_gesture_action_new</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type">const <a class="link" href="clutter-Events.html#ClutterEvent"><span class="returnvalue">ClutterEvent</span></a> * </td> <td class="function_name"> <a class="link" href="ClutterGestureAction.html#clutter-gesture-action-get-last-event" title="clutter_gesture_action_get_last_event ()">clutter_gesture_action_get_last_event</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="ClutterGestureAction.html#clutter-gesture-action-get-press-coords" title="clutter_gesture_action_get_press_coords ()">clutter_gesture_action_get_press_coords</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="ClutterGestureAction.html#clutter-gesture-action-get-motion-coords" title="clutter_gesture_action_get_motion_coords ()">clutter_gesture_action_get_motion_coords</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">gfloat</span> </td> <td class="function_name"> <a class="link" href="ClutterGestureAction.html#clutter-gesture-action-get-motion-delta" title="clutter_gesture_action_get_motion_delta ()">clutter_gesture_action_get_motion_delta</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="ClutterGestureAction.html#clutter-gesture-action-get-release-coords" title="clutter_gesture_action_get_release_coords ()">clutter_gesture_action_get_release_coords</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">gfloat</span> </td> <td class="function_name"> <a class="link" href="ClutterGestureAction.html#clutter-gesture-action-get-velocity" title="clutter_gesture_action_get_velocity ()">clutter_gesture_action_get_velocity</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">gint</span> </td> <td class="function_name"> <a class="link" href="ClutterGestureAction.html#clutter-gesture-action-get-n-touch-points" title="clutter_gesture_action_get_n_touch_points ()">clutter_gesture_action_get_n_touch_points</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="ClutterGestureAction.html#clutter-gesture-action-set-n-touch-points" title="clutter_gesture_action_set_n_touch_points ()">clutter_gesture_action_set_n_touch_points</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">guint</span> </td> <td class="function_name"> <a class="link" href="ClutterGestureAction.html#clutter-gesture-action-get-n-current-points" title="clutter_gesture_action_get_n_current_points ()">clutter_gesture_action_get_n_current_points</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <a class="link" href="clutter-Events.html#ClutterEventSequence"><span class="returnvalue">ClutterEventSequence</span></a> * </td> <td class="function_name"> <a class="link" href="ClutterGestureAction.html#clutter-gesture-action-get-sequence" title="clutter_gesture_action_get_sequence ()">clutter_gesture_action_get_sequence</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="returnvalue">ClutterInputDevice</span></a> * </td> <td class="function_name"> <a class="link" href="ClutterGestureAction.html#clutter-gesture-action-get-device" title="clutter_gesture_action_get_device ()">clutter_gesture_action_get_device</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="ClutterGestureAction.html#clutter-gesture-action-get-threshold-trigger-distance" title="clutter_gesture_action_get_threshold_trigger_distance ()">clutter_gesture_action_get_threshold_trigger_distance</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="ClutterGestureAction.html#clutter-gesture-action-set-threshold-trigger-distance" title="clutter_gesture_action_set_threshold_trigger_distance ()">clutter_gesture_action_set_threshold_trigger_distance</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="ClutterGestureAction.html#clutter-gesture-action-set-threshold-trigger-edge" title="clutter_gesture_action_set_threshold_trigger_edge ()">clutter_gesture_action_set_threshold_trigger_edge</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <a class="link" href="ClutterGestureAction.html#ClutterGestureTriggerEdge" title="enum ClutterGestureTriggerEdge"><span class="returnvalue">ClutterGestureTriggerEdge</span></a> </td> <td class="function_name"> <a class="link" href="ClutterGestureAction.html#clutter-gesture-action-get-threshold-trigger-edge" title="clutter_gesture_action_get_threshold_trigger_edge ()">clutter_gesture_action_get_threshold_trigger_edge</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="ClutterGestureAction.html#clutter-gesture-action-cancel" title="clutter_gesture_action_cancel ()">clutter_gesture_action_cancel</a> <span class="c_punctuation">()</span> </td> </tr> </tbody> </table></div> </div> <div class="refsect1"> <a name="ClutterGestureAction.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"><span class="type">gint</span></td> <td class="property_name"><a class="link" href="ClutterGestureAction.html#ClutterGestureAction--n-touch-points" title="The “n-touch-points” property">n-touch-points</a></td> <td class="property_flags">Read / Write</td> </tr> <tr> <td class="property_type"><span class="type">gfloat</span></td> <td class="property_name"><a class="link" href="ClutterGestureAction.html#ClutterGestureAction--threshold-trigger-distance-x" title="The “threshold-trigger-distance-x” property">threshold-trigger-distance-x</a></td> <td class="property_flags">Read / Write / Construct Only</td> </tr> <tr> <td class="property_type"><span class="type">gfloat</span></td> <td class="property_name"><a class="link" href="ClutterGestureAction.html#ClutterGestureAction--threshold-trigger-distance-y" title="The “threshold-trigger-distance-y” property">threshold-trigger-distance-y</a></td> <td class="property_flags">Read / Write / Construct Only</td> </tr> <tr> <td class="property_type"><a class="link" href="ClutterGestureAction.html#ClutterGestureTriggerEdge" title="enum ClutterGestureTriggerEdge"><span class="type">ClutterGestureTriggerEdge</span></a></td> <td class="property_name"><a class="link" href="ClutterGestureAction.html#ClutterGestureAction--threshold-trigger-edge" title="The “threshold-trigger-edge” property">threshold-trigger-edge</a></td> <td class="property_flags">Read / Write / Construct Only</td> </tr> </tbody> </table></div> </div> <div class="refsect1"> <a name="ClutterGestureAction.signals"></a><h2>Signals</h2> <div class="informaltable"><table border="0"> <colgroup> <col width="150px" class="signals_return"> <col width="300px" class="signals_name"> <col width="200px" class="signals_flags"> </colgroup> <tbody> <tr> <td class="signal_type"><span class="returnvalue">gboolean</span></td> <td class="signal_name"><a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-begin" title="The “gesture-begin” signal">gesture-begin</a></td> <td class="signal_flags">Run Last</td> </tr> <tr> <td class="signal_type"><span class="returnvalue">void</span></td> <td class="signal_name"><a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-cancel" title="The “gesture-cancel” signal">gesture-cancel</a></td> <td class="signal_flags">Run Last</td> </tr> <tr> <td class="signal_type"><span class="returnvalue">void</span></td> <td class="signal_name"><a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-end" title="The “gesture-end” signal">gesture-end</a></td> <td class="signal_flags">Run Last</td> </tr> <tr> <td class="signal_type"><span class="returnvalue">gboolean</span></td> <td class="signal_name"><a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-progress" title="The “gesture-progress” signal">gesture-progress</a></td> <td class="signal_flags">Run Last</td> </tr> </tbody> </table></div> </div> <div class="refsect1"> <a name="ClutterGestureAction.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">struct</td> <td class="function_name"><a class="link" href="ClutterGestureAction.html#ClutterGestureAction-struct" title="struct ClutterGestureAction">ClutterGestureAction</a></td> </tr> <tr> <td class="datatype_keyword">struct</td> <td class="function_name"><a class="link" href="ClutterGestureAction.html#ClutterGestureActionClass" title="struct ClutterGestureActionClass">ClutterGestureActionClass</a></td> </tr> <tr> <td class="datatype_keyword">enum</td> <td class="function_name"><a class="link" href="ClutterGestureAction.html#ClutterGestureTriggerEdge" title="enum ClutterGestureTriggerEdge">ClutterGestureTriggerEdge</a></td> </tr> </tbody> </table></div> </div> <div class="refsect1"> <a name="ClutterGestureAction.object-hierarchy"></a><h2>Object Hierarchy</h2> <pre class="screen"> GObject <span class="lineart">╰──</span> GInitiallyUnowned <span class="lineart">╰──</span> <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta">ClutterActorMeta</a> <span class="lineart">╰──</span> <a class="link" href="ClutterAction.html" title="ClutterAction">ClutterAction</a> <span class="lineart">╰──</span> ClutterGestureAction <span class="lineart">├──</span> <a class="link" href="ClutterPanAction.html" title="ClutterPanAction">ClutterPanAction</a> <span class="lineart">├──</span> <a class="link" href="ClutterRotateAction.html" title="ClutterRotateAction">ClutterRotateAction</a> <span class="lineart">├──</span> <a class="link" href="ClutterSwipeAction.html" title="ClutterSwipeAction">ClutterSwipeAction</a> <span class="lineart">├──</span> <a class="link" href="ClutterTapAction.html" title="ClutterTapAction">ClutterTapAction</a> <span class="lineart">╰──</span> <a class="link" href="ClutterZoomAction.html" title="ClutterZoomAction">ClutterZoomAction</a> </pre> </div> <div class="refsect1"> <a name="ClutterGestureAction.description"></a><h2>Description</h2> <p><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> is a sub-class of <a class="link" href="ClutterAction.html" title="ClutterAction"><span class="type">ClutterAction</span></a> that implements the logic for recognizing gesture gestures. It listens for low level events such as <a class="link" href="clutter-Events.html#ClutterButtonEvent" title="struct ClutterButtonEvent"><span class="type">ClutterButtonEvent</span></a> and <a class="link" href="clutter-Events.html#ClutterMotionEvent" title="struct ClutterMotionEvent"><span class="type">ClutterMotionEvent</span></a> on the stage to raise the <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-begin" title="The “gesture-begin” signal"><span class="type">“gesture-begin”</span></a>, <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-progress" title="The “gesture-progress” signal"><span class="type">“gesture-progress”</span></a>, and <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-end" title="The “gesture-end” signal"><span class="type">“gesture-end”</span></a> signals.</p> <p>To use <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> you just need to apply it to a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> using <a class="link" href="ClutterActor.html#clutter-actor-add-action" title="clutter_actor_add_action ()"><code class="function">clutter_actor_add_action()</code></a> and connect to the signals:</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 3 4 5 6 7</pre></td> <td class="listing_code"><pre class="programlisting"><span class="usertype">ClutterAction</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">action </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="ClutterGestureAction.html#clutter-gesture-action-new">clutter_gesture_action_new</a></span><span class="normal"> </span><span class="symbol">();</span> <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"> action</span><span class="symbol">);</span> <span class="function">g_signal_connect</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">action</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"gesture-begin"</span><span class="symbol">,</span><span class="normal"> </span><span class="function">G_CALLBACK</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">on_gesture_begin</span><span class="symbol">),</span><span class="normal"> NULL</span><span class="symbol">);</span> <span class="function">g_signal_connect</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">action</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"gesture-progress"</span><span class="symbol">,</span><span class="normal"> </span><span class="function">G_CALLBACK</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">on_gesture_progress</span><span class="symbol">),</span><span class="normal"> NULL</span><span class="symbol">);</span> <span class="function">g_signal_connect</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">action</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"gesture-end"</span><span class="symbol">,</span><span class="normal"> </span><span class="function">G_CALLBACK</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">on_gesture_end</span><span class="symbol">),</span><span class="normal"> NULL</span><span class="symbol">);</span></pre></td> </tr> </tbody> </table> </div> <p></p> <div class="refsect3"> <a name="id-1.5.5.5.8.6"></a><h4>Creating Gesture actions</h4> <p>A <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> provides four separate states that can be used to recognize or ignore gestures when writing a new action class:</p> <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> <li class="listitem"><p>Prepare -> Cancel</p></li> <li class="listitem"><p>Prepare -> Begin -> Cancel</p></li> <li class="listitem"><p>Prepare -> Begin -> End</p></li> <li class="listitem"><p>Prepare -> Begin -> Progress -> Cancel</p></li> <li class="listitem"><p>Prepare -> Begin -> Progress -> End</p></li> </ul></div> <p>Each <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> starts in the "prepare" state, and calls the <a class="link" href="ClutterGestureAction.html#ClutterGestureActionClass.gesture-prepare"><code class="function">ClutterGestureActionClass.gesture_prepare()</code></a> virtual function; this state can be used to reset the internal state of a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> subclass, but it can also immediately cancel a gesture without going through the rest of the states.</p> <p>The "begin" state follows the "prepare" state, and calls the <a class="link" href="ClutterGestureAction.html#ClutterGestureActionClass.gesture-begin"><code class="function">ClutterGestureActionClass.gesture_begin()</code></a> virtual function. This state signals the start of a gesture recognizing process. From the "begin" state the gesture recognition process can successfully end, by going to the "end" state; it can continue in the "progress" state, in case of a continuous gesture; or it can be terminated, by moving to the "cancel" state.</p> <p>In case of continuous gestures, the <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> will use the "progress" state, calling the <a class="link" href="ClutterGestureAction.html#ClutterGestureActionClass.gesture-progress"><code class="function">ClutterGestureActionClass.gesture_progress()</code></a> virtual function; the "progress" state will continue until the end of the gesture, in which case the "end" state will be reached, or until the gesture is cancelled, in which case the "cancel" gesture will be used instead.</p> </div> </div> <div class="refsect1"> <a name="ClutterGestureAction.functions_details"></a><h2>Functions</h2> <div class="refsect2"> <a name="clutter-gesture-action-new"></a><h3>clutter_gesture_action_new ()</h3> <pre class="programlisting"><a class="link" href="ClutterAction.html" title="ClutterAction"><span class="returnvalue">ClutterAction</span></a> * clutter_gesture_action_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p>Creates a new <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> instance.</p> <div class="refsect3"> <a name="id-1.5.5.5.9.2.5"></a><h4>Returns</h4> <p> the newly created <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a></p> </div> <p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p> </div> <hr> <div class="refsect2"> <a name="clutter-gesture-action-get-last-event"></a><h3>clutter_gesture_action_get_last_event ()</h3> <pre class="programlisting">const <a class="link" href="clutter-Events.html#ClutterEvent"><span class="returnvalue">ClutterEvent</span></a> * clutter_gesture_action_get_last_event (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>, <em class="parameter"><code><span class="type">guint</span> point</code></em>);</pre> <p>Retrieves a reference to the last <a class="link" href="clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> for a touch point. Call <a class="link" href="clutter-Events.html#clutter-event-copy" title="clutter_event_copy ()"><code class="function">clutter_event_copy()</code></a> if you need to store the reference somewhere.</p> <div class="refsect3"> <a name="id-1.5.5.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>action</p></td> <td class="parameter_description"><p>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>point</p></td> <td class="parameter_description"><p>index of a point currently active</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="id-1.5.5.5.9.3.6"></a><h4>Returns</h4> <p> the last <a class="link" href="clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> for a touch point. </p> <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> </div> <p class="since">Since: <a class="link" href="ix14.html#api-index-1.14">1.14</a></p> </div> <hr> <div class="refsect2"> <a name="clutter-gesture-action-get-press-coords"></a><h3>clutter_gesture_action_get_press_coords ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> clutter_gesture_action_get_press_coords (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>, <em class="parameter"><code><span class="type">guint</span> point</code></em>, <em class="parameter"><code><span class="type">gfloat</span> *press_x</code></em>, <em class="parameter"><code><span class="type">gfloat</span> *press_y</code></em>);</pre> <p>Retrieves the coordinates, in stage space, of the press event that started the dragging for a specific touch point.</p> <div class="refsect3"> <a name="id-1.5.5.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>action</p></td> <td class="parameter_description"><p>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>point</p></td> <td class="parameter_description"><p>the touch point index, with 0 being the first touch point received by the action</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>press_x</p></td> <td class="parameter_description"><p> return location for the press event's X coordinate. </p></td> <td class="parameter_annotations"><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 class="parameter_name"><p>press_y</p></td> <td class="parameter_description"><p> return location for the press event's Y coordinate. </p></td> <td class="parameter_annotations"><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> </div> <p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p> </div> <hr> <div class="refsect2"> <a name="clutter-gesture-action-get-motion-coords"></a><h3>clutter_gesture_action_get_motion_coords ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> clutter_gesture_action_get_motion_coords (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</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, of the latest motion event during the dragging.</p> <div class="refsect3"> <a name="id-1.5.5.5.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>action</p></td> <td class="parameter_description"><p>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>point</p></td> <td class="parameter_description"><p>the touch point index, with 0 being the first touch point received by the action</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>motion_x</p></td> <td class="parameter_description"><p> return location for the latest motion event's X coordinate. </p></td> <td class="parameter_annotations"><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 class="parameter_name"><p>motion_y</p></td> <td class="parameter_description"><p> return location for the latest motion event's Y coordinate. </p></td> <td class="parameter_annotations"><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> </div> <p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p> </div> <hr> <div class="refsect2"> <a name="clutter-gesture-action-get-motion-delta"></a><h3>clutter_gesture_action_get_motion_delta ()</h3> <pre class="programlisting"><span class="returnvalue">gfloat</span> clutter_gesture_action_get_motion_delta (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</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 incremental delta since the last motion event during the dragging.</p> <div class="refsect3"> <a name="id-1.5.5.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>action</p></td> <td class="parameter_description"><p>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>point</p></td> <td class="parameter_description"><p>the touch point index, with 0 being the first touch point received by the action</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>delta_x</p></td> <td class="parameter_description"><p> return location for the X axis component of the incremental motion delta. </p></td> <td class="parameter_annotations"><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 class="parameter_name"><p>delta_y</p></td> <td class="parameter_description"><p> return location for the Y axis component of the incremental motion delta. </p></td> <td class="parameter_annotations"><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> </div> <div class="refsect3"> <a name="id-1.5.5.5.9.6.6"></a><h4>Returns</h4> <p> the distance since last motion event</p> </div> <p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p> </div> <hr> <div class="refsect2"> <a name="clutter-gesture-action-get-release-coords"></a><h3>clutter_gesture_action_get_release_coords ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> clutter_gesture_action_get_release_coords (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>, <em class="parameter"><code><span class="type">guint</span> point</code></em>, <em class="parameter"><code><span class="type">gfloat</span> *release_x</code></em>, <em class="parameter"><code><span class="type">gfloat</span> *release_y</code></em>);</pre> <p>Retrieves the coordinates, in stage space, where the touch point was last released.</p> <div class="refsect3"> <a name="id-1.5.5.5.9.7.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>action</p></td> <td class="parameter_description"><p>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>point</p></td> <td class="parameter_description"><p>the touch point index, with 0 being the first touch point received by the action</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>release_x</p></td> <td class="parameter_description"><p> return location for the X coordinate of the last release. </p></td> <td class="parameter_annotations"><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 class="parameter_name"><p>release_y</p></td> <td class="parameter_description"><p> return location for the Y coordinate of the last release. </p></td> <td class="parameter_annotations"><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> </div> <p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p> </div> <hr> <div class="refsect2"> <a name="clutter-gesture-action-get-velocity"></a><h3>clutter_gesture_action_get_velocity ()</h3> <pre class="programlisting"><span class="returnvalue">gfloat</span> clutter_gesture_action_get_velocity (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>, <em class="parameter"><code><span class="type">guint</span> point</code></em>, <em class="parameter"><code><span class="type">gfloat</span> *velocity_x</code></em>, <em class="parameter"><code><span class="type">gfloat</span> *velocity_y</code></em>);</pre> <p>Retrieves the velocity, in stage pixels per millisecond, of the latest motion event during the dragging.</p> <div class="refsect3"> <a name="id-1.5.5.5.9.8.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>action</p></td> <td class="parameter_description"><p>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>point</p></td> <td class="parameter_description"><p>the touch point index, with 0 being the first touch point received by the action</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>velocity_x</p></td> <td class="parameter_description"><p> return location for the latest motion event's X velocity. </p></td> <td class="parameter_annotations"><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 class="parameter_name"><p>velocity_y</p></td> <td class="parameter_description"><p> return location for the latest motion event's Y velocity. </p></td> <td class="parameter_annotations"><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> </div> <p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p> </div> <hr> <div class="refsect2"> <a name="clutter-gesture-action-get-n-touch-points"></a><h3>clutter_gesture_action_get_n_touch_points ()</h3> <pre class="programlisting"><span class="returnvalue">gint</span> clutter_gesture_action_get_n_touch_points (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>);</pre> <p>Retrieves the number of requested points to trigger the gesture.</p> <div class="refsect3"> <a name="id-1.5.5.5.9.9.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>action</p></td> <td class="parameter_description"><p>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a></p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="id-1.5.5.5.9.9.6"></a><h4>Returns</h4> <p> the number of points to trigger the gesture.</p> </div> <p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p> </div> <hr> <div class="refsect2"> <a name="clutter-gesture-action-set-n-touch-points"></a><h3>clutter_gesture_action_set_n_touch_points ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> clutter_gesture_action_set_n_touch_points (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>, <em class="parameter"><code><span class="type">gint</span> nb_points</code></em>);</pre> <p>Sets the number of points needed to trigger the gesture.</p> <div class="refsect3"> <a name="id-1.5.5.5.9.10.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>action</p></td> <td class="parameter_description"><p>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>nb_points</p></td> <td class="parameter_description"><p>a number of points</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p> </div> <hr> <div class="refsect2"> <a name="clutter-gesture-action-get-n-current-points"></a><h3>clutter_gesture_action_get_n_current_points ()</h3> <pre class="programlisting"><span class="returnvalue">guint</span> clutter_gesture_action_get_n_current_points (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>);</pre> <p>Retrieves the number of points currently active.</p> <div class="refsect3"> <a name="id-1.5.5.5.9.11.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>action</p></td> <td class="parameter_description"><p>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a></p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="id-1.5.5.5.9.11.6"></a><h4>Returns</h4> <p> the number of points currently active.</p> </div> <p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p> </div> <hr> <div class="refsect2"> <a name="clutter-gesture-action-get-sequence"></a><h3>clutter_gesture_action_get_sequence ()</h3> <pre class="programlisting"><a class="link" href="clutter-Events.html#ClutterEventSequence"><span class="returnvalue">ClutterEventSequence</span></a> * clutter_gesture_action_get_sequence (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>, <em class="parameter"><code><span class="type">guint</span> point</code></em>);</pre> <p>Retrieves the <a class="link" href="clutter-Events.html#ClutterEventSequence"><span class="type">ClutterEventSequence</span></a> of a touch point.</p> <div class="refsect3"> <a name="id-1.5.5.5.9.12.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>action</p></td> <td class="parameter_description"><p>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>point</p></td> <td class="parameter_description"><p>index of a point currently active</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="id-1.5.5.5.9.12.6"></a><h4>Returns</h4> <p> the <a class="link" href="clutter-Events.html#ClutterEventSequence"><span class="type">ClutterEventSequence</span></a> of a touch point. </p> <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> </div> <p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p> </div> <hr> <div class="refsect2"> <a name="clutter-gesture-action-get-device"></a><h3>clutter_gesture_action_get_device ()</h3> <pre class="programlisting"><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="returnvalue">ClutterInputDevice</span></a> * clutter_gesture_action_get_device (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>, <em class="parameter"><code><span class="type">guint</span> point</code></em>);</pre> <p>Retrieves the <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> of a touch point.</p> <div class="refsect3"> <a name="id-1.5.5.5.9.13.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>action</p></td> <td class="parameter_description"><p>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>point</p></td> <td class="parameter_description"><p>the touch point index, with 0 being the first touch point received by the action</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="id-1.5.5.5.9.13.6"></a><h4>Returns</h4> <p> the <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> of a touch point. </p> <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> </div> <p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p> </div> <hr> <div class="refsect2"> <a name="clutter-gesture-action-get-threshold-trigger-distance"></a><h3>clutter_gesture_action_get_threshold_trigger_distance ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> clutter_gesture_action_get_threshold_trigger_distance (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>, <em class="parameter"><code><span class="type">float</span> *x</code></em>, <em class="parameter"><code><span class="type">float</span> *y</code></em>);</pre> <p>Retrieves the threshold trigger distance of the gesture <em class="parameter"><code>action</code></em> , as set using <a class="link" href="ClutterGestureAction.html#clutter-gesture-action-set-threshold-trigger-distance" title="clutter_gesture_action_set_threshold_trigger_distance ()"><code class="function">clutter_gesture_action_set_threshold_trigger_distance()</code></a>.</p> <div class="refsect3"> <a name="id-1.5.5.5.9.14.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>action</p></td> <td class="parameter_description"><p>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>x</p></td> <td class="parameter_description"><p> The return location for the horizontal distance, or <code class="literal">NULL</code>. </p></td> <td class="parameter_annotations"><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 class="parameter_name"><p>y</p></td> <td class="parameter_description"><p> The return location for the vertical distance, or <code class="literal">NULL</code>. </p></td> <td class="parameter_annotations"><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> </div> <p class="since">Since: <a class="link" href="ix16.html#api-index-1.18">1.18</a></p> </div> <hr> <div class="refsect2"> <a name="clutter-gesture-action-set-threshold-trigger-distance"></a><h3>clutter_gesture_action_set_threshold_trigger_distance ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> clutter_gesture_action_set_threshold_trigger_distance (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>, <em class="parameter"><code><span class="type">float</span> x</code></em>, <em class="parameter"><code><span class="type">float</span> y</code></em>);</pre> <p>Sets the threshold trigger distance for the gesture drag threshold, if any.</p> <p>This function should only be called by sub-classes of <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> during their construction phase.</p> <div class="refsect3"> <a name="id-1.5.5.5.9.15.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>action</p></td> <td class="parameter_description"><p>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>x</p></td> <td class="parameter_description"><p>the distance on the horizontal axis</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>y</p></td> <td class="parameter_description"><p>the distance on the vertical axis</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <p class="since">Since: <a class="link" href="ix16.html#api-index-1.18">1.18</a></p> </div> <hr> <div class="refsect2"> <a name="clutter-gesture-action-set-threshold-trigger-edge"></a><h3>clutter_gesture_action_set_threshold_trigger_edge ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> clutter_gesture_action_set_threshold_trigger_edge (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>, <em class="parameter"><code><a class="link" href="ClutterGestureAction.html#ClutterGestureTriggerEdge" title="enum ClutterGestureTriggerEdge"><span class="type">ClutterGestureTriggerEdge</span></a> edge</code></em>);</pre> <p>Sets the edge trigger for the gesture drag threshold, if any.</p> <p>This function should only be called by sub-classes of <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> during their construction phase.</p> <div class="refsect3"> <a name="id-1.5.5.5.9.16.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>action</p></td> <td class="parameter_description"><p>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>edge</p></td> <td class="parameter_description"><p>the <a class="link" href="ClutterGestureAction.html#ClutterGestureTriggerEdge" title="enum ClutterGestureTriggerEdge"><code class="literal">ClutterGestureTriggerEdge</code></a></p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <p class="since">Since: <a class="link" href="ix16.html#api-index-1.18">1.18</a></p> </div> <hr> <div class="refsect2"> <a name="clutter-gesture-action-get-threshold-trigger-edge"></a><h3>clutter_gesture_action_get_threshold_trigger_edge ()</h3> <pre class="programlisting"><a class="link" href="ClutterGestureAction.html#ClutterGestureTriggerEdge" title="enum ClutterGestureTriggerEdge"><span class="returnvalue">ClutterGestureTriggerEdge</span></a> clutter_gesture_action_get_threshold_trigger_edge (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>);</pre> <p>Retrieves the edge trigger of the gesture <em class="parameter"><code>action</code></em> , as set using <a class="link" href="ClutterGestureAction.html#clutter-gesture-action-set-threshold-trigger-edge" title="clutter_gesture_action_set_threshold_trigger_edge ()"><code class="function">clutter_gesture_action_set_threshold_trigger_edge()</code></a>.</p> <div class="refsect3"> <a name="id-1.5.5.5.9.17.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>action</p></td> <td class="parameter_description"><p>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a></p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="id-1.5.5.5.9.17.6"></a><h4>Returns</h4> <p> the edge trigger</p> </div> <p class="since">Since: <a class="link" href="ix17.html#api-index-1.20">1.20</a></p> </div> <hr> <div class="refsect2"> <a name="clutter-gesture-action-cancel"></a><h3>clutter_gesture_action_cancel ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> clutter_gesture_action_cancel (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>);</pre> <p>Cancel a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> before it begins</p> <div class="refsect3"> <a name="id-1.5.5.5.9.18.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>action</p></td> <td class="parameter_description"><p>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a></p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p> </div> </div> <div class="refsect1"> <a name="ClutterGestureAction.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> <a name="ClutterGestureAction-struct"></a><h3>struct ClutterGestureAction</h3> <pre class="programlisting">struct ClutterGestureAction;</pre> <p>The <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> structure contains only private data and should be accessed using the provided API</p> <p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p> </div> <hr> <div class="refsect2"> <a name="ClutterGestureActionClass"></a><h3>struct ClutterGestureActionClass</h3> <pre class="programlisting">struct ClutterGestureActionClass { gboolean (* gesture_begin) (ClutterGestureAction *action, ClutterActor *actor); gboolean (* gesture_progress) (ClutterGestureAction *action, ClutterActor *actor); void (* gesture_end) (ClutterGestureAction *action, ClutterActor *actor); void (* gesture_cancel) (ClutterGestureAction *action, ClutterActor *actor); gboolean (* gesture_prepare) (ClutterGestureAction *action, ClutterActor *actor); }; </pre> <p>The <span class="type">ClutterGestureClass</span> structure contains only private data.</p> <div class="refsect3"> <a name="id-1.5.5.5.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="ClutterGestureActionClass.gesture-begin"></a>gesture_begin</code></em> ()</p></td> <td class="struct_member_description"><p>class handler for the <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-begin" title="The “gesture-begin” signal"><span class="type">“gesture-begin”</span></a> signal</p></td> <td class="struct_member_annotations"> </td> </tr> <tr> <td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterGestureActionClass.gesture-progress"></a>gesture_progress</code></em> ()</p></td> <td class="struct_member_description"><p>class handler for the <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-progress" title="The “gesture-progress” signal"><span class="type">“gesture-progress”</span></a> signal</p></td> <td class="struct_member_annotations"> </td> </tr> <tr> <td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterGestureActionClass.gesture-end"></a>gesture_end</code></em> ()</p></td> <td class="struct_member_description"><p>class handler for the <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-end" title="The “gesture-end” signal"><span class="type">“gesture-end”</span></a> signal</p></td> <td class="struct_member_annotations"> </td> </tr> <tr> <td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterGestureActionClass.gesture-cancel"></a>gesture_cancel</code></em> ()</p></td> <td class="struct_member_description"><p>class handler for the <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-cancel" title="The “gesture-cancel” signal"><span class="type">“gesture-cancel”</span></a> signal</p></td> <td class="struct_member_annotations"> </td> </tr> <tr> <td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterGestureActionClass.gesture-prepare"></a>gesture_prepare</code></em> ()</p></td> <td class="struct_member_description"><p>virtual function called before emitting the <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-cancel" title="The “gesture-cancel” signal"><span class="type">“gesture-cancel”</span></a> signal</p></td> <td class="struct_member_annotations"> </td> </tr> </tbody> </table></div> </div> <p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p> </div> <hr> <div class="refsect2"> <a name="ClutterGestureTriggerEdge"></a><h3>enum ClutterGestureTriggerEdge</h3> <p>Enum passed to the <a class="link" href="ClutterGestureAction.html#clutter-gesture-action-set-threshold-trigger-edge" title="clutter_gesture_action_set_threshold_trigger_edge ()"><code class="function">clutter_gesture_action_set_threshold_trigger_edge()</code></a> function.</p> <div class="refsect3"> <a name="id-1.5.5.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-GESTURE-TRIGGER-EDGE-NONE:CAPS"></a>CLUTTER_GESTURE_TRIGGER_EDGE_NONE</p></td> <td class="enum_member_description"> <p>Tell <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> that the gesture must begin immediately and there's no drag limit that will cause its cancellation;</p> </td> <td class="enum_member_annotations"> </td> </tr> <tr> <td class="enum_member_name"><p><a name="CLUTTER-GESTURE-TRIGGER-EDGE-AFTER:CAPS"></a>CLUTTER_GESTURE_TRIGGER_EDGE_AFTER</p></td> <td class="enum_member_description"> <p>Tell <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> that it needs to wait until the drag threshold has been exceeded before considering that the gesture has begun;</p> </td> <td class="enum_member_annotations"> </td> </tr> <tr> <td class="enum_member_name"><p><a name="CLUTTER-GESTURE-TRIGGER-EDGE-BEFORE:CAPS"></a>CLUTTER_GESTURE_TRIGGER_EDGE_BEFORE</p></td> <td class="enum_member_description"> <p>Tell <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> that the gesture must begin immediately and that it must be cancelled once the drag exceed the configured threshold.</p> </td> <td class="enum_member_annotations"> </td> </tr> </tbody> </table></div> </div> <p class="since">Since: <a class="link" href="ix16.html#api-index-1.18">1.18</a></p> </div> </div> <div class="refsect1"> <a name="ClutterGestureAction.property-details"></a><h2>Property Details</h2> <div class="refsect2"> <a name="ClutterGestureAction--n-touch-points"></a><h3>The <code class="literal">“n-touch-points”</code> property</h3> <pre class="programlisting"> “n-touch-points” <span class="type">gint</span></pre> <p>Number of touch points to trigger a gesture action.</p> <p>Flags: Read / Write</p> <p>Allowed values: >= 1</p> <p>Default value: 1</p> <p class="since">Since: <a class="link" href="ix15.html#api-index-1.16">1.16</a></p> </div> <hr> <div class="refsect2"> <a name="ClutterGestureAction--threshold-trigger-distance-x"></a><h3>The <code class="literal">“threshold-trigger-distance-x”</code> property</h3> <pre class="programlisting"> “threshold-trigger-distance-x” <span class="type">gfloat</span></pre> <p>The horizontal trigger distance to be used by the action to either emit the <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-begin" title="The “gesture-begin” signal"><span class="type">“gesture-begin”</span></a> signal or to emit the <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-cancel" title="The “gesture-cancel” signal"><span class="type">“gesture-cancel”</span></a> signal.</p> <p>A negative value will be interpreted as the default drag threshold.</p> <p>Flags: Read / Write / Construct Only</p> <p>Allowed values: >= -1</p> <p>Default value: -1</p> <p class="since">Since: <a class="link" href="ix16.html#api-index-1.18">1.18</a></p> </div> <hr> <div class="refsect2"> <a name="ClutterGestureAction--threshold-trigger-distance-y"></a><h3>The <code class="literal">“threshold-trigger-distance-y”</code> property</h3> <pre class="programlisting"> “threshold-trigger-distance-y” <span class="type">gfloat</span></pre> <p>The vertical trigger distance to be used by the action to either emit the <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-begin" title="The “gesture-begin” signal"><span class="type">“gesture-begin”</span></a> signal or to emit the <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-cancel" title="The “gesture-cancel” signal"><span class="type">“gesture-cancel”</span></a> signal.</p> <p>A negative value will be interpreted as the default drag threshold.</p> <p>Flags: Read / Write / Construct Only</p> <p>Allowed values: >= -1</p> <p>Default value: -1</p> <p class="since">Since: <a class="link" href="ix16.html#api-index-1.18">1.18</a></p> </div> <hr> <div class="refsect2"> <a name="ClutterGestureAction--threshold-trigger-edge"></a><h3>The <code class="literal">“threshold-trigger-edge”</code> property</h3> <pre class="programlisting"> “threshold-trigger-edge” <a class="link" href="ClutterGestureAction.html#ClutterGestureTriggerEdge" title="enum ClutterGestureTriggerEdge"><span class="type">ClutterGestureTriggerEdge</span></a></pre> <p>The trigger edge to be used by the action to either emit the <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-begin" title="The “gesture-begin” signal"><span class="type">“gesture-begin”</span></a> signal or to emit the <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-cancel" title="The “gesture-cancel” signal"><span class="type">“gesture-cancel”</span></a> signal.</p> <p>Flags: Read / Write / Construct Only</p> <p>Default value: CLUTTER_GESTURE_TRIGGER_EDGE_NONE</p> <p class="since">Since: <a class="link" href="ix16.html#api-index-1.18">1.18</a></p> </div> </div> <div class="refsect1"> <a name="ClutterGestureAction.signal-details"></a><h2>Signal Details</h2> <div class="refsect2"> <a name="ClutterGestureAction-gesture-begin"></a><h3>The <code class="literal">“gesture-begin”</code> signal</h3> <pre class="programlisting"><span class="returnvalue">gboolean</span> user_function (<a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</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)</pre> <p>The ::gesture_begin signal is emitted when the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to which a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> has been applied starts receiving a gesture.</p> <div class="refsect3"> <a name="id-1.5.5.5.12.2.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>action</p></td> <td class="parameter_description"><p>the <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> that emitted the signal</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>actor</p></td> <td class="parameter_description"><p>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> </p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>user_data</p></td> <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="id-1.5.5.5.12.2.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the gesture should start, and <code class="literal">FALSE</code> if the gesture should be ignored.</p> </div> <p>Flags: Run Last</p> <p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p> </div> <hr> <div class="refsect2"> <a name="ClutterGestureAction-gesture-cancel"></a><h3>The <code class="literal">“gesture-cancel”</code> signal</h3> <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</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)</pre> <p>The ::gesture-cancel signal is emitted when the ongoing gesture gets cancelled from the <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-progress" title="The “gesture-progress” signal"><span class="type">“gesture-progress”</span></a> signal handler.</p> <p>This signal is emitted if and only if the <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-begin" title="The “gesture-begin” signal"><span class="type">“gesture-begin”</span></a> signal has been emitted first.</p> <div class="refsect3"> <a name="id-1.5.5.5.12.3.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>action</p></td> <td class="parameter_description"><p>the <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> that emitted the signal</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>actor</p></td> <td class="parameter_description"><p>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> </p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>user_data</p></td> <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <p>Flags: Run Last</p> <p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p> </div> <hr> <div class="refsect2"> <a name="ClutterGestureAction-gesture-end"></a><h3>The <code class="literal">“gesture-end”</code> signal</h3> <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</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)</pre> <p>The ::gesture-end signal is emitted at the end of the gesture gesture, when the pointer's button is released</p> <p>This signal is emitted if and only if the <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-begin" title="The “gesture-begin” signal"><span class="type">“gesture-begin”</span></a> signal has been emitted first.</p> <div class="refsect3"> <a name="id-1.5.5.5.12.4.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>action</p></td> <td class="parameter_description"><p>the <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> that emitted the signal</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>actor</p></td> <td class="parameter_description"><p>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> </p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>user_data</p></td> <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <p>Flags: Run Last</p> <p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p> </div> <hr> <div class="refsect2"> <a name="ClutterGestureAction-gesture-progress"></a><h3>The <code class="literal">“gesture-progress”</code> signal</h3> <pre class="programlisting"><span class="returnvalue">gboolean</span> user_function (<a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</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)</pre> <p>The ::gesture-progress signal is emitted for each motion event after the <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-begin" title="The “gesture-begin” signal"><span class="type">“gesture-begin”</span></a> signal has been emitted.</p> <div class="refsect3"> <a name="id-1.5.5.5.12.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>action</p></td> <td class="parameter_description"><p>the <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> that emitted the signal</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>actor</p></td> <td class="parameter_description"><p>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> </p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>user_data</p></td> <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="id-1.5.5.5.12.5.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the gesture should continue, and <code class="literal">FALSE</code> if the gesture should be cancelled.</p> </div> <p>Flags: Run Last</p> <p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p> </div> </div> </div> <div class="footer"> <hr>Generated by GTK-Doc V1.24</div> </body> </html>