cleanup specfile for packaging
[profile/ivi/clutter.git] / doc / reference / clutter / html / ClutterGestureAction.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>ClutterGestureAction</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="Clutter Reference Manual">
8 <link rel="up" href="ch04.html" title="Actions">
9 <link rel="prev" href="ClutterDropAction.html" title="ClutterDropAction">
10 <link rel="next" href="ClutterSwipeAction.html" title="ClutterSwipeAction">
11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="ClutterDropAction.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">Clutter Reference Manual</th>
21 <td><a accesskey="n" href="ClutterSwipeAction.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#ClutterGestureAction.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#ClutterGestureAction.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#ClutterGestureAction.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#ClutterGestureAction.signals" class="shortcut">Signals</a>
31 </td></tr>
32 </table>
33 <div class="refentry">
34 <a name="ClutterGestureAction"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
36 <td valign="top">
37 <h2><span class="refentrytitle"><a name="ClutterGestureAction.top_of_page"></a>ClutterGestureAction</span></h2>
38 <p>ClutterGestureAction — Action for gesture gestures</p>
39 </td>
40 <td valign="top" align="right"></td>
41 </tr></table></div>
42 <div class="refsynopsisdiv">
43 <a name="ClutterGestureAction.synopsis"></a><h2>Synopsis</h2>
44 <pre class="synopsis">struct              <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-struct" title="struct ClutterGestureAction">ClutterGestureAction</a>;
45 struct              <a class="link" href="ClutterGestureAction.html#ClutterGestureActionClass" title="struct ClutterGestureActionClass">ClutterGestureActionClass</a>;
46 <a class="link" href="ClutterAction.html" title="ClutterAction"><span class="returnvalue">ClutterAction</span></a> *     <a class="link" href="ClutterGestureAction.html#clutter-gesture-action-new" title="clutter_gesture_action_new ()">clutter_gesture_action_new</a>          (<em class="parameter"><code><span class="type">void</span></code></em>);
47 <span class="returnvalue">void</span>                <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>
48                                                         (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>,
49                                                          <em class="parameter"><code><span class="type">guint</span> device</code></em>,
50                                                          <em class="parameter"><code><span class="type">gfloat</span> *press_x</code></em>,
51                                                          <em class="parameter"><code><span class="type">gfloat</span> *press_y</code></em>);
52 <span class="returnvalue">void</span>                <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>
53                                                         (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>,
54                                                          <em class="parameter"><code><span class="type">guint</span> device</code></em>,
55                                                          <em class="parameter"><code><span class="type">gfloat</span> *motion_x</code></em>,
56                                                          <em class="parameter"><code><span class="type">gfloat</span> *motion_y</code></em>);
57 <span class="returnvalue">void</span>                <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>
58                                                         (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>,
59                                                          <em class="parameter"><code><span class="type">guint</span> device</code></em>,
60                                                          <em class="parameter"><code><span class="type">gfloat</span> *release_x</code></em>,
61                                                          <em class="parameter"><code><span class="type">gfloat</span> *release_y</code></em>);
62 </pre>
63 </div>
64 <div class="refsect1">
65 <a name="ClutterGestureAction.object-hierarchy"></a><h2>Object Hierarchy</h2>
66 <pre class="synopsis">
67   GObject
68    +----GInitiallyUnowned
69          +----<a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta">ClutterActorMeta</a>
70                +----<a class="link" href="ClutterAction.html" title="ClutterAction">ClutterAction</a>
71                      +----ClutterGestureAction
72                            +----<a class="link" href="ClutterSwipeAction.html" title="ClutterSwipeAction">ClutterSwipeAction</a>
73 </pre>
74 </div>
75 <div class="refsect1">
76 <a name="ClutterGestureAction.signals"></a><h2>Signals</h2>
77 <pre class="synopsis">
78   "<a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-begin" title='The "gesture-begin" signal'>gesture-begin</a>"                                  : <code class="literal">Run Last</code>
79   "<a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-cancel" title='The "gesture-cancel" signal'>gesture-cancel</a>"                                 : <code class="literal">Run Last</code>
80   "<a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-end" title='The "gesture-end" signal'>gesture-end</a>"                                    : <code class="literal">Run Last</code>
81   "<a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-progress" title='The "gesture-progress" signal'>gesture-progress</a>"                               : <code class="literal">Run Last</code>
82 </pre>
83 </div>
84 <div class="refsect1">
85 <a name="ClutterGestureAction.description"></a><h2>Description</h2>
86 <p>
87 <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
88 the logic for recognizing gesture gestures. It listens for low level events
89 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
90 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>,
91 and * <a class="link" href="ClutterGestureAction.html#ClutterGestureAction-gesture-end" title='The "gesture-end" signal'><span class="type">"gesture-end"</span></a> signals.
92 </p>
93 <p>
94 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>
95 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:
96 </p>
97 <p>
98 </p>
99 <div class="informalexample">
100   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
101     <tbody>
102       <tr>
103         <td class="listing_lines" align="right"><pre>1
104 2
105 3
106 4
107 5
108 6
109 7</pre></td>
110         <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>
111
112 <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>
113
114 <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"> <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS">NULL</a></span><span class="symbol">);</span>
115 <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"> <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS">NULL</a></span><span class="symbol">);</span>
116 <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"> <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS">NULL</a></span><span class="symbol">);</span></pre></td>
117       </tr>
118     </tbody>
119   </table>
120 </div>
121
122 <p>
123 </p>
124 </div>
125 <div class="refsect1">
126 <a name="ClutterGestureAction.details"></a><h2>Details</h2>
127 <div class="refsect2">
128 <a name="ClutterGestureAction-struct"></a><h3>struct ClutterGestureAction</h3>
129 <pre class="programlisting">struct ClutterGestureAction;</pre>
130 <p>
131 The <span class="structname">ClutterGestureAction</span> structure contains
132 only private data and should be accessed using the provided API
133 </p>
134 <p class="since">Since 1.8</p>
135 </div>
136 <hr>
137 <div class="refsect2">
138 <a name="ClutterGestureActionClass"></a><h3>struct ClutterGestureActionClass</h3>
139 <pre class="programlisting">struct ClutterGestureActionClass {
140   gboolean (* gesture_begin)    (ClutterGestureAction  *action,
141                                  ClutterActor          *actor);
142   gboolean (* gesture_progress) (ClutterGestureAction  *action,
143                                  ClutterActor          *actor);
144   void     (* gesture_end)      (ClutterGestureAction  *action,
145                                  ClutterActor          *actor);
146   void     (* gesture_cancel)   (ClutterGestureAction  *action,
147                                  ClutterActor          *actor);
148 };
149 </pre>
150 <p>
151 The <span class="structname">ClutterGestureClass</span> structure contains only
152 private data.
153 </p>
154 <div class="variablelist"><table border="0">
155 <col align="left" valign="top">
156 <tbody>
157 <tr>
158 <td><p><span class="term"><em class="structfield"><code><a name="ClutterGestureActionClass.gesture-begin"></a>gesture_begin</code></em> ()</span></p></td>
159 <td>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</td>
160 </tr>
161 <tr>
162 <td><p><span class="term"><em class="structfield"><code><a name="ClutterGestureActionClass.gesture-progress"></a>gesture_progress</code></em> ()</span></p></td>
163 <td>class handler for the <span class="type">"gesture-progres"</span> signal</td>
164 </tr>
165 <tr>
166 <td><p><span class="term"><em class="structfield"><code><a name="ClutterGestureActionClass.gesture-end"></a>gesture_end</code></em> ()</span></p></td>
167 <td>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</td>
168 </tr>
169 <tr>
170 <td><p><span class="term"><em class="structfield"><code><a name="ClutterGestureActionClass.gesture-cancel"></a>gesture_cancel</code></em> ()</span></p></td>
171 <td>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</td>
172 </tr>
173 </tbody>
174 </table></div>
175 <p class="since">Since 1.8</p>
176 </div>
177 <hr>
178 <div class="refsect2">
179 <a name="clutter-gesture-action-new"></a><h3>clutter_gesture_action_new ()</h3>
180 <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>
181 <p>
182 Creates a new <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> instance.
183 </p>
184 <div class="variablelist"><table border="0">
185 <col align="left" valign="top">
186 <tbody><tr>
187 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
188 <td>the newly created <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a>
189 </td>
190 </tr></tbody>
191 </table></div>
192 <p class="since">Since 1.8</p>
193 </div>
194 <hr>
195 <div class="refsect2">
196 <a name="clutter-gesture-action-get-press-coords"></a><h3>clutter_gesture_action_get_press_coords ()</h3>
197 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_gesture_action_get_press_coords
198                                                         (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>,
199                                                          <em class="parameter"><code><span class="type">guint</span> device</code></em>,
200                                                          <em class="parameter"><code><span class="type">gfloat</span> *press_x</code></em>,
201                                                          <em class="parameter"><code><span class="type">gfloat</span> *press_y</code></em>);</pre>
202 <p>
203 Retrieves the coordinates, in stage space, of the press event
204 that started the dragging for an specific pointer device
205 </p>
206 <div class="variablelist"><table border="0">
207 <col align="left" valign="top">
208 <tbody>
209 <tr>
210 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
211 <td>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a>
212 </td>
213 </tr>
214 <tr>
215 <td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
216 <td>currently unused, set to 0</td>
217 </tr>
218 <tr>
219 <td><p><span class="term"><em class="parameter"><code>press_x</code></em> :</span></p></td>
220 <td>return location for the press event's X coordinate. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
221 </td>
222 </tr>
223 <tr>
224 <td><p><span class="term"><em class="parameter"><code>press_y</code></em> :</span></p></td>
225 <td>return location for the press event's Y coordinate. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
226 </td>
227 </tr>
228 </tbody>
229 </table></div>
230 <p class="since">Since 1.8</p>
231 </div>
232 <hr>
233 <div class="refsect2">
234 <a name="clutter-gesture-action-get-motion-coords"></a><h3>clutter_gesture_action_get_motion_coords ()</h3>
235 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_gesture_action_get_motion_coords
236                                                         (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>,
237                                                          <em class="parameter"><code><span class="type">guint</span> device</code></em>,
238                                                          <em class="parameter"><code><span class="type">gfloat</span> *motion_x</code></em>,
239                                                          <em class="parameter"><code><span class="type">gfloat</span> *motion_y</code></em>);</pre>
240 <p>
241 Retrieves the coordinates, in stage space, of the latest motion
242 event during the dragging
243 </p>
244 <div class="variablelist"><table border="0">
245 <col align="left" valign="top">
246 <tbody>
247 <tr>
248 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
249 <td>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a>
250 </td>
251 </tr>
252 <tr>
253 <td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
254 <td>currently unused, set to 0</td>
255 </tr>
256 <tr>
257 <td><p><span class="term"><em class="parameter"><code>motion_x</code></em> :</span></p></td>
258 <td>return location for the latest motion
259 event's X coordinate. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
260 </td>
261 </tr>
262 <tr>
263 <td><p><span class="term"><em class="parameter"><code>motion_y</code></em> :</span></p></td>
264 <td>return location for the latest motion
265 event's Y coordinate. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
266 </td>
267 </tr>
268 </tbody>
269 </table></div>
270 <p class="since">Since 1.8</p>
271 </div>
272 <hr>
273 <div class="refsect2">
274 <a name="clutter-gesture-action-get-release-coords"></a><h3>clutter_gesture_action_get_release_coords ()</h3>
275 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_gesture_action_get_release_coords
276                                                         (<em class="parameter"><code><a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> *action</code></em>,
277                                                          <em class="parameter"><code><span class="type">guint</span> device</code></em>,
278                                                          <em class="parameter"><code><span class="type">gfloat</span> *release_x</code></em>,
279                                                          <em class="parameter"><code><span class="type">gfloat</span> *release_y</code></em>);</pre>
280 <p>
281 Retrieves the coordinates, in stage space, of the point where the pointer
282 device was last released.
283 </p>
284 <div class="variablelist"><table border="0">
285 <col align="left" valign="top">
286 <tbody>
287 <tr>
288 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
289 <td>a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a>
290 </td>
291 </tr>
292 <tr>
293 <td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
294 <td>currently unused, set to 0</td>
295 </tr>
296 <tr>
297 <td><p><span class="term"><em class="parameter"><code>release_x</code></em> :</span></p></td>
298 <td>return location for the X coordinate of the last release. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
299 </td>
300 </tr>
301 <tr>
302 <td><p><span class="term"><em class="parameter"><code>release_y</code></em> :</span></p></td>
303 <td>return location for the Y coordinate of the last release. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
304 </td>
305 </tr>
306 </tbody>
307 </table></div>
308 <p class="since">Since 1.8</p>
309 </div>
310 </div>
311 <div class="refsect1">
312 <a name="ClutterGestureAction.signal-details"></a><h2>Signal Details</h2>
313 <div class="refsect2">
314 <a name="ClutterGestureAction-gesture-begin"></a><h3>The <code class="literal">"gesture-begin"</code> signal</h3>
315 <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,
316                                                         <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>         *actor,
317                                                         <span class="type">gpointer</span>              user_data)      : <code class="literal">Run Last</code></pre>
318 <p>
319 The ::gesture_begin signal is emitted when the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to which
320 a <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> has been applied starts receiving a gesture.
321 </p>
322 <div class="variablelist"><table border="0">
323 <col align="left" valign="top">
324 <tbody>
325 <tr>
326 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
327 <td>the <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> that emitted the signal</td>
328 </tr>
329 <tr>
330 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
331 <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>
332 </td>
333 </tr>
334 <tr>
335 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
336 <td>user data set when the signal handler was connected.</td>
337 </tr>
338 <tr>
339 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
340 <td>
341 <code class="literal">TRUE</code> if the gesture should start, and <code class="literal">FALSE</code> if
342 the gesture should be ignored.</td>
343 </tr>
344 </tbody>
345 </table></div>
346 <p class="since">Since 1.8</p>
347 </div>
348 <hr>
349 <div class="refsect2">
350 <a name="ClutterGestureAction-gesture-cancel"></a><h3>The <code class="literal">"gesture-cancel"</code> signal</h3>
351 <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,
352                                                         <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>         *actor,
353                                                         <span class="type">gpointer</span>              user_data)      : <code class="literal">Run Last</code></pre>
354 <p>
355 The ::gesture-cancel signal is emitted when the ongoing gesture gets
356 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.
357 </p>
358 <p>
359 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>
360 signal has been emitted first.
361 </p>
362 <div class="variablelist"><table border="0">
363 <col align="left" valign="top">
364 <tbody>
365 <tr>
366 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
367 <td>the <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> that emitted the signal</td>
368 </tr>
369 <tr>
370 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
371 <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>
372 </td>
373 </tr>
374 <tr>
375 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
376 <td>user data set when the signal handler was connected.</td>
377 </tr>
378 </tbody>
379 </table></div>
380 <p class="since">Since 1.8</p>
381 </div>
382 <hr>
383 <div class="refsect2">
384 <a name="ClutterGestureAction-gesture-end"></a><h3>The <code class="literal">"gesture-end"</code> signal</h3>
385 <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,
386                                                         <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>         *actor,
387                                                         <span class="type">gpointer</span>              user_data)      : <code class="literal">Run Last</code></pre>
388 <p>
389 The ::gesture-end signal is emitted at the end of the gesture gesture,
390 when the pointer's button is released
391 </p>
392 <p>
393 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>
394 signal has been emitted first.
395 </p>
396 <div class="variablelist"><table border="0">
397 <col align="left" valign="top">
398 <tbody>
399 <tr>
400 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
401 <td>the <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> that emitted the signal</td>
402 </tr>
403 <tr>
404 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
405 <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>
406 </td>
407 </tr>
408 <tr>
409 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
410 <td>user data set when the signal handler was connected.</td>
411 </tr>
412 </tbody>
413 </table></div>
414 <p class="since">Since 1.8</p>
415 </div>
416 <hr>
417 <div class="refsect2">
418 <a name="ClutterGestureAction-gesture-progress"></a><h3>The <code class="literal">"gesture-progress"</code> signal</h3>
419 <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,
420                                                         <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>         *actor,
421                                                         <span class="type">gpointer</span>              user_data)      : <code class="literal">Run Last</code></pre>
422 <p>
423 The ::gesture-progress signal is emitted for each motion event after
424 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.
425 </p>
426 <div class="variablelist"><table border="0">
427 <col align="left" valign="top">
428 <tbody>
429 <tr>
430 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
431 <td>the <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> that emitted the signal</td>
432 </tr>
433 <tr>
434 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
435 <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>
436 </td>
437 </tr>
438 <tr>
439 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
440 <td>user data set when the signal handler was connected.</td>
441 </tr>
442 <tr>
443 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
444 <td>
445 <code class="literal">TRUE</code> if the gesture should continue, and <code class="literal">FALSE</code> if
446 the gesture should be cancelled.</td>
447 </tr>
448 </tbody>
449 </table></div>
450 <p class="since">Since 1.8</p>
451 </div>
452 </div>
453 </div>
454 <div class="footer">
455 <hr>
456           Generated by GTK-Doc V1.18.1</div>
457 </body>
458 </html>