doc/reference/clutter/html/clutter-Events.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>Events</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="ch11.html" title="General purpose API">
   9 <link rel="prev" href="ClutterDeviceManager.html" title="ClutterDeviceManager">
  10 <link rel="next" href="clutter-Features.html" title="Features">
  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="ClutterDeviceManager.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch11.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="clutter-Features.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="#clutter-Events.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#clutter-Events.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="clutter-Events"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="clutter-Events.top_of_page"></a>Events</span></h2>
  34 <p>Events — User and window system events</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="clutter-Events.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">#define             <a class="link" href="clutter-Events.html#CLUTTER-CURRENT-TIME:CAPS" title="CLUTTER_CURRENT_TIME">CLUTTER_CURRENT_TIME</a>
  41 #define             <a class="link" href="clutter-Events.html#CLUTTER-PRIORITY-EVENTS:CAPS" title="CLUTTER_PRIORITY_EVENTS">CLUTTER_PRIORITY_EVENTS</a>
  42 #define             <a class="link" href="clutter-Events.html#CLUTTER-EVENT-PROPAGATE:CAPS" title="CLUTTER_EVENT_PROPAGATE">CLUTTER_EVENT_PROPAGATE</a>
  43 #define             <a class="link" href="clutter-Events.html#CLUTTER-EVENT-STOP:CAPS" title="CLUTTER_EVENT_STOP">CLUTTER_EVENT_STOP</a>
  44 enum                <a class="link" href="clutter-Events.html#ClutterModifierType" title="enum ClutterModifierType">ClutterModifierType</a>;
  45 enum                <a class="link" href="clutter-Events.html#ClutterScrollDirection" title="enum ClutterScrollDirection">ClutterScrollDirection</a>;
  46 enum                <a class="link" href="clutter-Events.html#ClutterStageState" title="enum ClutterStageState">ClutterStageState</a>;
  47 enum                <a class="link" href="clutter-Events.html#ClutterEventType" title="enum ClutterEventType">ClutterEventType</a>;
  48 union               <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent">ClutterEvent</a>;
  49 enum                <a class="link" href="clutter-Events.html#ClutterEventFlags" title="enum ClutterEventFlags">ClutterEventFlags</a>;
  50 struct              <a class="link" href="clutter-Events.html#ClutterButtonEvent" title="struct ClutterButtonEvent">ClutterButtonEvent</a>;
  51 struct              <a class="link" href="clutter-Events.html#ClutterKeyEvent" title="struct ClutterKeyEvent">ClutterKeyEvent</a>;
  52 struct              <a class="link" href="clutter-Events.html#ClutterMotionEvent" title="struct ClutterMotionEvent">ClutterMotionEvent</a>;
  53 struct              <a class="link" href="clutter-Events.html#ClutterScrollEvent" title="struct ClutterScrollEvent">ClutterScrollEvent</a>;
  54 struct              <a class="link" href="clutter-Events.html#ClutterStageStateEvent" title="struct ClutterStageStateEvent">ClutterStageStateEvent</a>;
  55 struct              <a class="link" href="clutter-Events.html#ClutterCrossingEvent" title="struct ClutterCrossingEvent">ClutterCrossingEvent</a>;
  56 struct              <a class="link" href="clutter-Events.html#ClutterTouchEvent" title="struct ClutterTouchEvent">ClutterTouchEvent</a>;
  57                     <a class="link" href="clutter-Events.html#ClutterEventSequence" title="ClutterEventSequence">ClutterEventSequence</a>;
  58 <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="returnvalue">ClutterEvent</span></a> *      <a class="link" href="clutter-Events.html#clutter-event-new" title="clutter_event_new ()">clutter_event_new</a>                   (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEventType" title="enum ClutterEventType"><span class="type">ClutterEventType</span></a> type</code></em>);
  59 <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="returnvalue">ClutterEvent</span></a> *      <a class="link" href="clutter-Events.html#clutter-event-copy" title="clutter_event_copy ()">clutter_event_copy</a>                  (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
  60 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-free" title="clutter_event_free ()">clutter_event_free</a>                  (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
  61 <a class="link" href="clutter-Events.html#ClutterEventType" title="enum ClutterEventType"><span class="returnvalue">ClutterEventType</span></a>    <a class="link" href="clutter-Events.html#clutter-event-type" title="clutter_event_type ()">clutter_event_type</a>                  (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
  62
  63 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-set-coords" title="clutter_event_set_coords ()">clutter_event_set_coords</a>            (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
  64                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> x</code></em>,
  65                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> y</code></em>);
  66 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-get-coords" title="clutter_event_get_coords ()">clutter_event_get_coords</a>            (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
  67                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> *x</code></em>,
  68                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> *y</code></em>);
  69 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-set-state" title="clutter_event_set_state ()">clutter_event_set_state</a>             (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
  70                                                          <em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterModifierType" title="enum ClutterModifierType"><span class="type">ClutterModifierType</span></a> state</code></em>);
  71 <a class="link" href="clutter-Events.html#ClutterModifierType" title="enum ClutterModifierType"><span class="returnvalue">ClutterModifierType</span></a> <a class="link" href="clutter-Events.html#clutter-event-get-state" title="clutter_event_get_state ()">clutter_event_get_state</a>             (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
  72 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-set-time" title="clutter_event_set_time ()">clutter_event_set_time</a>              (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
  73                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> time_</code></em>);
  74 <a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>             <a class="link" href="clutter-Events.html#clutter-event-get-time" title="clutter_event_get_time ()">clutter_event_get_time</a>              (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
  75 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-set-source" title="clutter_event_set_source ()">clutter_event_set_source</a>            (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
  76                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);
  77 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="clutter-Events.html#clutter-event-get-source" title="clutter_event_get_source ()">clutter_event_get_source</a>            (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
  78 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-set-stage" title="clutter_event_set_stage ()">clutter_event_set_stage</a>             (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
  79                                                          <em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
  80 <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *      <a class="link" href="clutter-Events.html#clutter-event-get-stage" title="clutter_event_get_stage ()">clutter_event_get_stage</a>             (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
  81 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-set-flags" title="clutter_event_set_flags ()">clutter_event_set_flags</a>             (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
  82                                                          <em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEventFlags" title="enum ClutterEventFlags"><span class="type">ClutterEventFlags</span></a> flags</code></em>);
  83 <a class="link" href="clutter-Events.html#ClutterEventFlags" title="enum ClutterEventFlags"><span class="returnvalue">ClutterEventFlags</span></a>   <a class="link" href="clutter-Events.html#clutter-event-get-flags" title="clutter_event_get_flags ()">clutter_event_get_flags</a>             (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
  84 <a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> *           <a class="link" href="clutter-Events.html#clutter-event-get-axes" title="clutter_event_get_axes ()">clutter_event_get_axes</a>              (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
  85                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *n_axes</code></em>);
  86 <a class="link" href="clutter-Events.html#ClutterEventSequence" title="ClutterEventSequence"><span class="returnvalue">ClutterEventSequence</span></a> * <a class="link" href="clutter-Events.html#clutter-event-get-event-sequence" title="clutter_event_get_event_sequence ()">clutter_event_get_event_sequence</a> (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
  87
  88 <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="returnvalue">ClutterEvent</span></a> *      <a class="link" href="clutter-Events.html#clutter-event-get" title="clutter_event_get ()">clutter_event_get</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
  89 <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="returnvalue">ClutterEvent</span></a> *      <a class="link" href="clutter-Events.html#clutter-event-peek" title="clutter_event_peek ()">clutter_event_peek</a>                  (<em class="parameter"><code><span class="type">void</span></code></em>);
  90 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-put" title="clutter_event_put ()">clutter_event_put</a>                   (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
  91 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="clutter-Events.html#clutter-events-pending" title="clutter_events_pending ()">clutter_events_pending</a>              (<em class="parameter"><code><span class="type">void</span></code></em>);
  92
  93 #define             <a class="link" href="clutter-Events.html#CLUTTER-BUTTON-PRIMARY:CAPS" title="CLUTTER_BUTTON_PRIMARY">CLUTTER_BUTTON_PRIMARY</a>
  94 #define             <a class="link" href="clutter-Events.html#CLUTTER-BUTTON-MIDDLE:CAPS" title="CLUTTER_BUTTON_MIDDLE">CLUTTER_BUTTON_MIDDLE</a>
  95 #define             <a class="link" href="clutter-Events.html#CLUTTER-BUTTON-SECONDARY:CAPS" title="CLUTTER_BUTTON_SECONDARY">CLUTTER_BUTTON_SECONDARY</a>
  96 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-set-button" title="clutter_event_set_button ()">clutter_event_set_button</a>            (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
  97                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> button</code></em>);
  98 <a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>             <a class="link" href="clutter-Events.html#clutter-event-get-button" title="clutter_event_get_button ()">clutter_event_get_button</a>            (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
  99 <a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="clutter-Events.html#clutter-event-get-click-count" title="clutter_event_get_click_count ()">clutter_event_get_click_count</a>       (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
 100
 101 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-set-key-symbol" title="clutter_event_set_key_symbol ()">clutter_event_set_key_symbol</a>        (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
 102                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> key_sym</code></em>);
 103 <a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="clutter-Events.html#clutter-event-get-key-symbol" title="clutter_event_get_key_symbol ()">clutter_event_get_key_symbol</a>        (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
 104 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-set-key-code" title="clutter_event_set_key_code ()">clutter_event_set_key_code</a>          (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
 105                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> key_code</code></em>);
 106 <a href="../glib/glib-Basic-Types.html#guint16"><span class="returnvalue">guint16</span></a>             <a class="link" href="clutter-Events.html#clutter-event-get-key-code" title="clutter_event_get_key_code ()">clutter_event_get_key_code</a>          (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
 107 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-set-key-unicode" title="clutter_event_set_key_unicode ()">clutter_event_set_key_unicode</a>       (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
 108                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> key_unicode</code></em>);
 109 <a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>             <a class="link" href="clutter-Events.html#clutter-event-get-key-unicode" title="clutter_event_get_key_unicode ()">clutter_event_get_key_unicode</a>       (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
 110 <a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>             <a class="link" href="clutter-Events.html#clutter-keysym-to-unicode" title="clutter_keysym_to_unicode ()">clutter_keysym_to_unicode</a>           (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>);
 111 <a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="clutter-Events.html#clutter-unicode-to-keysym" title="clutter_unicode_to_keysym ()">clutter_unicode_to_keysym</a>           (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> wc</code></em>);
 112
 113 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-set-related" title="clutter_event_set_related ()">clutter_event_set_related</a>           (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
 114                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);
 115 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="clutter-Events.html#clutter-event-get-related" title="clutter_event_get_related ()">clutter_event_get_related</a>           (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
 116
 117 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-set-scroll-direction" title="clutter_event_set_scroll_direction ()">clutter_event_set_scroll_direction</a>  (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
 118                                                          <em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterScrollDirection" title="enum ClutterScrollDirection"><span class="type">ClutterScrollDirection</span></a> direction</code></em>);
 119 <a class="link" href="clutter-Events.html#ClutterScrollDirection" title="enum ClutterScrollDirection"><span class="returnvalue">ClutterScrollDirection</span></a> <a class="link" href="clutter-Events.html#clutter-event-get-scroll-direction" title="clutter_event_get_scroll_direction ()">clutter_event_get_scroll_direction</a>
 120                                                         (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
 121 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-get-scroll-delta" title="clutter_event_get_scroll_delta ()">clutter_event_get_scroll_delta</a>      (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
 122                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *dx</code></em>,
 123                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *dy</code></em>);
 124 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-set-scroll-delta" title="clutter_event_set_scroll_delta ()">clutter_event_set_scroll_delta</a>      (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
 125                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> dx</code></em>,
 126                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> dy</code></em>);
 127
 128 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-set-device" title="clutter_event_set_device ()">clutter_event_set_device</a>            (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
 129                                                          <em class="parameter"><code><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> *device</code></em>);
 130 <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="returnvalue">ClutterInputDevice</span></a> * <a class="link" href="clutter-Events.html#clutter-event-get-device" title="clutter_event_get_device ()">clutter_event_get_device</a>           (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
 131 <span class="returnvalue">void</span>                <a class="link" href="clutter-Events.html#clutter-event-set-source-device" title="clutter_event_set_source_device ()">clutter_event_set_source_device</a>     (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
 132                                                          <em class="parameter"><code><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> *device</code></em>);
 133 <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="returnvalue">ClutterInputDevice</span></a> * <a class="link" href="clutter-Events.html#clutter-event-get-source-device" title="clutter_event_get_source_device ()">clutter_event_get_source_device</a>    (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
 134 <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="clutter-Events.html#clutter-event-get-device-id" title="clutter_event_get_device_id ()">clutter_event_get_device_id</a>         (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
 135 <a class="link" href="ClutterInputDevice.html#ClutterInputDeviceType" title="enum ClutterInputDeviceType"><span class="returnvalue">ClutterInputDeviceType</span></a> <a class="link" href="clutter-Events.html#clutter-event-get-device-type" title="clutter_event_get_device_type ()">clutter_event_get_device_type</a>    (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
 136
 137 <a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>             <a class="link" href="clutter-Events.html#clutter-get-current-event-time" title="clutter_get_current_event_time ()">clutter_get_current_event_time</a>      (<em class="parameter"><code><span class="type">void</span></code></em>);
 138 const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="returnvalue">ClutterEvent</span></a> * <a class="link" href="clutter-Events.html#clutter-get-current-event" title="clutter_get_current_event ()">clutter_get_current_event</a>          (<em class="parameter"><code><span class="type">void</span></code></em>);
 139 </pre>
 140 </div>
 141 <div class="refsect1">
 142 <a name="clutter-Events.description"></a><h2>Description</h2>
 143 <p>
 144 Windowing events handled by Clutter.
 145 </p>
 146 <p>
 147 The events usually come from the windowing backend, but can also
 148 be synthesized by Clutter itself or by the application code.
 149 </p>
 150 </div>
 151 <div class="refsect1">
 152 <a name="clutter-Events.details"></a><h2>Details</h2>
 153 <div class="refsect2">
 154 <a name="CLUTTER-CURRENT-TIME:CAPS"></a><h3>CLUTTER_CURRENT_TIME</h3>
 155 <pre class="programlisting">#define CLUTTER_CURRENT_TIME            (0L)
 156 </pre>
 157 <p>
 158 Default value for "now".
 159 </p>
 160 <p class="since">Since 0.4</p>
 161 </div>
 162 <hr>
 163 <div class="refsect2">
 164 <a name="CLUTTER-PRIORITY-EVENTS:CAPS"></a><h3>CLUTTER_PRIORITY_EVENTS</h3>
 165 <pre class="programlisting">#define CLUTTER_PRIORITY_EVENTS         (G_PRIORITY_DEFAULT)
 166 </pre>
 167 <p>
 168 Priority for event handling.
 169 </p>
 170 <p class="since">Since 0.4</p>
 171 </div>
 172 <hr>
 173 <div class="refsect2">
 174 <a name="CLUTTER-EVENT-PROPAGATE:CAPS"></a><h3>CLUTTER_EVENT_PROPAGATE</h3>
 175 <pre class="programlisting">#define CLUTTER_EVENT_PROPAGATE         (FALSE)
 176 </pre>
 177 <p>
 178 Continues the propagation of an event; this macro should be
 179 used in event-related signals.
 180 </p>
 181 <p class="since">Since 1.10</p>
 182 </div>
 183 <hr>
 184 <div class="refsect2">
 185 <a name="CLUTTER-EVENT-STOP:CAPS"></a><h3>CLUTTER_EVENT_STOP</h3>
 186 <pre class="programlisting">#define CLUTTER_EVENT_STOP              (TRUE)
 187 </pre>
 188 <p>
 189 Stops the propagattion of an event; this macro should be used
 190 in event-related signals.
 191 </p>
 192 <p class="since">Since 1.10</p>
 193 </div>
 194 <hr>
 195 <div class="refsect2">
 196 <a name="ClutterModifierType"></a><h3>enum ClutterModifierType</h3>
 197 <pre class="programlisting">typedef enum {
 198   CLUTTER_SHIFT_MASK    = 1 &lt;&lt; 0,
 199   CLUTTER_LOCK_MASK     = 1 &lt;&lt; 1,
 200   CLUTTER_CONTROL_MASK  = 1 &lt;&lt; 2,
 201   CLUTTER_MOD1_MASK     = 1 &lt;&lt; 3,
 202   CLUTTER_MOD2_MASK     = 1 &lt;&lt; 4,
 203   CLUTTER_MOD3_MASK     = 1 &lt;&lt; 5,
 204   CLUTTER_MOD4_MASK     = 1 &lt;&lt; 6,
 205   CLUTTER_MOD5_MASK     = 1 &lt;&lt; 7,
 206   CLUTTER_BUTTON1_MASK  = 1 &lt;&lt; 8,
 207   CLUTTER_BUTTON2_MASK  = 1 &lt;&lt; 9,
 208   CLUTTER_BUTTON3_MASK  = 1 &lt;&lt; 10,
 209   CLUTTER_BUTTON4_MASK  = 1 &lt;&lt; 11,
 210   CLUTTER_BUTTON5_MASK  = 1 &lt;&lt; 12,
 211
 212 #endif
 213
 214   CLUTTER_SUPER_MASK    = 1 &lt;&lt; 26,
 215   CLUTTER_HYPER_MASK    = 1 &lt;&lt; 27,
 216   CLUTTER_META_MASK     = 1 &lt;&lt; 28,
 217
 218 #endif
 219
 220   CLUTTER_RELEASE_MASK  = 1 &lt;&lt; 30,
 221
 222   /* Combination of CLUTTER_SHIFT_MASK..CLUTTER_BUTTON5_MASK + CLUTTER_SUPER_MASK
 223      + CLUTTER_HYPER_MASK + CLUTTER_META_MASK + CLUTTER_RELEASE_MASK */
 224   CLUTTER_MODIFIER_MASK = 0x5c001fff
 225 } ClutterModifierType;
 226 </pre>
 227 <p>
 228 Masks applied to a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> by modifiers.
 229 </p>
 230 <p>
 231 Note that Clutter may add internal values to events which include
 232 reserved values such as <code class="literal">CLUTTER_MODIFIER_RESERVED_13_MASK</code>.  Your code
 233 should preserve and ignore them.  You can use <a class="link" href="clutter-Events.html#CLUTTER-MODIFIER-MASK:CAPS"><code class="literal">CLUTTER_MODIFIER_MASK</code></a> to
 234 remove all reserved values.
 235 </p>
 236 <div class="variablelist"><table border="0">
 237 <col align="left" valign="top">
 238 <tbody>
 239 <tr>
 240 <td><p><a name="CLUTTER-SHIFT-MASK:CAPS"></a><span class="term"><code class="literal">CLUTTER_SHIFT_MASK</code></span></p></td>
 241 <td>Mask applied by the Shift key
 242 </td>
 243 </tr>
 244 <tr>
 245 <td><p><a name="CLUTTER-LOCK-MASK:CAPS"></a><span class="term"><code class="literal">CLUTTER_LOCK_MASK</code></span></p></td>
 246 <td>Mask applied by the Caps Lock key
 247 </td>
 248 </tr>
 249 <tr>
 250 <td><p><a name="CLUTTER-CONTROL-MASK:CAPS"></a><span class="term"><code class="literal">CLUTTER_CONTROL_MASK</code></span></p></td>
 251 <td>Mask applied by the Control key
 252 </td>
 253 </tr>
 254 <tr>
 255 <td><p><a name="CLUTTER-MOD1-MASK:CAPS"></a><span class="term"><code class="literal">CLUTTER_MOD1_MASK</code></span></p></td>
 256 <td>Mask applied by the first Mod key
 257 </td>
 258 </tr>
 259 <tr>
 260 <td><p><a name="CLUTTER-MOD2-MASK:CAPS"></a><span class="term"><code class="literal">CLUTTER_MOD2_MASK</code></span></p></td>
 261 <td>Mask applied by the second Mod key
 262 </td>
 263 </tr>
 264 <tr>
 265 <td><p><a name="CLUTTER-MOD3-MASK:CAPS"></a><span class="term"><code class="literal">CLUTTER_MOD3_MASK</code></span></p></td>
 266 <td>Mask applied by the third Mod key
 267 </td>
 268 </tr>
 269 <tr>
 270 <td><p><a name="CLUTTER-MOD4-MASK:CAPS"></a><span class="term"><code class="literal">CLUTTER_MOD4_MASK</code></span></p></td>
 271 <td>Mask applied by the fourth Mod key
 272 </td>
 273 </tr>
 274 <tr>
 275 <td><p><a name="CLUTTER-MOD5-MASK:CAPS"></a><span class="term"><code class="literal">CLUTTER_MOD5_MASK</code></span></p></td>
 276 <td>Mask applied by the fifth Mod key
 277 </td>
 278 </tr>
 279 <tr>
 280 <td><p><a name="CLUTTER-BUTTON1-MASK:CAPS"></a><span class="term"><code class="literal">CLUTTER_BUTTON1_MASK</code></span></p></td>
 281 <td>Mask applied by the first pointer button
 282 </td>
 283 </tr>
 284 <tr>
 285 <td><p><a name="CLUTTER-BUTTON2-MASK:CAPS"></a><span class="term"><code class="literal">CLUTTER_BUTTON2_MASK</code></span></p></td>
 286 <td>Mask applied by the second pointer button
 287 </td>
 288 </tr>
 289 <tr>
 290 <td><p><a name="CLUTTER-BUTTON3-MASK:CAPS"></a><span class="term"><code class="literal">CLUTTER_BUTTON3_MASK</code></span></p></td>
 291 <td>Mask applied by the third pointer button
 292 </td>
 293 </tr>
 294 <tr>
 295 <td><p><a name="CLUTTER-BUTTON4-MASK:CAPS"></a><span class="term"><code class="literal">CLUTTER_BUTTON4_MASK</code></span></p></td>
 296 <td>Mask applied by the fourth pointer button
 297 </td>
 298 </tr>
 299 <tr>
 300 <td><p><a name="CLUTTER-BUTTON5-MASK:CAPS"></a><span class="term"><code class="literal">CLUTTER_BUTTON5_MASK</code></span></p></td>
 301 <td>Mask applied by the fifth pointer button
 302 </td>
 303 </tr>
 304 <tr>
 305 <td><p><a name="CLUTTER-SUPER-MASK:CAPS"></a><span class="term"><code class="literal">CLUTTER_SUPER_MASK</code></span></p></td>
 306 <td>Mask applied by the Super key
 307 </td>
 308 </tr>
 309 <tr>
 310 <td><p><a name="CLUTTER-HYPER-MASK:CAPS"></a><span class="term"><code class="literal">CLUTTER_HYPER_MASK</code></span></p></td>
 311 <td>Mask applied by the Hyper key
 312 </td>
 313 </tr>
 314 <tr>
 315 <td><p><a name="CLUTTER-META-MASK:CAPS"></a><span class="term"><code class="literal">CLUTTER_META_MASK</code></span></p></td>
 316 <td>Mask applied by the Meta key
 317 </td>
 318 </tr>
 319 <tr>
 320 <td><p><a name="CLUTTER-RELEASE-MASK:CAPS"></a><span class="term"><code class="literal">CLUTTER_RELEASE_MASK</code></span></p></td>
 321 <td>Mask applied during release
 322 </td>
 323 </tr>
 324 <tr>
 325 <td><p><a name="CLUTTER-MODIFIER-MASK:CAPS"></a><span class="term"><code class="literal">CLUTTER_MODIFIER_MASK</code></span></p></td>
 326 <td>A mask covering all modifier types
 327 </td>
 328 </tr>
 329 </tbody>
 330 </table></div>
 331 <p class="since">Since 0.4</p>
 332 </div>
 333 <hr>
 334 <div class="refsect2">
 335 <a name="ClutterScrollDirection"></a><h3>enum ClutterScrollDirection</h3>
 336 <pre class="programlisting">typedef enum {
 337  /*&lt; prefix=CLUTTER_SCROLL &gt;*/
 338   CLUTTER_SCROLL_UP,
 339   CLUTTER_SCROLL_DOWN,
 340   CLUTTER_SCROLL_LEFT,
 341   CLUTTER_SCROLL_RIGHT,
 342   CLUTTER_SCROLL_SMOOTH
 343 } ClutterScrollDirection;
 344 </pre>
 345 <p>
 346 Direction of a pointer scroll event.
 347 </p>
 348 <p>
 349 The <a class="link" href="clutter-Events.html#CLUTTER-SCROLL-SMOOTH:CAPS"><code class="literal">CLUTTER_SCROLL_SMOOTH</code></a> value implies that the <a class="link" href="clutter-Events.html#ClutterScrollEvent" title="struct ClutterScrollEvent"><span class="type">ClutterScrollEvent</span></a>
 350 has precise scrolling delta information.
 351 </p>
 352 <div class="variablelist"><table border="0">
 353 <col align="left" valign="top">
 354 <tbody>
 355 <tr>
 356 <td><p><a name="CLUTTER-SCROLL-UP:CAPS"></a><span class="term"><code class="literal">CLUTTER_SCROLL_UP</code></span></p></td>
 357 <td>Scroll up
 358 </td>
 359 </tr>
 360 <tr>
 361 <td><p><a name="CLUTTER-SCROLL-DOWN:CAPS"></a><span class="term"><code class="literal">CLUTTER_SCROLL_DOWN</code></span></p></td>
 362 <td>Scroll down
 363 </td>
 364 </tr>
 365 <tr>
 366 <td><p><a name="CLUTTER-SCROLL-LEFT:CAPS"></a><span class="term"><code class="literal">CLUTTER_SCROLL_LEFT</code></span></p></td>
 367 <td>Scroll left
 368 </td>
 369 </tr>
 370 <tr>
 371 <td><p><a name="CLUTTER-SCROLL-RIGHT:CAPS"></a><span class="term"><code class="literal">CLUTTER_SCROLL_RIGHT</code></span></p></td>
 372 <td>Scroll right
 373 </td>
 374 </tr>
 375 <tr>
 376 <td><p><a name="CLUTTER-SCROLL-SMOOTH:CAPS"></a><span class="term"><code class="literal">CLUTTER_SCROLL_SMOOTH</code></span></p></td>
 377 <td>Precise scrolling delta (available in 1.10)
 378 </td>
 379 </tr>
 380 </tbody>
 381 </table></div>
 382 <p class="since">Since 0.4</p>
 383 </div>
 384 <hr>
 385 <div class="refsect2">
 386 <a name="ClutterStageState"></a><h3>enum ClutterStageState</h3>
 387 <pre class="programlisting">typedef enum {
 388   CLUTTER_STAGE_STATE_FULLSCREEN       = (1 &lt;&lt; 1),
 389   CLUTTER_STAGE_STATE_OFFSCREEN        = (1 &lt;&lt; 2),
 390   CLUTTER_STAGE_STATE_ACTIVATED        = (1 &lt;&lt; 3)
 391 } ClutterStageState;
 392 </pre>
 393 <p>
 394 Stage state masks, used by the <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> of type <a class="link" href="clutter-Events.html#CLUTTER-STAGE-STATE:CAPS"><code class="literal">CLUTTER_STAGE_STATE</code></a>.
 395 </p>
 396 <div class="variablelist"><table border="0">
 397 <col align="left" valign="top">
 398 <tbody>
 399 <tr>
 400 <td><p><a name="CLUTTER-STAGE-STATE-FULLSCREEN:CAPS"></a><span class="term"><code class="literal">CLUTTER_STAGE_STATE_FULLSCREEN</code></span></p></td>
 401 <td>Fullscreen mask
 402 </td>
 403 </tr>
 404 <tr>
 405 <td><p><a name="CLUTTER-STAGE-STATE-OFFSCREEN:CAPS"></a><span class="term"><code class="literal">CLUTTER_STAGE_STATE_OFFSCREEN</code></span></p></td>
 406 <td>Offscreen mask (deprecated)
 407 </td>
 408 </tr>
 409 <tr>
 410 <td><p><a name="CLUTTER-STAGE-STATE-ACTIVATED:CAPS"></a><span class="term"><code class="literal">CLUTTER_STAGE_STATE_ACTIVATED</code></span></p></td>
 411 <td>Activated mask
 412 </td>
 413 </tr>
 414 </tbody>
 415 </table></div>
 416 <p class="since">Since 0.4</p>
 417 </div>
 418 <hr>
 419 <div class="refsect2">
 420 <a name="ClutterEventType"></a><h3>enum ClutterEventType</h3>
 421 <pre class="programlisting">typedef enum {
 422  /*&lt; prefix=CLUTTER &gt;*/
 423   CLUTTER_NOTHING = 0,
 424   CLUTTER_KEY_PRESS,
 425   CLUTTER_KEY_RELEASE,
 426   CLUTTER_MOTION,
 427   CLUTTER_ENTER,
 428   CLUTTER_LEAVE,
 429   CLUTTER_BUTTON_PRESS,
 430   CLUTTER_BUTTON_RELEASE,
 431   CLUTTER_SCROLL,
 432   CLUTTER_STAGE_STATE,
 433   CLUTTER_DESTROY_NOTIFY,
 434   CLUTTER_CLIENT_MESSAGE,
 435   CLUTTER_DELETE,
 436   CLUTTER_TOUCH_BEGIN,
 437   CLUTTER_TOUCH_UPDATE,
 438   CLUTTER_TOUCH_END,
 439   CLUTTER_TOUCH_CANCEL,
 440
 441   CLUTTER_EVENT_LAST            /* helper */
 442 } ClutterEventType;
 443 </pre>
 444 <p>
 445 Types of events.
 446 </p>
 447 <div class="variablelist"><table border="0">
 448 <col align="left" valign="top">
 449 <tbody>
 450 <tr>
 451 <td><p><a name="CLUTTER-NOTHING:CAPS"></a><span class="term"><code class="literal">CLUTTER_NOTHING</code></span></p></td>
 452 <td>Empty event
 453 </td>
 454 </tr>
 455 <tr>
 456 <td><p><a name="CLUTTER-KEY-PRESS:CAPS"></a><span class="term"><code class="literal">CLUTTER_KEY_PRESS</code></span></p></td>
 457 <td>Key press event
 458 </td>
 459 </tr>
 460 <tr>
 461 <td><p><a name="CLUTTER-KEY-RELEASE:CAPS"></a><span class="term"><code class="literal">CLUTTER_KEY_RELEASE</code></span></p></td>
 462 <td>Key release event
 463 </td>
 464 </tr>
 465 <tr>
 466 <td><p><a name="CLUTTER-MOTION:CAPS"></a><span class="term"><code class="literal">CLUTTER_MOTION</code></span></p></td>
 467 <td>Pointer motion event
 468 </td>
 469 </tr>
 470 <tr>
 471 <td><p><a name="CLUTTER-ENTER:CAPS"></a><span class="term"><code class="literal">CLUTTER_ENTER</code></span></p></td>
 472 <td>Actor enter event
 473 </td>
 474 </tr>
 475 <tr>
 476 <td><p><a name="CLUTTER-LEAVE:CAPS"></a><span class="term"><code class="literal">CLUTTER_LEAVE</code></span></p></td>
 477 <td>Actor leave event
 478 </td>
 479 </tr>
 480 <tr>
 481 <td><p><a name="CLUTTER-BUTTON-PRESS:CAPS"></a><span class="term"><code class="literal">CLUTTER_BUTTON_PRESS</code></span></p></td>
 482 <td>Pointer button press event
 483 </td>
 484 </tr>
 485 <tr>
 486 <td><p><a name="CLUTTER-BUTTON-RELEASE:CAPS"></a><span class="term"><code class="literal">CLUTTER_BUTTON_RELEASE</code></span></p></td>
 487 <td>Pointer button release event
 488 </td>
 489 </tr>
 490 <tr>
 491 <td><p><a name="CLUTTER-SCROLL:CAPS"></a><span class="term"><code class="literal">CLUTTER_SCROLL</code></span></p></td>
 492 <td>Pointer scroll event
 493 </td>
 494 </tr>
 495 <tr>
 496 <td><p><a name="CLUTTER-STAGE-STATE:CAPS"></a><span class="term"><code class="literal">CLUTTER_STAGE_STATE</code></span></p></td>
 497 <td>Stage stage change event
 498 </td>
 499 </tr>
 500 <tr>
 501 <td><p><a name="CLUTTER-DESTROY-NOTIFY:CAPS"></a><span class="term"><code class="literal">CLUTTER_DESTROY_NOTIFY</code></span></p></td>
 502 <td>Destroy notification event
 503 </td>
 504 </tr>
 505 <tr>
 506 <td><p><a name="CLUTTER-CLIENT-MESSAGE:CAPS"></a><span class="term"><code class="literal">CLUTTER_CLIENT_MESSAGE</code></span></p></td>
 507 <td>Client message event
 508 </td>
 509 </tr>
 510 <tr>
 511 <td><p><a name="CLUTTER-DELETE:CAPS"></a><span class="term"><code class="literal">CLUTTER_DELETE</code></span></p></td>
 512 <td>Stage delete event
 513 </td>
 514 </tr>
 515 <tr>
 516 <td><p><a name="CLUTTER-TOUCH-BEGIN:CAPS"></a><span class="term"><code class="literal">CLUTTER_TOUCH_BEGIN</code></span></p></td>
 517 <td>A new touch event sequence has started;
 518   event added in 1.10
 519 </td>
 520 </tr>
 521 <tr>
 522 <td><p><a name="CLUTTER-TOUCH-UPDATE:CAPS"></a><span class="term"><code class="literal">CLUTTER_TOUCH_UPDATE</code></span></p></td>
 523 <td>A touch event sequence has been updated;
 524   event added in 1.10
 525 </td>
 526 </tr>
 527 <tr>
 528 <td><p><a name="CLUTTER-TOUCH-END:CAPS"></a><span class="term"><code class="literal">CLUTTER_TOUCH_END</code></span></p></td>
 529 <td>A touch event sequence has finished;
 530   event added in 1.10
 531 </td>
 532 </tr>
 533 <tr>
 534 <td><p><a name="CLUTTER-TOUCH-CANCEL:CAPS"></a><span class="term"><code class="literal">CLUTTER_TOUCH_CANCEL</code></span></p></td>
 535 <td>A touch event sequence has been canceled;
 536   event added in 1.10
 537 </td>
 538 </tr>
 539 <tr>
 540 <td><p><a name="CLUTTER-EVENT-LAST:CAPS"></a><span class="term"><code class="literal">CLUTTER_EVENT_LAST</code></span></p></td>
 541 <td>Marks the end of the <a class="link" href="clutter-Events.html#ClutterEventType" title="enum ClutterEventType"><span class="type">ClutterEventType</span></a> enumeration;
 542   added in 1.10
 543 </td>
 544 </tr>
 545 </tbody>
 546 </table></div>
 547 <p class="since">Since 0.4</p>
 548 </div>
 549 <hr>
 550 <div class="refsect2">
 551 <a name="ClutterEvent"></a><h3>union ClutterEvent</h3>
 552 <pre class="programlisting"></pre>
 553 <p>
 554 Generic event wrapper.
 555 </p>
 556 <p class="since">Since 0.2</p>
 557 </div>
 558 <hr>
 559 <div class="refsect2">
 560 <a name="ClutterEventFlags"></a><h3>enum ClutterEventFlags</h3>
 561 <pre class="programlisting">typedef enum {
 562  /*&lt; flags prefix=CLUTTER_EVENT &gt;*/
 563   CLUTTER_EVENT_NONE           = 0,
 564   CLUTTER_EVENT_FLAG_SYNTHETIC = 1 &lt;&lt; 0
 565 } ClutterEventFlags;
 566 </pre>
 567 <p>
 568 Flags for the <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
 569 </p>
 570 <div class="variablelist"><table border="0">
 571 <col align="left" valign="top">
 572 <tbody>
 573 <tr>
 574 <td><p><a name="CLUTTER-EVENT-NONE:CAPS"></a><span class="term"><code class="literal">CLUTTER_EVENT_NONE</code></span></p></td>
 575 <td>No flag set
 576 </td>
 577 </tr>
 578 <tr>
 579 <td><p><a name="CLUTTER-EVENT-FLAG-SYNTHETIC:CAPS"></a><span class="term"><code class="literal">CLUTTER_EVENT_FLAG_SYNTHETIC</code></span></p></td>
 580 <td>Synthetic event
 581 </td>
 582 </tr>
 583 </tbody>
 584 </table></div>
 585 <p class="since">Since 0.6</p>
 586 </div>
 587 <hr>
 588 <div class="refsect2">
 589 <a name="ClutterButtonEvent"></a><h3>struct ClutterButtonEvent</h3>
 590 <pre class="programlisting">struct ClutterButtonEvent {
 591   ClutterEventType type;
 592   guint32 time;
 593   ClutterEventFlags flags;
 594   ClutterStage *stage;
 595   ClutterActor *source;
 596
 597   gfloat x;
 598   gfloat y;
 599   ClutterModifierType modifier_state;
 600   guint32 button;
 601   guint click_count;
 602   gdouble *axes; /* Future use */
 603   ClutterInputDevice *device;
 604 };
 605 </pre>
 606 <p>
 607 Button event.
 608 </p>
 609 <p>
 610 The event coordinates are relative to the stage that received the
 611 event, and can be transformed into actor-relative coordinates by
 612 using <a class="link" href="ClutterActor.html#clutter-actor-transform-stage-point" title="clutter_actor_transform_stage_point ()"><code class="function">clutter_actor_transform_stage_point()</code></a>.
 613 </p>
 614 <div class="variablelist"><table border="0">
 615 <col align="left" valign="top">
 616 <tbody>
 617 <tr>
 618 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterEventType" title="enum ClutterEventType"><span class="type">ClutterEventType</span></a> <em class="structfield"><code><a name="ClutterButtonEvent.type"></a>type</code></em>;</span></p></td>
 619 <td>event type</td>
 620 </tr>
 621 <tr>
 622 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> <em class="structfield"><code><a name="ClutterButtonEvent.time"></a>time</code></em>;</span></p></td>
 623 <td>event time</td>
 624 </tr>
 625 <tr>
 626 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterEventFlags" title="enum ClutterEventFlags"><span class="type">ClutterEventFlags</span></a> <em class="structfield"><code><a name="ClutterButtonEvent.flags"></a>flags</code></em>;</span></p></td>
 627 <td>event flags</td>
 628 </tr>
 629 <tr>
 630 <td><p><span class="term"><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *<em class="structfield"><code><a name="ClutterButtonEvent.stage"></a>stage</code></em>;</span></p></td>
 631 <td>event source stage</td>
 632 </tr>
 633 <tr>
 634 <td><p><span class="term"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *<em class="structfield"><code><a name="ClutterButtonEvent.source"></a>source</code></em>;</span></p></td>
 635 <td>event source actor</td>
 636 </tr>
 637 <tr>
 638 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterButtonEvent.x"></a>x</code></em>;</span></p></td>
 639 <td>event X coordinate, relative to the stage</td>
 640 </tr>
 641 <tr>
 642 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterButtonEvent.y"></a>y</code></em>;</span></p></td>
 643 <td>event Y coordinate, relative to the stage</td>
 644 </tr>
 645 <tr>
 646 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterModifierType" title="enum ClutterModifierType"><span class="type">ClutterModifierType</span></a> <em class="structfield"><code><a name="ClutterButtonEvent.modifier-state"></a>modifier_state</code></em>;</span></p></td>
 647 <td>button modifiers</td>
 648 </tr>
 649 <tr>
 650 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> <em class="structfield"><code><a name="ClutterButtonEvent.button"></a>button</code></em>;</span></p></td>
 651 <td>event button</td>
 652 </tr>
 653 <tr>
 654 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="ClutterButtonEvent.click-count"></a>click_count</code></em>;</span></p></td>
 655 <td>number of button presses within the default time
 656 and radius</td>
 657 </tr>
 658 <tr>
 659 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *<em class="structfield"><code><a name="ClutterButtonEvent.axes"></a>axes</code></em>;</span></p></td>
 660 <td>reserved for future use</td>
 661 </tr>
 662 <tr>
 663 <td><p><span class="term"><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> *<em class="structfield"><code><a name="ClutterButtonEvent.device"></a>device</code></em>;</span></p></td>
 664 <td>reserved for future use</td>
 665 </tr>
 666 </tbody>
 667 </table></div>
 668 <p class="since">Since 0.2</p>
 669 </div>
 670 <hr>
 671 <div class="refsect2">
 672 <a name="ClutterKeyEvent"></a><h3>struct ClutterKeyEvent</h3>
 673 <pre class="programlisting">struct ClutterKeyEvent {
 674   ClutterEventType type;
 675   guint32 time;
 676   ClutterEventFlags flags;
 677   ClutterStage *stage;
 678   ClutterActor *source;
 679
 680   ClutterModifierType modifier_state;
 681   guint keyval;
 682   guint16 hardware_keycode;
 683   gunichar unicode_value;
 684   ClutterInputDevice *device;
 685 };
 686 </pre>
 687 <p>
 688 Key event
 689 </p>
 690 <div class="variablelist"><table border="0">
 691 <col align="left" valign="top">
 692 <tbody>
 693 <tr>
 694 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterEventType" title="enum ClutterEventType"><span class="type">ClutterEventType</span></a> <em class="structfield"><code><a name="ClutterKeyEvent.type"></a>type</code></em>;</span></p></td>
 695 <td>event type</td>
 696 </tr>
 697 <tr>
 698 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> <em class="structfield"><code><a name="ClutterKeyEvent.time"></a>time</code></em>;</span></p></td>
 699 <td>event time</td>
 700 </tr>
 701 <tr>
 702 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterEventFlags" title="enum ClutterEventFlags"><span class="type">ClutterEventFlags</span></a> <em class="structfield"><code><a name="ClutterKeyEvent.flags"></a>flags</code></em>;</span></p></td>
 703 <td>event flags</td>
 704 </tr>
 705 <tr>
 706 <td><p><span class="term"><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *<em class="structfield"><code><a name="ClutterKeyEvent.stage"></a>stage</code></em>;</span></p></td>
 707 <td>event source stage</td>
 708 </tr>
 709 <tr>
 710 <td><p><span class="term"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *<em class="structfield"><code><a name="ClutterKeyEvent.source"></a>source</code></em>;</span></p></td>
 711 <td>event source actor</td>
 712 </tr>
 713 <tr>
 714 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterModifierType" title="enum ClutterModifierType"><span class="type">ClutterModifierType</span></a> <em class="structfield"><code><a name="ClutterKeyEvent.modifier-state"></a>modifier_state</code></em>;</span></p></td>
 715 <td>key modifiers</td>
 716 </tr>
 717 <tr>
 718 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="ClutterKeyEvent.keyval"></a>keyval</code></em>;</span></p></td>
 719 <td>raw key value</td>
 720 </tr>
 721 <tr>
 722 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> <em class="structfield"><code><a name="ClutterKeyEvent.hardware-keycode"></a>hardware_keycode</code></em>;</span></p></td>
 723 <td>raw hardware key value</td>
 724 </tr>
 725 <tr>
 726 <td><p><span class="term"><a href="../glib/glib-Unicode-Manipulation.html#gunichar"><span class="type">gunichar</span></a> <em class="structfield"><code><a name="ClutterKeyEvent.unicode-value"></a>unicode_value</code></em>;</span></p></td>
 727 <td>Unicode representation</td>
 728 </tr>
 729 <tr>
 730 <td><p><span class="term"><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> *<em class="structfield"><code><a name="ClutterKeyEvent.device"></a>device</code></em>;</span></p></td>
 731 <td>reserved for future use</td>
 732 </tr>
 733 </tbody>
 734 </table></div>
 735 <p class="since">Since 0.2</p>
 736 </div>
 737 <hr>
 738 <div class="refsect2">
 739 <a name="ClutterMotionEvent"></a><h3>struct ClutterMotionEvent</h3>
 740 <pre class="programlisting">struct ClutterMotionEvent {
 741   ClutterEventType type;
 742   guint32 time;
 743   ClutterEventFlags flags;
 744   ClutterStage *stage;
 745   ClutterActor *source;
 746
 747   gfloat x;
 748   gfloat y;
 749   ClutterModifierType modifier_state;
 750   gdouble *axes; /* Future use */
 751   ClutterInputDevice *device;
 752 };
 753 </pre>
 754 <p>
 755 Event for the pointer motion
 756 </p>
 757 <div class="variablelist"><table border="0">
 758 <col align="left" valign="top">
 759 <tbody>
 760 <tr>
 761 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterEventType" title="enum ClutterEventType"><span class="type">ClutterEventType</span></a> <em class="structfield"><code><a name="ClutterMotionEvent.type"></a>type</code></em>;</span></p></td>
 762 <td>event type</td>
 763 </tr>
 764 <tr>
 765 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> <em class="structfield"><code><a name="ClutterMotionEvent.time"></a>time</code></em>;</span></p></td>
 766 <td>event time</td>
 767 </tr>
 768 <tr>
 769 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterEventFlags" title="enum ClutterEventFlags"><span class="type">ClutterEventFlags</span></a> <em class="structfield"><code><a name="ClutterMotionEvent.flags"></a>flags</code></em>;</span></p></td>
 770 <td>event flags</td>
 771 </tr>
 772 <tr>
 773 <td><p><span class="term"><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *<em class="structfield"><code><a name="ClutterMotionEvent.stage"></a>stage</code></em>;</span></p></td>
 774 <td>event source stage</td>
 775 </tr>
 776 <tr>
 777 <td><p><span class="term"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *<em class="structfield"><code><a name="ClutterMotionEvent.source"></a>source</code></em>;</span></p></td>
 778 <td>event source actor</td>
 779 </tr>
 780 <tr>
 781 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterMotionEvent.x"></a>x</code></em>;</span></p></td>
 782 <td>event X coordinate</td>
 783 </tr>
 784 <tr>
 785 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterMotionEvent.y"></a>y</code></em>;</span></p></td>
 786 <td>event Y coordinate</td>
 787 </tr>
 788 <tr>
 789 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterModifierType" title="enum ClutterModifierType"><span class="type">ClutterModifierType</span></a> <em class="structfield"><code><a name="ClutterMotionEvent.modifier-state"></a>modifier_state</code></em>;</span></p></td>
 790 <td>button modifiers</td>
 791 </tr>
 792 <tr>
 793 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *<em class="structfield"><code><a name="ClutterMotionEvent.axes"></a>axes</code></em>;</span></p></td>
 794 <td>reserved for future use</td>
 795 </tr>
 796 <tr>
 797 <td><p><span class="term"><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> *<em class="structfield"><code><a name="ClutterMotionEvent.device"></a>device</code></em>;</span></p></td>
 798 <td>reserved for future use</td>
 799 </tr>
 800 </tbody>
 801 </table></div>
 802 <p class="since">Since 0.2</p>
 803 </div>
 804 <hr>
 805 <div class="refsect2">
 806 <a name="ClutterScrollEvent"></a><h3>struct ClutterScrollEvent</h3>
 807 <pre class="programlisting">struct ClutterScrollEvent {
 808   ClutterEventType type;
 809   guint32 time;
 810   ClutterEventFlags flags;
 811   ClutterStage *stage;
 812   ClutterActor *source;
 813
 814   gfloat x;
 815   gfloat y;
 816   ClutterScrollDirection direction;
 817   ClutterModifierType modifier_state;
 818   gdouble *axes; /* future use */
 819   ClutterInputDevice *device;
 820 };
 821 </pre>
 822 <p>
 823 Scroll wheel (or similar device) event
 824 </p>
 825 <div class="variablelist"><table border="0">
 826 <col align="left" valign="top">
 827 <tbody>
 828 <tr>
 829 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterEventType" title="enum ClutterEventType"><span class="type">ClutterEventType</span></a> <em class="structfield"><code><a name="ClutterScrollEvent.type"></a>type</code></em>;</span></p></td>
 830 <td>event type</td>
 831 </tr>
 832 <tr>
 833 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> <em class="structfield"><code><a name="ClutterScrollEvent.time"></a>time</code></em>;</span></p></td>
 834 <td>event time</td>
 835 </tr>
 836 <tr>
 837 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterEventFlags" title="enum ClutterEventFlags"><span class="type">ClutterEventFlags</span></a> <em class="structfield"><code><a name="ClutterScrollEvent.flags"></a>flags</code></em>;</span></p></td>
 838 <td>event flags</td>
 839 </tr>
 840 <tr>
 841 <td><p><span class="term"><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *<em class="structfield"><code><a name="ClutterScrollEvent.stage"></a>stage</code></em>;</span></p></td>
 842 <td>event source stage</td>
 843 </tr>
 844 <tr>
 845 <td><p><span class="term"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *<em class="structfield"><code><a name="ClutterScrollEvent.source"></a>source</code></em>;</span></p></td>
 846 <td>event source actor</td>
 847 </tr>
 848 <tr>
 849 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterScrollEvent.x"></a>x</code></em>;</span></p></td>
 850 <td>event X coordinate</td>
 851 </tr>
 852 <tr>
 853 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterScrollEvent.y"></a>y</code></em>;</span></p></td>
 854 <td>event Y coordinate</td>
 855 </tr>
 856 <tr>
 857 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterScrollDirection" title="enum ClutterScrollDirection"><span class="type">ClutterScrollDirection</span></a> <em class="structfield"><code><a name="ClutterScrollEvent.direction"></a>direction</code></em>;</span></p></td>
 858 <td>direction of the scrolling</td>
 859 </tr>
 860 <tr>
 861 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterModifierType" title="enum ClutterModifierType"><span class="type">ClutterModifierType</span></a> <em class="structfield"><code><a name="ClutterScrollEvent.modifier-state"></a>modifier_state</code></em>;</span></p></td>
 862 <td>button modifiers</td>
 863 </tr>
 864 <tr>
 865 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *<em class="structfield"><code><a name="ClutterScrollEvent.axes"></a>axes</code></em>;</span></p></td>
 866 <td>reserved for future use</td>
 867 </tr>
 868 <tr>
 869 <td><p><span class="term"><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> *<em class="structfield"><code><a name="ClutterScrollEvent.device"></a>device</code></em>;</span></p></td>
 870 <td>reserved for future use</td>
 871 </tr>
 872 </tbody>
 873 </table></div>
 874 <p class="since">Since 0.2</p>
 875 </div>
 876 <hr>
 877 <div class="refsect2">
 878 <a name="ClutterStageStateEvent"></a><h3>struct ClutterStageStateEvent</h3>
 879 <pre class="programlisting">struct ClutterStageStateEvent {
 880   ClutterEventType type;
 881   guint32 time;
 882   ClutterEventFlags flags;
 883   ClutterStage *stage;
 884   ClutterActor *source; /* XXX: should probably be the stage itself */
 885
 886   ClutterStageState changed_mask;
 887   ClutterStageState new_state;
 888 };
 889 </pre>
 890 <p>
 891 Event signalling a change in the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> state.
 892 </p>
 893 <div class="variablelist"><table border="0">
 894 <col align="left" valign="top">
 895 <tbody>
 896 <tr>
 897 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterEventType" title="enum ClutterEventType"><span class="type">ClutterEventType</span></a> <em class="structfield"><code><a name="ClutterStageStateEvent.type"></a>type</code></em>;</span></p></td>
 898 <td>event type</td>
 899 </tr>
 900 <tr>
 901 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> <em class="structfield"><code><a name="ClutterStageStateEvent.time"></a>time</code></em>;</span></p></td>
 902 <td>event time</td>
 903 </tr>
 904 <tr>
 905 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterEventFlags" title="enum ClutterEventFlags"><span class="type">ClutterEventFlags</span></a> <em class="structfield"><code><a name="ClutterStageStateEvent.flags"></a>flags</code></em>;</span></p></td>
 906 <td>event flags</td>
 907 </tr>
 908 <tr>
 909 <td><p><span class="term"><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *<em class="structfield"><code><a name="ClutterStageStateEvent.stage"></a>stage</code></em>;</span></p></td>
 910 <td>event source stage</td>
 911 </tr>
 912 <tr>
 913 <td><p><span class="term"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *<em class="structfield"><code><a name="ClutterStageStateEvent.source"></a>source</code></em>;</span></p></td>
 914 <td>event source actor (unused)</td>
 915 </tr>
 916 <tr>
 917 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterStageState" title="enum ClutterStageState"><span class="type">ClutterStageState</span></a> <em class="structfield"><code><a name="ClutterStageStateEvent.changed-mask"></a>changed_mask</code></em>;</span></p></td>
 918 <td>bitwise OR of the changed flags</td>
 919 </tr>
 920 <tr>
 921 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterStageState" title="enum ClutterStageState"><span class="type">ClutterStageState</span></a> <em class="structfield"><code><a name="ClutterStageStateEvent.new-state"></a>new_state</code></em>;</span></p></td>
 922 <td>bitwise OR of the current state flags</td>
 923 </tr>
 924 </tbody>
 925 </table></div>
 926 <p class="since">Since 0.2</p>
 927 </div>
 928 <hr>
 929 <div class="refsect2">
 930 <a name="ClutterCrossingEvent"></a><h3>struct ClutterCrossingEvent</h3>
 931 <pre class="programlisting">struct ClutterCrossingEvent {
 932   ClutterEventType type;
 933   guint32 time;
 934   ClutterEventFlags flags;
 935   ClutterStage *stage;
 936   ClutterActor *source;
 937
 938   gfloat x;
 939   gfloat y;
 940   ClutterInputDevice *device;
 941   ClutterActor *related;
 942 };
 943 </pre>
 944 <p>
 945 Event for the movement of the pointer across different actors
 946 </p>
 947 <div class="variablelist"><table border="0">
 948 <col align="left" valign="top">
 949 <tbody>
 950 <tr>
 951 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterEventType" title="enum ClutterEventType"><span class="type">ClutterEventType</span></a> <em class="structfield"><code><a name="ClutterCrossingEvent.type"></a>type</code></em>;</span></p></td>
 952 <td>event type</td>
 953 </tr>
 954 <tr>
 955 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> <em class="structfield"><code><a name="ClutterCrossingEvent.time"></a>time</code></em>;</span></p></td>
 956 <td>event time</td>
 957 </tr>
 958 <tr>
 959 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterEventFlags" title="enum ClutterEventFlags"><span class="type">ClutterEventFlags</span></a> <em class="structfield"><code><a name="ClutterCrossingEvent.flags"></a>flags</code></em>;</span></p></td>
 960 <td>event flags</td>
 961 </tr>
 962 <tr>
 963 <td><p><span class="term"><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *<em class="structfield"><code><a name="ClutterCrossingEvent.stage"></a>stage</code></em>;</span></p></td>
 964 <td>event source stage</td>
 965 </tr>
 966 <tr>
 967 <td><p><span class="term"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *<em class="structfield"><code><a name="ClutterCrossingEvent.source"></a>source</code></em>;</span></p></td>
 968 <td>event source actor</td>
 969 </tr>
 970 <tr>
 971 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterCrossingEvent.x"></a>x</code></em>;</span></p></td>
 972 <td>event X coordinate</td>
 973 </tr>
 974 <tr>
 975 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterCrossingEvent.y"></a>y</code></em>;</span></p></td>
 976 <td>event Y coordinate</td>
 977 </tr>
 978 <tr>
 979 <td><p><span class="term"><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> *<em class="structfield"><code><a name="ClutterCrossingEvent.device"></a>device</code></em>;</span></p></td>
 980 <td>reserved for future use</td>
 981 </tr>
 982 <tr>
 983 <td><p><span class="term"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *<em class="structfield"><code><a name="ClutterCrossingEvent.related"></a>related</code></em>;</span></p></td>
 984 <td>actor related to the crossing</td>
 985 </tr>
 986 </tbody>
 987 </table></div>
 988 <p class="since">Since 0.2</p>
 989 </div>
 990 <hr>
 991 <div class="refsect2">
 992 <a name="ClutterTouchEvent"></a><h3>struct ClutterTouchEvent</h3>
 993 <pre class="programlisting">struct ClutterTouchEvent {
 994   ClutterEventType type;
 995   guint32 time;
 996   ClutterEventFlags flags;
 997   ClutterStage *stage;
 998   ClutterActor *source;
 999
1000   gfloat x;
1001   gfloat y;
1002   ClutterEventSequence *sequence;
1003   ClutterModifierType modifier_state;
1004   gdouble *axes; /* reserved */
1005   ClutterInputDevice *device;
1006 };
1007 </pre>
1008 <p>
1009 Used for touch events.
1010 </p>
1011 <p>
1012 The <em class="parameter"><code>type</code></em> field will be one of <a class="link" href="clutter-Events.html#CLUTTER-TOUCH-BEGIN:CAPS"><code class="literal">CLUTTER_TOUCH_BEGIN</code></a>, <a class="link" href="clutter-Events.html#CLUTTER-TOUCH-END:CAPS"><code class="literal">CLUTTER_TOUCH_END</code></a>,
1013 <a class="link" href="clutter-Events.html#CLUTTER-TOUCH-UPDATE:CAPS"><code class="literal">CLUTTER_TOUCH_UPDATE</code></a>, or <a class="link" href="clutter-Events.html#CLUTTER-TOUCH-CANCEL:CAPS"><code class="literal">CLUTTER_TOUCH_CANCEL</code></a>.
1014 </p>
1015 <p>
1016 Touch events are grouped into sequences; each touch sequence will begin
1017 with a <a class="link" href="clutter-Events.html#CLUTTER-TOUCH-BEGIN:CAPS"><code class="literal">CLUTTER_TOUCH_BEGIN</code></a> event, progress with <a class="link" href="clutter-Events.html#CLUTTER-TOUCH-UPDATE:CAPS"><code class="literal">CLUTTER_TOUCH_UPDATE</code></a>
1018 events, and end either with a <a class="link" href="clutter-Events.html#CLUTTER-TOUCH-END:CAPS"><code class="literal">CLUTTER_TOUCH_END</code></a> event or with a
1019 <a class="link" href="clutter-Events.html#CLUTTER-TOUCH-CANCEL:CAPS"><code class="literal">CLUTTER_TOUCH_CANCEL</code></a> event.
1020 </p>
1021 <p>
1022 With multi-touch capable devices there can be multiple event sequence
1023 running at the same time.
1024 </p>
1025 <div class="variablelist"><table border="0">
1026 <col align="left" valign="top">
1027 <tbody>
1028 <tr>
1029 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterEventType" title="enum ClutterEventType"><span class="type">ClutterEventType</span></a> <em class="structfield"><code><a name="ClutterTouchEvent.type"></a>type</code></em>;</span></p></td>
1030 <td>event type</td>
1031 </tr>
1032 <tr>
1033 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> <em class="structfield"><code><a name="ClutterTouchEvent.time"></a>time</code></em>;</span></p></td>
1034 <td>event time</td>
1035 </tr>
1036 <tr>
1037 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterEventFlags" title="enum ClutterEventFlags"><span class="type">ClutterEventFlags</span></a> <em class="structfield"><code><a name="ClutterTouchEvent.flags"></a>flags</code></em>;</span></p></td>
1038 <td>event flags</td>
1039 </tr>
1040 <tr>
1041 <td><p><span class="term"><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *<em class="structfield"><code><a name="ClutterTouchEvent.stage"></a>stage</code></em>;</span></p></td>
1042 <td>event source stage</td>
1043 </tr>
1044 <tr>
1045 <td><p><span class="term"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *<em class="structfield"><code><a name="ClutterTouchEvent.source"></a>source</code></em>;</span></p></td>
1046 <td>event source actor (unused)</td>
1047 </tr>
1048 <tr>
1049 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterTouchEvent.x"></a>x</code></em>;</span></p></td>
1050 <td>the X coordinate of the pointer, relative to the stage</td>
1051 </tr>
1052 <tr>
1053 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterTouchEvent.y"></a>y</code></em>;</span></p></td>
1054 <td>the Y coordinate of the pointer, relative to the stage</td>
1055 </tr>
1056 <tr>
1057 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterEventSequence" title="ClutterEventSequence"><span class="type">ClutterEventSequence</span></a> *<em class="structfield"><code><a name="ClutterTouchEvent.sequence"></a>sequence</code></em>;</span></p></td>
1058 <td>the event sequence that this event belongs to</td>
1059 </tr>
1060 <tr>
1061 <td><p><span class="term"><a class="link" href="clutter-Events.html#ClutterModifierType" title="enum ClutterModifierType"><span class="type">ClutterModifierType</span></a> <em class="structfield"><code><a name="ClutterTouchEvent.modifier-state"></a>modifier_state</code></em>;</span></p></td>
1062 <td>a bit-mask representing the state
1063 of modifier keys (e.g. Control, Shift, and Alt) and the pointer
1064 buttons. See <a class="link" href="clutter-Events.html#ClutterModifierType" title="enum ClutterModifierType"><span class="type">ClutterModifierType</span></a>. <span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> ClutterModifierType]</span>
1065 </td>
1066 </tr>
1067 <tr>
1068 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *<em class="structfield"><code><a name="ClutterTouchEvent.axes"></a>axes</code></em>;</span></p></td>
1069 <td>reserved</td>
1070 </tr>
1071 <tr>
1072 <td><p><span class="term"><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> *<em class="structfield"><code><a name="ClutterTouchEvent.device"></a>device</code></em>;</span></p></td>
1073 <td>the device that originated the event</td>
1074 </tr>
1075 </tbody>
1076 </table></div>
1077 <p class="since">Since 1.10</p>
1078 </div>
1079 <hr>
1080 <div class="refsect2">
1081 <a name="ClutterEventSequence"></a><h3>ClutterEventSequence</h3>
1082 <pre class="programlisting">typedef struct _ClutterEventSequence ClutterEventSequence;</pre>
1083 </div>
1084 <hr>
1085 <div class="refsect2">
1086 <a name="clutter-event-new"></a><h3>clutter_event_new ()</h3>
1087 <pre class="programlisting"><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="returnvalue">ClutterEvent</span></a> *      clutter_event_new                   (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEventType" title="enum ClutterEventType"><span class="type">ClutterEventType</span></a> type</code></em>);</pre>
1088 <p>
1089 Creates a new <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> of the specified type.
1090 </p>
1091 <div class="variablelist"><table border="0">
1092 <col align="left" valign="top">
1093 <tbody>
1094 <tr>
1095 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
1096 <td>The type of event.</td>
1097 </tr>
1098 <tr>
1099 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1100 <td>A newly allocated <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
1101 </td>
1102 </tr>
1103 </tbody>
1104 </table></div>
1105 </div>
1106 <hr>
1107 <div class="refsect2">
1108 <a name="clutter-event-copy"></a><h3>clutter_event_copy ()</h3>
1109 <pre class="programlisting"><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="returnvalue">ClutterEvent</span></a> *      clutter_event_copy                  (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
1110 <p>
1111 Copies <em class="parameter"><code>event</code></em>.
1112 </p>
1113 <div class="variablelist"><table border="0">
1114 <col align="left" valign="top">
1115 <tbody>
1116 <tr>
1117 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1118 <td>A <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>.</td>
1119 </tr>
1120 <tr>
1121 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1122 <td>A newly allocated <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
1123 </td>
1124 </tr>
1125 </tbody>
1126 </table></div>
1127 </div>
1128 <hr>
1129 <div class="refsect2">
1130 <a name="clutter-event-free"></a><h3>clutter_event_free ()</h3>
1131 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_free                  (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
1132 <p>
1133 Frees all resources used by <em class="parameter"><code>event</code></em>.
1134 </p>
1135 <div class="variablelist"><table border="0">
1136 <col align="left" valign="top">
1137 <tbody><tr>
1138 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1139 <td>A <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>.</td>
1140 </tr></tbody>
1141 </table></div>
1142 </div>
1143 <hr>
1144 <div class="refsect2">
1145 <a name="clutter-event-type"></a><h3>clutter_event_type ()</h3>
1146 <pre class="programlisting"><a class="link" href="clutter-Events.html#ClutterEventType" title="enum ClutterEventType"><span class="returnvalue">ClutterEventType</span></a>    clutter_event_type                  (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
1147 <p>
1148 Retrieves the type of the event.
1149 </p>
1150 <div class="variablelist"><table border="0">
1151 <col align="left" valign="top">
1152 <tbody>
1153 <tr>
1154 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1155 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
1156 </td>
1157 </tr>
1158 <tr>
1159 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1160 <td>a <a class="link" href="clutter-Events.html#ClutterEventType" title="enum ClutterEventType"><span class="type">ClutterEventType</span></a>
1161 </td>
1162 </tr>
1163 </tbody>
1164 </table></div>
1165 </div>
1166 <hr>
1167 <div class="refsect2">
1168 <a name="clutter-event-set-coords"></a><h3>clutter_event_set_coords ()</h3>
1169 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_set_coords            (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
1170                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> x</code></em>,
1171                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> y</code></em>);</pre>
1172 <p>
1173 Sets the coordinates of the <em class="parameter"><code>event</code></em>.
1174 </p>
1175 <div class="variablelist"><table border="0">
1176 <col align="left" valign="top">
1177 <tbody>
1178 <tr>
1179 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1180 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
1181 </td>
1182 </tr>
1183 <tr>
1184 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
1185 <td>the X coordinate of the event</td>
1186 </tr>
1187 <tr>
1188 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
1189 <td>the Y coordinate of the event</td>
1190 </tr>
1191 </tbody>
1192 </table></div>
1193 <p class="since">Since 1.8</p>
1194 </div>
1195 <hr>
1196 <div class="refsect2">
1197 <a name="clutter-event-get-coords"></a><h3>clutter_event_get_coords ()</h3>
1198 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_get_coords            (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
1199                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> *x</code></em>,
1200                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> *y</code></em>);</pre>
1201 <p>
1202 Retrieves the coordinates of <em class="parameter"><code>event</code></em> and puts them into <em class="parameter"><code>x</code></em> and <em class="parameter"><code>y</code></em>.
1203 </p>
1204 <div class="variablelist"><table border="0">
1205 <col align="left" valign="top">
1206 <tbody>
1207 <tr>
1208 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1209 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
1210 </td>
1211 </tr>
1212 <tr>
1213 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
1214 <td>return location for the X coordinate, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
1215 </td>
1216 </tr>
1217 <tr>
1218 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
1219 <td>return location for the Y coordinate, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
1220 </td>
1221 </tr>
1222 </tbody>
1223 </table></div>
1224 <p class="since">Since 0.4</p>
1225 </div>
1226 <hr>
1227 <div class="refsect2">
1228 <a name="clutter-event-set-state"></a><h3>clutter_event_set_state ()</h3>
1229 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_set_state             (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
1230                                                          <em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterModifierType" title="enum ClutterModifierType"><span class="type">ClutterModifierType</span></a> state</code></em>);</pre>
1231 <p>
1232 Sets the modifier state of the event.
1233 </p>
1234 <div class="variablelist"><table border="0">
1235 <col align="left" valign="top">
1236 <tbody>
1237 <tr>
1238 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1239 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
1240 </td>
1241 </tr>
1242 <tr>
1243 <td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
1244 <td>the modifier state to set</td>
1245 </tr>
1246 </tbody>
1247 </table></div>
1248 <p class="since">Since 1.8</p>
1249 </div>
1250 <hr>
1251 <div class="refsect2">
1252 <a name="clutter-event-get-state"></a><h3>clutter_event_get_state ()</h3>
1253 <pre class="programlisting"><a class="link" href="clutter-Events.html#ClutterModifierType" title="enum ClutterModifierType"><span class="returnvalue">ClutterModifierType</span></a> clutter_event_get_state             (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
1254 <p>
1255 Retrieves the modifier state of the event.
1256 </p>
1257 <div class="variablelist"><table border="0">
1258 <col align="left" valign="top">
1259 <tbody>
1260 <tr>
1261 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1262 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
1263 </td>
1264 </tr>
1265 <tr>
1266 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1267 <td>the modifier state parameter, or 0</td>
1268 </tr>
1269 </tbody>
1270 </table></div>
1271 <p class="since">Since 0.4</p>
1272 </div>
1273 <hr>
1274 <div class="refsect2">
1275 <a name="clutter-event-set-time"></a><h3>clutter_event_set_time ()</h3>
1276 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_set_time              (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
1277                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> time_</code></em>);</pre>
1278 <p>
1279 Sets the time of the event.
1280 </p>
1281 <div class="variablelist"><table border="0">
1282 <col align="left" valign="top">
1283 <tbody>
1284 <tr>
1285 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1286 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
1287 </td>
1288 </tr>
1289 <tr>
1290 <td><p><span class="term"><em class="parameter"><code>time_</code></em> :</span></p></td>
1291 <td>the time of the event</td>
1292 </tr>
1293 </tbody>
1294 </table></div>
1295 <p class="since">Since 1.8</p>
1296 </div>
1297 <hr>
1298 <div class="refsect2">
1299 <a name="clutter-event-get-time"></a><h3>clutter_event_get_time ()</h3>
1300 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>             clutter_event_get_time              (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
1301 <p>
1302 Retrieves the time of the event.
1303 </p>
1304 <div class="variablelist"><table border="0">
1305 <col align="left" valign="top">
1306 <tbody>
1307 <tr>
1308 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1309 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
1310 </td>
1311 </tr>
1312 <tr>
1313 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1314 <td>the time of the event, or <a class="link" href="clutter-Events.html#CLUTTER-CURRENT-TIME:CAPS" title="CLUTTER_CURRENT_TIME"><code class="literal">CLUTTER_CURRENT_TIME</code></a>
1315 </td>
1316 </tr>
1317 </tbody>
1318 </table></div>
1319 <p class="since">Since 0.4</p>
1320 </div>
1321 <hr>
1322 <div class="refsect2">
1323 <a name="clutter-event-set-source"></a><h3>clutter_event_set_source ()</h3>
1324 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_set_source            (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
1325                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);</pre>
1326 <p>
1327 Sets the source <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> of <em class="parameter"><code>event</code></em>.
1328 </p>
1329 <div class="variablelist"><table border="0">
1330 <col align="left" valign="top">
1331 <tbody>
1332 <tr>
1333 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1334 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
1335 </td>
1336 </tr>
1337 <tr>
1338 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
1339 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1340 </td>
1341 </tr>
1342 </tbody>
1343 </table></div>
1344 <p class="since">Since 1.8</p>
1345 </div>
1346 <hr>
1347 <div class="refsect2">
1348 <a name="clutter-event-get-source"></a><h3>clutter_event_get_source ()</h3>
1349 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_event_get_source            (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
1350 <p>
1351 Retrieves the source <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> the event originated from, or
1352 NULL if the event has no source.
1353 </p>
1354 <div class="variablelist"><table border="0">
1355 <col align="left" valign="top">
1356 <tbody>
1357 <tr>
1358 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1359 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
1360 </td>
1361 </tr>
1362 <tr>
1363 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1364 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
1365 </td>
1366 </tr>
1367 </tbody>
1368 </table></div>
1369 <p class="since">Since 0.6</p>
1370 </div>
1371 <hr>
1372 <div class="refsect2">
1373 <a name="clutter-event-set-stage"></a><h3>clutter_event_set_stage ()</h3>
1374 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_set_stage             (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
1375                                                          <em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
1376 <p>
1377 Sets the source <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> of the event.
1378 </p>
1379 <div class="variablelist"><table border="0">
1380 <col align="left" valign="top">
1381 <tbody>
1382 <tr>
1383 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1384 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
1385 </td>
1386 </tr>
1387 <tr>
1388 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1389 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1390 </td>
1391 </tr>
1392 </tbody>
1393 </table></div>
1394 <p class="since">Since 1.8</p>
1395 </div>
1396 <hr>
1397 <div class="refsect2">
1398 <a name="clutter-event-get-stage"></a><h3>clutter_event_get_stage ()</h3>
1399 <pre class="programlisting"><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *      clutter_event_get_stage             (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
1400 <p>
1401 Retrieves the source <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> the event originated for, or
1402 <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if the event has no stage.
1403 </p>
1404 <div class="variablelist"><table border="0">
1405 <col align="left" valign="top">
1406 <tbody>
1407 <tr>
1408 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1409 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
1410 </td>
1411 </tr>
1412 <tr>
1413 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1414 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
1415 </td>
1416 </tr>
1417 </tbody>
1418 </table></div>
1419 <p class="since">Since 0.8</p>
1420 </div>
1421 <hr>
1422 <div class="refsect2">
1423 <a name="clutter-event-set-flags"></a><h3>clutter_event_set_flags ()</h3>
1424 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_set_flags             (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
1425                                                          <em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEventFlags" title="enum ClutterEventFlags"><span class="type">ClutterEventFlags</span></a> flags</code></em>);</pre>
1426 <p>
1427 Sets the <a class="link" href="clutter-Events.html#ClutterEventFlags" title="enum ClutterEventFlags"><span class="type">ClutterEventFlags</span></a> of <em class="parameter"><code>event</code></em>
1428 </p>
1429 <div class="variablelist"><table border="0">
1430 <col align="left" valign="top">
1431 <tbody>
1432 <tr>
1433 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1434 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
1435 </td>
1436 </tr>
1437 <tr>
1438 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
1439 <td>a binary OR of <a class="link" href="clutter-Events.html#ClutterEventFlags" title="enum ClutterEventFlags"><span class="type">ClutterEventFlags</span></a> values</td>
1440 </tr>
1441 </tbody>
1442 </table></div>
1443 <p class="since">Since 1.8</p>
1444 </div>
1445 <hr>
1446 <div class="refsect2">
1447 <a name="clutter-event-get-flags"></a><h3>clutter_event_get_flags ()</h3>
1448 <pre class="programlisting"><a class="link" href="clutter-Events.html#ClutterEventFlags" title="enum ClutterEventFlags"><span class="returnvalue">ClutterEventFlags</span></a>   clutter_event_get_flags             (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
1449 <p>
1450 Retrieves the <a class="link" href="clutter-Events.html#ClutterEventFlags" title="enum ClutterEventFlags"><span class="type">ClutterEventFlags</span></a> of <em class="parameter"><code>event</code></em>
1451 </p>
1452 <div class="variablelist"><table border="0">
1453 <col align="left" valign="top">
1454 <tbody>
1455 <tr>
1456 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1457 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
1458 </td>
1459 </tr>
1460 <tr>
1461 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1462 <td>the event flags</td>
1463 </tr>
1464 </tbody>
1465 </table></div>
1466 <p class="since">Since 1.0</p>
1467 </div>
1468 <hr>
1469 <div class="refsect2">
1470 <a name="clutter-event-get-axes"></a><h3>clutter_event_get_axes ()</h3>
1471 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> *           clutter_event_get_axes              (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
1472                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *n_axes</code></em>);</pre>
1473 <p>
1474 Retrieves the array of axes values attached to the event.
1475 </p>
1476 <div class="variablelist"><table border="0">
1477 <col align="left" valign="top">
1478 <tbody>
1479 <tr>
1480 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1481 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
1482 </td>
1483 </tr>
1484 <tr>
1485 <td><p><span class="term"><em class="parameter"><code>n_axes</code></em> :</span></p></td>
1486 <td>return location for the number of axes returned. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
1487 </td>
1488 </tr>
1489 <tr>
1490 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1491 <td>an array of axis values. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
1492 </td>
1493 </tr>
1494 </tbody>
1495 </table></div>
1496 <p class="since">Since 1.6</p>
1497 </div>
1498 <hr>
1499 <div class="refsect2">
1500 <a name="clutter-event-get-event-sequence"></a><h3>clutter_event_get_event_sequence ()</h3>
1501 <pre class="programlisting"><a class="link" href="clutter-Events.html#ClutterEventSequence" title="ClutterEventSequence"><span class="returnvalue">ClutterEventSequence</span></a> * clutter_event_get_event_sequence (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
1502 <p>
1503 Retrieves the <a class="link" href="clutter-Events.html#ClutterEventSequence" title="ClutterEventSequence"><span class="type">ClutterEventSequence</span></a> of <em class="parameter"><code>event</code></em>.
1504 </p>
1505 <div class="variablelist"><table border="0">
1506 <col align="left" valign="top">
1507 <tbody>
1508 <tr>
1509 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1510 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> of type <a class="link" href="clutter-Events.html#CLUTTER-TOUCH-BEGIN:CAPS"><code class="literal">CLUTTER_TOUCH_BEGIN</code></a>,
1511 <a class="link" href="clutter-Events.html#CLUTTER-TOUCH-UPDATE:CAPS"><code class="literal">CLUTTER_TOUCH_UPDATE</code></a>, <a class="link" href="clutter-Events.html#CLUTTER-TOUCH-END:CAPS"><code class="literal">CLUTTER_TOUCH_END</code></a>, or
1512 <a class="link" href="clutter-Events.html#CLUTTER-TOUCH-CANCEL:CAPS"><code class="literal">CLUTTER_TOUCH_CANCEL</code></a>
1513 </td>
1514 </tr>
1515 <tr>
1516 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1517 <td>the event sequence, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
1518 </td>
1519 </tr>
1520 </tbody>
1521 </table></div>
1522 <p class="since">Since 1.10</p>
1523 </div>
1524 <hr>
1525 <div class="refsect2">
1526 <a name="clutter-event-get"></a><h3>clutter_event_get ()</h3>
1527 <pre class="programlisting"><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="returnvalue">ClutterEvent</span></a> *      clutter_event_get                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
1528 <p>
1529 Pops an event off the event queue. Applications should not need to call
1530 this.
1531 </p>
1532 <div class="variablelist"><table border="0">
1533 <col align="left" valign="top">
1534 <tbody><tr>
1535 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1536 <td>A <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> or NULL if queue empty</td>
1537 </tr></tbody>
1538 </table></div>
1539 <p class="since">Since 0.4</p>
1540 </div>
1541 <hr>
1542 <div class="refsect2">
1543 <a name="clutter-event-peek"></a><h3>clutter_event_peek ()</h3>
1544 <pre class="programlisting"><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="returnvalue">ClutterEvent</span></a> *      clutter_event_peek                  (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
1545 <p>
1546 Returns a pointer to the first event from the event queue but
1547 does not remove it.
1548 </p>
1549 <div class="variablelist"><table border="0">
1550 <col align="left" valign="top">
1551 <tbody><tr>
1552 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1553 <td>A <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> or NULL if queue empty. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
1554 </td>
1555 </tr></tbody>
1556 </table></div>
1557 <p class="since">Since 0.4</p>
1558 </div>
1559 <hr>
1560 <div class="refsect2">
1561 <a name="clutter-event-put"></a><h3>clutter_event_put ()</h3>
1562 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_put                   (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
1563 <p>
1564 Puts a copy of the event on the back of the event queue. The event will
1565 have the <a class="link" href="clutter-Events.html#CLUTTER-EVENT-FLAG-SYNTHETIC:CAPS"><code class="literal">CLUTTER_EVENT_FLAG_SYNTHETIC</code></a> flag set. If the source is set
1566 event signals will be emitted for this source and capture/bubbling for
1567 its ancestors. If the source is not set it will be generated by picking
1568 or use the actor that currently has keyboard focus
1569 </p>
1570 <div class="variablelist"><table border="0">
1571 <col align="left" valign="top">
1572 <tbody><tr>
1573 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1574 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
1575 </td>
1576 </tr></tbody>
1577 </table></div>
1578 <p class="since">Since 0.6</p>
1579 </div>
1580 <hr>
1581 <div class="refsect2">
1582 <a name="clutter-events-pending"></a><h3>clutter_events_pending ()</h3>
1583 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_events_pending              (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
1584 <p>
1585 Checks if events are pending in the event queue.
1586 </p>
1587 <div class="variablelist"><table border="0">
1588 <col align="left" valign="top">
1589 <tbody><tr>
1590 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1591 <td>TRUE if there are pending events, FALSE otherwise.</td>
1592 </tr></tbody>
1593 </table></div>
1594 <p class="since">Since 0.4</p>
1595 </div>
1596 <hr>
1597 <div class="refsect2">
1598 <a name="CLUTTER-BUTTON-PRIMARY:CAPS"></a><h3>CLUTTER_BUTTON_PRIMARY</h3>
1599 <pre class="programlisting">#define CLUTTER_BUTTON_PRIMARY          (1)
1600 </pre>
1601 <p>
1602 The primary button of a pointer device.
1603 </p>
1604 <p>
1605 This is typically the left mouse button in a right-handed
1606 mouse configuration.
1607 </p>
1608 <p class="since">Since 1.10</p>
1609 </div>
1610 <hr>
1611 <div class="refsect2">
1612 <a name="CLUTTER-BUTTON-MIDDLE:CAPS"></a><h3>CLUTTER_BUTTON_MIDDLE</h3>
1613 <pre class="programlisting">#define CLUTTER_BUTTON_MIDDLE           (2)
1614 </pre>
1615 <p>
1616 The middle button of a pointer device.
1617 </p>
1618 <p class="since">Since 1.10</p>
1619 </div>
1620 <hr>
1621 <div class="refsect2">
1622 <a name="CLUTTER-BUTTON-SECONDARY:CAPS"></a><h3>CLUTTER_BUTTON_SECONDARY</h3>
1623 <pre class="programlisting">#define CLUTTER_BUTTON_SECONDARY        (3)
1624 </pre>
1625 <p>
1626 The secondary button of a pointer device.
1627 </p>
1628 <p>
1629 This is typically the right mouse button in a right-handed
1630 mouse configuration.
1631 </p>
1632 <p class="since">Since 1.10</p>
1633 </div>
1634 <hr>
1635 <div class="refsect2">
1636 <a name="clutter-event-set-button"></a><h3>clutter_event_set_button ()</h3>
1637 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_set_button            (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
1638                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> button</code></em>);</pre>
1639 <p>
1640 Sets the button number of <em class="parameter"><code>event</code></em>
1641 </p>
1642 <div class="variablelist"><table border="0">
1643 <col align="left" valign="top">
1644 <tbody>
1645 <tr>
1646 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1647 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> or type <a class="link" href="clutter-Events.html#CLUTTER-BUTTON-PRESS:CAPS"><code class="literal">CLUTTER_BUTTON_PRESS</code></a> or
1648 of type <a class="link" href="clutter-Events.html#CLUTTER-BUTTON-RELEASE:CAPS"><code class="literal">CLUTTER_BUTTON_RELEASE</code></a>
1649 </td>
1650 </tr>
1651 <tr>
1652 <td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
1653 <td>the button number</td>
1654 </tr>
1655 </tbody>
1656 </table></div>
1657 <p class="since">Since 1.8</p>
1658 </div>
1659 <hr>
1660 <div class="refsect2">
1661 <a name="clutter-event-get-button"></a><h3>clutter_event_get_button ()</h3>
1662 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>             clutter_event_get_button            (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
1663 <p>
1664 Retrieves the button number of <em class="parameter"><code>event</code></em>
1665 </p>
1666 <div class="variablelist"><table border="0">
1667 <col align="left" valign="top">
1668 <tbody>
1669 <tr>
1670 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1671 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> of type <a class="link" href="clutter-Events.html#CLUTTER-BUTTON-PRESS:CAPS"><code class="literal">CLUTTER_BUTTON_PRESS</code></a> or
1672 of type <a class="link" href="clutter-Events.html#CLUTTER-BUTTON-RELEASE:CAPS"><code class="literal">CLUTTER_BUTTON_RELEASE</code></a>
1673 </td>
1674 </tr>
1675 <tr>
1676 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1677 <td>the button number</td>
1678 </tr>
1679 </tbody>
1680 </table></div>
1681 <p class="since">Since 1.0</p>
1682 </div>
1683 <hr>
1684 <div class="refsect2">
1685 <a name="clutter-event-get-click-count"></a><h3>clutter_event_get_click_count ()</h3>
1686 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               clutter_event_get_click_count       (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
1687 <p>
1688 Retrieves the number of clicks of <em class="parameter"><code>event</code></em>
1689 </p>
1690 <div class="variablelist"><table border="0">
1691 <col align="left" valign="top">
1692 <tbody>
1693 <tr>
1694 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1695 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> of type <a class="link" href="clutter-Events.html#CLUTTER-BUTTON-PRESS:CAPS"><code class="literal">CLUTTER_BUTTON_PRESS</code></a> or
1696 of type <a class="link" href="clutter-Events.html#CLUTTER-BUTTON-RELEASE:CAPS"><code class="literal">CLUTTER_BUTTON_RELEASE</code></a>
1697 </td>
1698 </tr>
1699 <tr>
1700 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1701 <td>the click count</td>
1702 </tr>
1703 </tbody>
1704 </table></div>
1705 <p class="since">Since 1.0</p>
1706 </div>
1707 <hr>
1708 <div class="refsect2">
1709 <a name="clutter-event-set-key-symbol"></a><h3>clutter_event_set_key_symbol ()</h3>
1710 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_set_key_symbol        (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
1711                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> key_sym</code></em>);</pre>
1712 <p>
1713 Sets the key symbol of <em class="parameter"><code>event</code></em>.
1714 </p>
1715 <div class="variablelist"><table border="0">
1716 <col align="left" valign="top">
1717 <tbody>
1718 <tr>
1719 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1720 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> of type <a class="link" href="clutter-Events.html#CLUTTER-KEY-PRESS:CAPS"><code class="literal">CLUTTER_KEY_PRESS</code></a>
1721 or <a class="link" href="clutter-Events.html#CLUTTER-KEY-RELEASE:CAPS"><code class="literal">CLUTTER_KEY_RELEASE</code></a>
1722 </td>
1723 </tr>
1724 <tr>
1725 <td><p><span class="term"><em class="parameter"><code>key_sym</code></em> :</span></p></td>
1726 <td>the key symbol representing the key</td>
1727 </tr>
1728 </tbody>
1729 </table></div>
1730 <p class="since">Since 1.8</p>
1731 </div>
1732 <hr>
1733 <div class="refsect2">
1734 <a name="clutter-event-get-key-symbol"></a><h3>clutter_event_get_key_symbol ()</h3>
1735 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               clutter_event_get_key_symbol        (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
1736 <p>
1737 Retrieves the key symbol of <em class="parameter"><code>event</code></em>
1738 </p>
1739 <div class="variablelist"><table border="0">
1740 <col align="left" valign="top">
1741 <tbody>
1742 <tr>
1743 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1744 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> of type <a class="link" href="clutter-Events.html#CLUTTER-KEY-PRESS:CAPS"><code class="literal">CLUTTER_KEY_PRESS</code></a> or
1745 of type <a class="link" href="clutter-Events.html#CLUTTER-KEY-RELEASE:CAPS"><code class="literal">CLUTTER_KEY_RELEASE</code></a>
1746 </td>
1747 </tr>
1748 <tr>
1749 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1750 <td>the key symbol representing the key</td>
1751 </tr>
1752 </tbody>
1753 </table></div>
1754 <p class="since">Since 1.0</p>
1755 </div>
1756 <hr>
1757 <div class="refsect2">
1758 <a name="clutter-event-set-key-code"></a><h3>clutter_event_set_key_code ()</h3>
1759 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_set_key_code          (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
1760                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> key_code</code></em>);</pre>
1761 <p>
1762 Sets the keycode of the <em class="parameter"><code>event</code></em>.
1763 </p>
1764 <div class="variablelist"><table border="0">
1765 <col align="left" valign="top">
1766 <tbody>
1767 <tr>
1768 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1769 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> of type <a class="link" href="clutter-Events.html#CLUTTER-KEY-PRESS:CAPS"><code class="literal">CLUTTER_KEY_PRESS</code></a>
1770 or <a class="link" href="clutter-Events.html#CLUTTER-KEY-RELEASE:CAPS"><code class="literal">CLUTTER_KEY_RELEASE</code></a>
1771 </td>
1772 </tr>
1773 <tr>
1774 <td><p><span class="term"><em class="parameter"><code>key_code</code></em> :</span></p></td>
1775 <td>the keycode representing the key</td>
1776 </tr>
1777 </tbody>
1778 </table></div>
1779 <p class="since">Since 1.8</p>
1780 </div>
1781 <hr>
1782 <div class="refsect2">
1783 <a name="clutter-event-get-key-code"></a><h3>clutter_event_get_key_code ()</h3>
1784 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint16"><span class="returnvalue">guint16</span></a>             clutter_event_get_key_code          (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
1785 <p>
1786 Retrieves the keycode of the key that caused <em class="parameter"><code>event</code></em>
1787 </p>
1788 <div class="variablelist"><table border="0">
1789 <col align="left" valign="top">
1790 <tbody>
1791 <tr>
1792 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1793 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> of type <a class="link" href="clutter-Events.html#CLUTTER-KEY-PRESS:CAPS"><code class="literal">CLUTTER_KEY_PRESS</code></a> or
1794 of type <a class="link" href="clutter-Events.html#CLUTTER-KEY-RELEASE:CAPS"><code class="literal">CLUTTER_KEY_RELEASE</code></a>
1795 </td>
1796 </tr>
1797 <tr>
1798 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1799 <td>The keycode representing the key</td>
1800 </tr>
1801 </tbody>
1802 </table></div>
1803 <p class="since">Since 1.0</p>
1804 </div>
1805 <hr>
1806 <div class="refsect2">
1807 <a name="clutter-event-set-key-unicode"></a><h3>clutter_event_set_key_unicode ()</h3>
1808 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_set_key_unicode       (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
1809                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> key_unicode</code></em>);</pre>
1810 <p>
1811 Sets the Unicode value of <em class="parameter"><code>event</code></em>.
1812 </p>
1813 <div class="variablelist"><table border="0">
1814 <col align="left" valign="top">
1815 <tbody>
1816 <tr>
1817 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1818 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> of type <a class="link" href="clutter-Events.html#CLUTTER-KEY-PRESS:CAPS"><code class="literal">CLUTTER_KEY_PRESS</code></a>
1819 or <a class="link" href="clutter-Events.html#CLUTTER-KEY-RELEASE:CAPS"><code class="literal">CLUTTER_KEY_RELEASE</code></a>
1820 </td>
1821 </tr>
1822 <tr>
1823 <td><p><span class="term"><em class="parameter"><code>key_unicode</code></em> :</span></p></td>
1824 <td>the Unicode value representing the key</td>
1825 </tr>
1826 </tbody>
1827 </table></div>
1828 <p class="since">Since 1.8</p>
1829 </div>
1830 <hr>
1831 <div class="refsect2">
1832 <a name="clutter-event-get-key-unicode"></a><h3>clutter_event_get_key_unicode ()</h3>
1833 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>             clutter_event_get_key_unicode       (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
1834 <p>
1835 Retrieves the unicode value for the key that caused <em class="parameter"><code>keyev</code></em>.
1836 </p>
1837 <div class="variablelist"><table border="0">
1838 <col align="left" valign="top">
1839 <tbody>
1840 <tr>
1841 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1842 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> of type <a class="link" href="clutter-Events.html#CLUTTER-KEY-PRESS:CAPS"><code class="literal">CLUTTER_KEY_PRESS</code></a>
1843 or <a class="link" href="clutter-Events.html#CLUTTER-KEY-RELEASE:CAPS"><code class="literal">CLUTTER_KEY_RELEASE</code></a>
1844 </td>
1845 </tr>
1846 <tr>
1847 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1848 <td>The unicode value representing the key</td>
1849 </tr>
1850 </tbody>
1851 </table></div>
1852 </div>
1853 <hr>
1854 <div class="refsect2">
1855 <a name="clutter-keysym-to-unicode"></a><h3>clutter_keysym_to_unicode ()</h3>
1856 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>             clutter_keysym_to_unicode           (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>);</pre>
1857 <p>
1858 Converts <em class="parameter"><code>keyval</code></em> from a Clutter key symbol to the corresponding
1859 ISO10646 (Unicode) character.
1860 </p>
1861 <div class="variablelist"><table border="0">
1862 <col align="left" valign="top">
1863 <tbody>
1864 <tr>
1865 <td><p><span class="term"><em class="parameter"><code>keyval</code></em> :</span></p></td>
1866 <td>a key symbol</td>
1867 </tr>
1868 <tr>
1869 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1870 <td>a Unicode character, or 0 if there  is no corresponding
1871 character.</td>
1872 </tr>
1873 </tbody>
1874 </table></div>
1875 </div>
1876 <hr>
1877 <div class="refsect2">
1878 <a name="clutter-unicode-to-keysym"></a><h3>clutter_unicode_to_keysym ()</h3>
1879 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               clutter_unicode_to_keysym           (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> wc</code></em>);</pre>
1880 <p>
1881 Convert from a ISO10646 character to a key symbol.
1882 </p>
1883 <div class="variablelist"><table border="0">
1884 <col align="left" valign="top">
1885 <tbody>
1886 <tr>
1887 <td><p><span class="term"><em class="parameter"><code>wc</code></em> :</span></p></td>
1888 <td>a ISO10646 encoded character</td>
1889 </tr>
1890 <tr>
1891 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1892 <td>the corresponding Clutter key symbol, if one exists.
1893 or, if there is no corresponding symbol, wc | 0x01000000</td>
1894 </tr>
1895 </tbody>
1896 </table></div>
1897 <p class="since">Since 1.10</p>
1898 </div>
1899 <hr>
1900 <div class="refsect2">
1901 <a name="clutter-event-set-related"></a><h3>clutter_event_set_related ()</h3>
1902 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_set_related           (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
1903                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);</pre>
1904 <p>
1905 Sets the related actor of a crossing event
1906 </p>
1907 <div class="variablelist"><table border="0">
1908 <col align="left" valign="top">
1909 <tbody>
1910 <tr>
1911 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1912 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> of type <a class="link" href="clutter-Events.html#CLUTTER-ENTER:CAPS"><code class="literal">CLUTTER_ENTER</code></a> or <a class="link" href="clutter-Events.html#CLUTTER-LEAVE:CAPS"><code class="literal">CLUTTER_LEAVE</code></a>
1913 </td>
1914 </tr>
1915 <tr>
1916 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
1917 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1918 </td>
1919 </tr>
1920 </tbody>
1921 </table></div>
1922 <p class="since">Since 1.8</p>
1923 </div>
1924 <hr>
1925 <div class="refsect2">
1926 <a name="clutter-event-get-related"></a><h3>clutter_event_get_related ()</h3>
1927 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_event_get_related           (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
1928 <p>
1929 Retrieves the related actor of a crossing event.
1930 </p>
1931 <div class="variablelist"><table border="0">
1932 <col align="left" valign="top">
1933 <tbody>
1934 <tr>
1935 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1936 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> of type <a class="link" href="clutter-Events.html#CLUTTER-ENTER:CAPS"><code class="literal">CLUTTER_ENTER</code></a> or of
1937 type <a class="link" href="clutter-Events.html#CLUTTER-LEAVE:CAPS"><code class="literal">CLUTTER_LEAVE</code></a>
1938 </td>
1939 </tr>
1940 <tr>
1941 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1942 <td>the related <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
1943 </td>
1944 </tr>
1945 </tbody>
1946 </table></div>
1947 <p class="since">Since 1.0</p>
1948 </div>
1949 <hr>
1950 <div class="refsect2">
1951 <a name="clutter-event-set-scroll-direction"></a><h3>clutter_event_set_scroll_direction ()</h3>
1952 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_set_scroll_direction  (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
1953                                                          <em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterScrollDirection" title="enum ClutterScrollDirection"><span class="type">ClutterScrollDirection</span></a> direction</code></em>);</pre>
1954 <p>
1955 Sets the direction of the scrolling of <em class="parameter"><code>event</code></em>
1956 </p>
1957 <div class="variablelist"><table border="0">
1958 <col align="left" valign="top">
1959 <tbody>
1960 <tr>
1961 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1962 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
1963 </td>
1964 </tr>
1965 <tr>
1966 <td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
1967 <td>the scrolling direction</td>
1968 </tr>
1969 </tbody>
1970 </table></div>
1971 <p class="since">Since 1.8</p>
1972 </div>
1973 <hr>
1974 <div class="refsect2">
1975 <a name="clutter-event-get-scroll-direction"></a><h3>clutter_event_get_scroll_direction ()</h3>
1976 <pre class="programlisting"><a class="link" href="clutter-Events.html#ClutterScrollDirection" title="enum ClutterScrollDirection"><span class="returnvalue">ClutterScrollDirection</span></a> clutter_event_get_scroll_direction
1977                                                         (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
1978 <p>
1979 Retrieves the direction of the scrolling of <em class="parameter"><code>event</code></em>
1980 </p>
1981 <div class="variablelist"><table border="0">
1982 <col align="left" valign="top">
1983 <tbody>
1984 <tr>
1985 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1986 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> of type <a class="link" href="clutter-Events.html#CLUTTER-SCROLL:CAPS"><code class="literal">CLUTTER_SCROLL</code></a>
1987 </td>
1988 </tr>
1989 <tr>
1990 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1991 <td>the scrolling direction</td>
1992 </tr>
1993 </tbody>
1994 </table></div>
1995 <p class="since">Since 1.0</p>
1996 </div>
1997 <hr>
1998 <div class="refsect2">
1999 <a name="clutter-event-get-scroll-delta"></a><h3>clutter_event_get_scroll_delta ()</h3>
2000 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_get_scroll_delta      (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
2001                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *dx</code></em>,
2002                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *dy</code></em>);</pre>
2003 <p>
2004 Retrieves the precise scrolling information of <em class="parameter"><code>event</code></em>.
2005 </p>
2006 <p>
2007 The <em class="parameter"><code>event</code></em> has to have a <a class="link" href="clutter-Events.html#ClutterScrollEvent.direction"><span class="type">ClutterScrollEvent.direction</span></a> value
2008 of <a class="link" href="clutter-Events.html#CLUTTER-SCROLL-SMOOTH:CAPS"><code class="literal">CLUTTER_SCROLL_SMOOTH</code></a>.
2009 </p>
2010 <div class="variablelist"><table border="0">
2011 <col align="left" valign="top">
2012 <tbody>
2013 <tr>
2014 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
2015 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> of type <a class="link" href="clutter-Events.html#CLUTTER-SCROLL:CAPS"><code class="literal">CLUTTER_SCROLL</code></a>
2016 </td>
2017 </tr>
2018 <tr>
2019 <td><p><span class="term"><em class="parameter"><code>dx</code></em> :</span></p></td>
2020 <td>return location for the delta on the horizontal axis. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2021 </td>
2022 </tr>
2023 <tr>
2024 <td><p><span class="term"><em class="parameter"><code>dy</code></em> :</span></p></td>
2025 <td>return location for the delta on the vertical axis. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2026 </td>
2027 </tr>
2028 </tbody>
2029 </table></div>
2030 <p class="since">Since 1.10</p>
2031 </div>
2032 <hr>
2033 <div class="refsect2">
2034 <a name="clutter-event-set-scroll-delta"></a><h3>clutter_event_set_scroll_delta ()</h3>
2035 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_set_scroll_delta      (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
2036                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> dx</code></em>,
2037                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> dy</code></em>);</pre>
2038 <p>
2039 Sets the precise scrolling information of <em class="parameter"><code>event</code></em>.
2040 </p>
2041 <div class="variablelist"><table border="0">
2042 <col align="left" valign="top">
2043 <tbody>
2044 <tr>
2045 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
2046 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> of type <a class="link" href="clutter-Events.html#CLUTTER-SCROLL:CAPS"><code class="literal">CLUTTER_SCROLL</code></a>
2047 </td>
2048 </tr>
2049 <tr>
2050 <td><p><span class="term"><em class="parameter"><code>dx</code></em> :</span></p></td>
2051 <td>delta on the horizontal axis</td>
2052 </tr>
2053 <tr>
2054 <td><p><span class="term"><em class="parameter"><code>dy</code></em> :</span></p></td>
2055 <td>delta on the vertical axis</td>
2056 </tr>
2057 </tbody>
2058 </table></div>
2059 <p class="since">Since 1.10</p>
2060 </div>
2061 <hr>
2062 <div class="refsect2">
2063 <a name="clutter-event-set-device"></a><h3>clutter_event_set_device ()</h3>
2064 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_set_device            (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
2065                                                          <em class="parameter"><code><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> *device</code></em>);</pre>
2066 <p>
2067 Sets the device for <em class="parameter"><code>event</code></em>.
2068 </p>
2069 <div class="variablelist"><table border="0">
2070 <col align="left" valign="top">
2071 <tbody>
2072 <tr>
2073 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
2074 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
2075 </td>
2076 </tr>
2077 <tr>
2078 <td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
2079 <td>a <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a>, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
2080 </td>
2081 </tr>
2082 </tbody>
2083 </table></div>
2084 <p class="since">Since 1.6</p>
2085 </div>
2086 <hr>
2087 <div class="refsect2">
2088 <a name="clutter-event-get-device"></a><h3>clutter_event_get_device ()</h3>
2089 <pre class="programlisting"><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="returnvalue">ClutterInputDevice</span></a> * clutter_event_get_device           (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
2090 <p>
2091 Retrieves the <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> for the event.
2092 </p>
2093 <p>
2094 The <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> structure is completely opaque and should
2095 be cast to the platform-specific implementation.
2096 </p>
2097 <div class="variablelist"><table border="0">
2098 <col align="left" valign="top">
2099 <tbody>
2100 <tr>
2101 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
2102 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
2103 </td>
2104 </tr>
2105 <tr>
2106 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2107 <td>the <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. The
2108 returned device is owned by the <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> and it should not
2109 be unreferenced. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
2110 </td>
2111 </tr>
2112 </tbody>
2113 </table></div>
2114 <p class="since">Since 1.0</p>
2115 </div>
2116 <hr>
2117 <div class="refsect2">
2118 <a name="clutter-event-set-source-device"></a><h3>clutter_event_set_source_device ()</h3>
2119 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_event_set_source_device     (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>,
2120                                                          <em class="parameter"><code><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> *device</code></em>);</pre>
2121 <p>
2122 Sets the source <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> for <em class="parameter"><code>event</code></em>.
2123 </p>
2124 <p>
2125 The <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> must have been created using <a class="link" href="clutter-Events.html#clutter-event-new" title="clutter_event_new ()"><code class="function">clutter_event_new()</code></a>.
2126 </p>
2127 <div class="variablelist"><table border="0">
2128 <col align="left" valign="top">
2129 <tbody>
2130 <tr>
2131 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
2132 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
2133 </td>
2134 </tr>
2135 <tr>
2136 <td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
2137 <td>a <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
2138 </td>
2139 </tr>
2140 </tbody>
2141 </table></div>
2142 <p class="since">Since 1.8</p>
2143 </div>
2144 <hr>
2145 <div class="refsect2">
2146 <a name="clutter-event-get-source-device"></a><h3>clutter_event_get_source_device ()</h3>
2147 <pre class="programlisting"><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="returnvalue">ClutterInputDevice</span></a> * clutter_event_get_source_device    (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
2148 <p>
2149 Retrieves the hardware device that originated the event.
2150 </p>
2151 <p>
2152 If you need the virtual device, use <a class="link" href="clutter-Events.html#clutter-event-get-device" title="clutter_event_get_device ()"><code class="function">clutter_event_get_device()</code></a>.
2153 </p>
2154 <p>
2155 If no hardware device originated this event, this function will
2156 return the same device as <a class="link" href="clutter-Events.html#clutter-event-get-device" title="clutter_event_get_device ()"><code class="function">clutter_event_get_device()</code></a>.
2157 </p>
2158 <div class="variablelist"><table border="0">
2159 <col align="left" valign="top">
2160 <tbody>
2161 <tr>
2162 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
2163 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
2164 </td>
2165 </tr>
2166 <tr>
2167 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2168 <td>a pointer to a <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a>
2169 or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
2170 </td>
2171 </tr>
2172 </tbody>
2173 </table></div>
2174 <p class="since">Since 1.6</p>
2175 </div>
2176 <hr>
2177 <div class="refsect2">
2178 <a name="clutter-event-get-device-id"></a><h3>clutter_event_get_device_id ()</h3>
2179 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                clutter_event_get_device_id         (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
2180 <p>
2181 Retrieves the events device id if set.
2182 </p>
2183 <div class="variablelist"><table border="0">
2184 <col align="left" valign="top">
2185 <tbody>
2186 <tr>
2187 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
2188 <td>a clutter event</td>
2189 </tr>
2190 <tr>
2191 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2192 <td>A unique identifier for the device or -1 if the event has
2193 no specific device set.</td>
2194 </tr>
2195 </tbody>
2196 </table></div>
2197 </div>
2198 <hr>
2199 <div class="refsect2">
2200 <a name="clutter-event-get-device-type"></a><h3>clutter_event_get_device_type ()</h3>
2201 <pre class="programlisting"><a class="link" href="ClutterInputDevice.html#ClutterInputDeviceType" title="enum ClutterInputDeviceType"><span class="returnvalue">ClutterInputDeviceType</span></a> clutter_event_get_device_type    (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
2202 <p>
2203 Retrieves the type of the device for <em class="parameter"><code>event</code></em>
2204 </p>
2205 <div class="variablelist"><table border="0">
2206 <col align="left" valign="top">
2207 <tbody>
2208 <tr>
2209 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
2210 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
2211 </td>
2212 </tr>
2213 <tr>
2214 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2215 <td>the <a class="link" href="ClutterInputDevice.html#ClutterInputDeviceType" title="enum ClutterInputDeviceType"><span class="type">ClutterInputDeviceType</span></a> for the device, if
2216 any is set</td>
2217 </tr>
2218 </tbody>
2219 </table></div>
2220 <p class="since">Since 1.0</p>
2221 </div>
2222 <hr>
2223 <div class="refsect2">
2224 <a name="clutter-get-current-event-time"></a><h3>clutter_get_current_event_time ()</h3>
2225 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>             clutter_get_current_event_time      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
2226 <p>
2227 Retrieves the timestamp of the last event, if there is an
2228 event or if the event has a timestamp.
2229 </p>
2230 <div class="variablelist"><table border="0">
2231 <col align="left" valign="top">
2232 <tbody><tr>
2233 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2234 <td>the event timestamp, or <a class="link" href="clutter-Events.html#CLUTTER-CURRENT-TIME:CAPS" title="CLUTTER_CURRENT_TIME"><code class="literal">CLUTTER_CURRENT_TIME</code></a>
2235 </td>
2236 </tr></tbody>
2237 </table></div>
2238 <p class="since">Since 1.0</p>
2239 </div>
2240 <hr>
2241 <div class="refsect2">
2242 <a name="clutter-get-current-event"></a><h3>clutter_get_current_event ()</h3>
2243 <pre class="programlisting">const <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="returnvalue">ClutterEvent</span></a> * clutter_get_current_event          (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
2244 <p>
2245 If an event is currently being processed, return that event.
2246 This function is intended to be used to access event state
2247 that might not be exposed by higher-level widgets.  For
2248 example, to get the key modifier state from a Button 'clicked'
2249 event.
2250 </p>
2251 <div class="variablelist"><table border="0">
2252 <col align="left" valign="top">
2253 <tbody><tr>
2254 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2255 <td>The current ClutterEvent, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if none. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
2256 </td>
2257 </tr></tbody>
2258 </table></div>
2259 <p class="since">Since 1.2</p>
2260 </div>
2261 </div>
2262 </div>
2263 <div class="footer">
2264 <hr>
2265           Generated by GTK-Doc V1.18.1</div>
2266 </body>
2267 </html>