[gtk+/gestures: 97/140] longpress: Add missing documentation
- From: Carlos Garnacho <carlosg src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+/gestures: 97/140] longpress: Add missing documentation
- Date: Wed, 7 May 2014 09:02:36 +0000 (UTC)
commit 4bad2a0dda9c354691dd7aa0c0f77ea7fd266175
Author: Carlos Garnacho <carlosg gnome org>
Date: Wed Apr 9 18:28:12 2014 +0200
longpress: Add missing documentation
gtk/gtkgesturelongpress.c | 35 +++++++++++++++++++++++++++++++++++
1 files changed, 35 insertions(+), 0 deletions(-)
---
diff --git a/gtk/gtkgesturelongpress.c b/gtk/gtkgesturelongpress.c
index 79805a5..ec95237 100644
--- a/gtk/gtkgesturelongpress.c
+++ b/gtk/gtkgesturelongpress.c
@@ -17,6 +17,21 @@
*
* Author(s): Carlos Garnacho <carlosg gnome org>
*/
+
+/**
+ * SECTION:gtkgesturelongpress
+ * @Short_description: "press and hold" gesture
+ * @Title: GtkGestureLongPress
+ *
+ * #GtkGestureLongPress is a #GtkGesture implementation able to recognize
+ * long presses, triggering the #GtkGestureLongPress:pressed after the
+ * timeout is exceeded.
+ *
+ * If the touchpoint is lifted before the timeout passes, or if it drifts
+ * too far of the initial press point, the #GtkGestureLongPress::cancelled
+ * signal will be emitted.
+ */
+
#include "config.h"
#include <gtk/gtk.h>
#include <gtk/gtkgesturelongpress.h>
@@ -196,6 +211,17 @@ gtk_gesture_long_press_class_init (GtkGestureLongPressClass *klass)
gesture_class->sequence_state_changed =
gtk_gesture_long_press_sequence_state_changed;
+ /**
+ * GtkGestureLongPress:pressed:
+ * @gesture: the object which received the signal
+ * @x: the X coordinate where the press happened, relative to the widget allocation
+ * @y: the Y coordinate where the press happened, relative to the widget allocation
+ *
+ * This signal is emitted whenever a press goes unmoved/unreleased longer than
+ * what the GTK+ defaults tell.
+ *
+ * Since: 3.14
+ */
signals[PRESSED] =
g_signal_new ("pressed",
G_TYPE_FROM_CLASS (klass),
@@ -203,6 +229,15 @@ gtk_gesture_long_press_class_init (GtkGestureLongPressClass *klass)
G_STRUCT_OFFSET (GtkGestureLongPressClass, pressed),
NULL, NULL, NULL,
G_TYPE_NONE, 2, G_TYPE_DOUBLE, G_TYPE_DOUBLE);
+ /**
+ * GtkGestureLongPress:cancelled:
+ * @gesture: the object which received the signal
+ *
+ * This signal is emitted whenever a press moved too far, or was released
+ * before #GtkGestureLongPress:pressed happened.
+ *
+ * Since: 3.14
+ */
signals[CANCELLED] =
g_signal_new ("cancelled",
G_TYPE_FROM_CLASS (klass),
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]