doc/reference/clutter/html/ClutterSwipeAction.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>ClutterSwipeAction</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="ClutterGestureAction.html" title="ClutterGestureAction">
  10 <link rel="next" href="ch05.html" title="Constraints">
  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="ClutterGestureAction.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="ch05.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="#ClutterSwipeAction.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterSwipeAction.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterSwipeAction.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterSwipeAction.signals" class="shortcut">Signals</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="ClutterSwipeAction"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="ClutterSwipeAction.top_of_page"></a>ClutterSwipeAction</span></h2>
  38 <p>ClutterSwipeAction — Action for swipe gestures</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="ClutterSwipeAction.synopsis"></a><h2>Synopsis</h2>
  44 <pre class="synopsis">struct              <a class="link" href="ClutterSwipeAction.html#ClutterSwipeAction-struct" title="struct ClutterSwipeAction">ClutterSwipeAction</a>;
  45 struct              <a class="link" href="ClutterSwipeAction.html#ClutterSwipeActionClass" title="struct ClutterSwipeActionClass">ClutterSwipeActionClass</a>;
  46 enum                <a class="link" href="ClutterSwipeAction.html#ClutterSwipeDirection" title="enum ClutterSwipeDirection">ClutterSwipeDirection</a>;
  47 <a class="link" href="ClutterAction.html" title="ClutterAction"><span class="returnvalue">ClutterAction</span></a> *     <a class="link" href="ClutterSwipeAction.html#clutter-swipe-action-new" title="clutter_swipe_action_new ()">clutter_swipe_action_new</a>            (<em class="parameter"><code><span class="type">void</span></code></em>);
  48 </pre>
  49 </div>
  50 <div class="refsect1">
  51 <a name="ClutterSwipeAction.object-hierarchy"></a><h2>Object Hierarchy</h2>
  52 <pre class="synopsis">
  53   GObject
  54    +----GInitiallyUnowned
  55          +----<a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta">ClutterActorMeta</a>
  56                +----<a class="link" href="ClutterAction.html" title="ClutterAction">ClutterAction</a>
  57                      +----<a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction">ClutterGestureAction</a>
  58                            +----ClutterSwipeAction
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="ClutterSwipeAction.signals"></a><h2>Signals</h2>
  63 <pre class="synopsis">
  64   "<a class="link" href="ClutterSwipeAction.html#ClutterSwipeAction-swept" title='The "swept" signal'>swept</a>"                                          : <code class="literal">Run Last</code>
  65 </pre>
  66 </div>
  67 <div class="refsect1">
  68 <a name="ClutterSwipeAction.description"></a><h2>Description</h2>
  69 <p>
  70 <a class="link" href="ClutterSwipeAction.html" title="ClutterSwipeAction"><span class="type">ClutterSwipeAction</span></a> is a sub-class of <a class="link" href="ClutterGestureAction.html" title="ClutterGestureAction"><span class="type">ClutterGestureAction</span></a> that implements
  71 the logic for recognizing swipe gestures.
  72 </p>
  73 </div>
  74 <div class="refsect1">
  75 <a name="ClutterSwipeAction.details"></a><h2>Details</h2>
  76 <div class="refsect2">
  77 <a name="ClutterSwipeAction-struct"></a><h3>struct ClutterSwipeAction</h3>
  78 <pre class="programlisting">struct ClutterSwipeAction;</pre>
  79 <p>
  80 The <span class="structname">ClutterSwipeAction</span> structure contains
  81 only private data and should be accessed using the provided API
  82 </p>
  83 <p class="since">Since 1.8</p>
  84 </div>
  85 <hr>
  86 <div class="refsect2">
  87 <a name="ClutterSwipeActionClass"></a><h3>struct ClutterSwipeActionClass</h3>
  88 <pre class="programlisting">struct ClutterSwipeActionClass {
  89   void (* swept)  (ClutterSwipeAction    *action,
  90                    ClutterActor          *actor,
  91                    ClutterSwipeDirection  direction);
  92 };
  93 </pre>
  94 <p>
  95 The <span class="structname">ClutterSwipeActionClass</span> structure contains
  96 only private data.
  97 </p>
  98 <div class="variablelist"><table border="0">
  99 <col align="left" valign="top">
 100 <tbody><tr>
 101 <td><p><span class="term"><em class="structfield"><code><a name="ClutterSwipeActionClass.swept"></a>swept</code></em> ()</span></p></td>
 102 <td>class handler for the <a class="link" href="ClutterSwipeAction.html#ClutterSwipeAction-swept" title='The "swept" signal'><span class="type">"swept"</span></a> signal</td>
 103 </tr></tbody>
 104 </table></div>
 105 <p class="since">Since 1.8</p>
 106 </div>
 107 <hr>
 108 <div class="refsect2">
 109 <a name="ClutterSwipeDirection"></a><h3>enum ClutterSwipeDirection</h3>
 110 <pre class="programlisting">typedef enum {
 111  /*&lt; prefix=CLUTTER_SWIPE_DIRECTION &gt;*/
 112   CLUTTER_SWIPE_DIRECTION_UP    = 1 &lt;&lt; 0,
 113   CLUTTER_SWIPE_DIRECTION_DOWN  = 1 &lt;&lt; 1,
 114   CLUTTER_SWIPE_DIRECTION_LEFT  = 1 &lt;&lt; 2,
 115   CLUTTER_SWIPE_DIRECTION_RIGHT = 1 &lt;&lt; 3
 116 } ClutterSwipeDirection;
 117 </pre>
 118 <p>
 119 The main direction of the swipe gesture
 120 </p>
 121 <div class="variablelist"><table border="0">
 122 <col align="left" valign="top">
 123 <tbody>
 124 <tr>
 125 <td><p><a name="CLUTTER-SWIPE-DIRECTION-UP:CAPS"></a><span class="term"><code class="literal">CLUTTER_SWIPE_DIRECTION_UP</code></span></p></td>
 126 <td>Upwards swipe gesture
 127 </td>
 128 </tr>
 129 <tr>
 130 <td><p><a name="CLUTTER-SWIPE-DIRECTION-DOWN:CAPS"></a><span class="term"><code class="literal">CLUTTER_SWIPE_DIRECTION_DOWN</code></span></p></td>
 131 <td>Downwards swipe gesture
 132 </td>
 133 </tr>
 134 <tr>
 135 <td><p><a name="CLUTTER-SWIPE-DIRECTION-LEFT:CAPS"></a><span class="term"><code class="literal">CLUTTER_SWIPE_DIRECTION_LEFT</code></span></p></td>
 136 <td>Leftwards swipe gesture
 137 </td>
 138 </tr>
 139 <tr>
 140 <td><p><a name="CLUTTER-SWIPE-DIRECTION-RIGHT:CAPS"></a><span class="term"><code class="literal">CLUTTER_SWIPE_DIRECTION_RIGHT</code></span></p></td>
 141 <td>Rightwards swipe gesture
 142 </td>
 143 </tr>
 144 </tbody>
 145 </table></div>
 146 <p class="since">Since 1.8</p>
 147 </div>
 148 <hr>
 149 <div class="refsect2">
 150 <a name="clutter-swipe-action-new"></a><h3>clutter_swipe_action_new ()</h3>
 151 <pre class="programlisting"><a class="link" href="ClutterAction.html" title="ClutterAction"><span class="returnvalue">ClutterAction</span></a> *     clutter_swipe_action_new            (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 152 <p>
 153 Creates a new <a class="link" href="ClutterSwipeAction.html" title="ClutterSwipeAction"><span class="type">ClutterSwipeAction</span></a> instance
 154 </p>
 155 <div class="variablelist"><table border="0">
 156 <col align="left" valign="top">
 157 <tbody><tr>
 158 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 159 <td>the newly created <a class="link" href="ClutterSwipeAction.html" title="ClutterSwipeAction"><span class="type">ClutterSwipeAction</span></a>
 160 </td>
 161 </tr></tbody>
 162 </table></div>
 163 <p class="since">Since 1.8</p>
 164 </div>
 165 </div>
 166 <div class="refsect1">
 167 <a name="ClutterSwipeAction.signal-details"></a><h2>Signal Details</h2>
 168 <div class="refsect2">
 169 <a name="ClutterSwipeAction-swept"></a><h3>The <code class="literal">"swept"</code> signal</h3>
 170 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterSwipeAction.html" title="ClutterSwipeAction"><span class="type">ClutterSwipeAction</span></a>   *action,
 171                                                         <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>         *actor,
 172                                                         <a class="link" href="ClutterSwipeAction.html#ClutterSwipeDirection" title="enum ClutterSwipeDirection"><span class="type">ClutterSwipeDirection</span></a> direction,
 173                                                         <span class="type">gpointer</span>              user_data)      : <code class="literal">Run Last</code></pre>
 174 <p>
 175 The ::swept signal is emitted when a swipe gesture is recognized on the
 176 attached actor.
 177 </p>
 178 <div class="variablelist"><table border="0">
 179 <col align="left" valign="top">
 180 <tbody>
 181 <tr>
 182 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
 183 <td>the <a class="link" href="ClutterSwipeAction.html" title="ClutterSwipeAction"><span class="type">ClutterSwipeAction</span></a> that emitted the signal</td>
 184 </tr>
 185 <tr>
 186 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
 187 <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>
 188 </td>
 189 </tr>
 190 <tr>
 191 <td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
 192 <td>the main direction of the swipe gesture</td>
 193 </tr>
 194 <tr>
 195 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 196 <td>user data set when the signal handler was connected.</td>
 197 </tr>
 198 </tbody>
 199 </table></div>
 200 <p class="since">Since 1.8</p>
 201 </div>
 202 </div>
 203 </div>
 204 <div class="footer">
 205 <hr>
 206           Generated by GTK-Doc V1.18.1</div>
 207 </body>
 208 </html>