[gtk+/wip/garnacho/touchpad-gestures: 15/23] gtkgesture: Add docs blurb about touchpad gestures



commit 7f280a9dafa43ecab64f263938a47cf1750b6cad
Author: Carlos Garnacho <carlosg gnome org>
Date:   Fri Jul 24 18:52:38 2015 +0200

    gtkgesture: Add docs blurb about touchpad gestures
    
    Not too long though, the precautions to take are minimal.

 gtk/gtkgesture.c |    9 +++++++++
 1 files changed, 9 insertions(+), 0 deletions(-)
---
diff --git a/gtk/gtkgesture.c b/gtk/gtkgesture.c
index 58a4a52..5fc909e 100644
--- a/gtk/gtkgesture.c
+++ b/gtk/gtkgesture.c
@@ -104,6 +104,15 @@
  *
  * Sequence states can't be changed freely, see gtk_gesture_set_sequence_state()
  * to know about the possible lifetimes of a #GdkEventSequence.
+ *
+ * ## Touchpad gestures
+ *
+ * On the platforms that support it, #GtkGesture will handle transparently
+ * touchpad gesture events. The only precautions users of #GtkGesture should do
+ * to enable this support are:
+ * - Enabling %GDK_TOUCHPAD_GESTURE_MASK on their #GdkWindows
+ * - If the gesture has %GTK_PHASE_NONE, ensuring events of type
+ *   %GDK_TOUCHPAD_SWIPE and %GDK_TOUCHPAD_PINCH are handled by the #GtkGesture
  */
 
 #include "config.h"


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]