[gtkmm] Add Gestures group to the reference docs



commit 021ec6e147035c3b4f36014a130f3974753f5977
Author: Kjell Ahlstedt <kjell ahlstedt bredband net>
Date:   Wed Jul 2 18:35:17 2014 +0200

    Add Gestures group to the reference docs
    
    * gtk/src/eventcontroller.hg: Add @defgroup Gestures and @ingroup Gestures.
    * gtk/src/gesture*.hg: Add @ingroup Gestures.

 gtk/src/eventcontroller.hg   |   22 ++++++++++++++++++++++
 gtk/src/gesture.hg           |    2 ++
 gtk/src/gesturedrag.hg       |    2 ++
 gtk/src/gesturelongpress.hg  |    2 ++
 gtk/src/gesturemultipress.hg |    2 ++
 gtk/src/gesturepan.hg        |    2 ++
 gtk/src/gesturerotate.hg     |    4 +++-
 gtk/src/gesturesingle.hg     |    2 ++
 gtk/src/gestureswipe.hg      |    2 ++
 gtk/src/gesturezoom.hg       |    2 ++
 10 files changed, 41 insertions(+), 1 deletions(-)
---
diff --git a/gtk/src/eventcontroller.hg b/gtk/src/eventcontroller.hg
index 3723d59..5818ea5 100644
--- a/gtk/src/eventcontroller.hg
+++ b/gtk/src/eventcontroller.hg
@@ -22,6 +22,26 @@ _PINCLUDE(glibmm/private/object_p.h)
 
 namespace Gtk
 {
+/** @defgroup Gestures Event Controllers and Gestures
+ *
+ * These classes handle input events.
+ *
+ * Event controllers are standalone objects that can perform specific actions
+ * upon received GdkEvent%s. These are tied to a Widget, and can be told of
+ * the event propagation phase at which they will manage the events.
+ *
+ * Gestures are a set of specific controllers that are prepared to handle pointer
+ * and/or touch events. Each gestures implementation attempts to recognize specific
+ * actions out the received events, notifying of the state/progress accordingly to
+ * let the widget react to those. On multi-touch gestures, every interacting touch
+ * sequence will be tracked independently.
+ *
+ * See <a href="https://developer.gnome.org/gtk3/unstable/chap-input-handling.html";>The GTK+ Input Handling 
Model</a>
+ * for more information about input events and gestures.
+ *
+ * @newin{3,14}
+ */
+
 _WRAP_ENUM(PropagationPhase, GtkPropagationPhase)
 
 /** Self-contained handler of series of events.
@@ -31,6 +51,8 @@ _WRAP_ENUM(PropagationPhase, GtkPropagationPhase)
  * actions as a consequence of those.
  *
  * @newin{3,14}
+ *
+ * @ingroup Gestures
  */
 class EventController : public Glib::Object
 {
diff --git a/gtk/src/gesture.hg b/gtk/src/gesture.hg
index 9f671b8..56d2c78 100644
--- a/gtk/src/gesture.hg
+++ b/gtk/src/gesture.hg
@@ -108,6 +108,8 @@ _WRAP_ENUM(EventSequenceState, GtkEventSequenceState)
  * to know about the possible lifetimes of a GdkEventSequence.
  *
  * @newin{3,14}
+ *
+ * @ingroup Gestures
  */
 class Gesture : public EventController
 {
diff --git a/gtk/src/gesturedrag.hg b/gtk/src/gesturedrag.hg
index f1ae989..4794eff 100644
--- a/gtk/src/gesturedrag.hg
+++ b/gtk/src/gesturedrag.hg
@@ -30,6 +30,8 @@ namespace Gtk
  * extracted through get_offset() and get_start_point().
  *
  * @newin{3,14}
+ *
+ * @ingroup Gestures
  */
 class GestureDrag : public GestureSingle
 {
diff --git a/gtk/src/gesturelongpress.hg b/gtk/src/gesturelongpress.hg
index 5ccbfcf..d8b576c 100644
--- a/gtk/src/gesturelongpress.hg
+++ b/gtk/src/gesturelongpress.hg
@@ -31,6 +31,8 @@ namespace Gtk
  * too far of the initial press point, signal_cancelled() will be emitted.
  *
  * @newin{3,14}
+ *
+ * @ingroup Gestures
  */
 class GestureLongPress : public GestureSingle
 {
diff --git a/gtk/src/gesturemultipress.hg b/gtk/src/gesturemultipress.hg
index 38b15fc..ce7213d 100644
--- a/gtk/src/gesturemultipress.hg
+++ b/gtk/src/gesturemultipress.hg
@@ -36,6 +36,8 @@ namespace Gtk
  * its own.
  *
  * @newin{3,14}
+ *
+ * @ingroup Gestures
  */
 class GestureMultiPress : public GestureSingle
 {
diff --git a/gtk/src/gesturepan.hg b/gtk/src/gesturepan.hg
index 9dccba9..41a8d26 100644
--- a/gtk/src/gesturepan.hg
+++ b/gtk/src/gesturepan.hg
@@ -41,6 +41,8 @@ _WRAP_ENUM(PanDirection, GtkPanDirection)
  * are received, containing the offset in the given axis.
  *
  * @newin{3,14}
+ *
+ * @ingroup Gestures
  */
 class GesturePan : public GestureDrag
 {
diff --git a/gtk/src/gesturerotate.hg b/gtk/src/gesturerotate.hg
index 1a4687e..5305f60 100644
--- a/gtk/src/gesturerotate.hg
+++ b/gtk/src/gesturerotate.hg
@@ -26,8 +26,10 @@ namespace Gtk
  * This is a Gesture implementation able to recognize
  * 2-finger rotations. Whenever the angle between both handled sequences
  * changes, signal_angle_changed() is emitted.
-
+ *
  * @newin{3,14}
+ *
+ * @ingroup Gestures
  */
 class GestureRotate : public Gesture
 {
diff --git a/gtk/src/gesturesingle.hg b/gtk/src/gesturesingle.hg
index bde467f..777cb90 100644
--- a/gtk/src/gesturesingle.hg
+++ b/gtk/src/gesturesingle.hg
@@ -34,6 +34,8 @@ namespace Gtk
  * a mouse button number to interact with through set_button().
  *
  * @newin{3,14}
+ *
+ * @ingroup Gestures
  */
 class GestureSingle : public Gesture
 {
diff --git a/gtk/src/gestureswipe.hg b/gtk/src/gestureswipe.hg
index 5ad1871..0e13cad 100644
--- a/gtk/src/gestureswipe.hg
+++ b/gtk/src/gestureswipe.hg
@@ -35,6 +35,8 @@ namespace Gtk
  * All velocities are reported in pixels/sec units.
  *
  * @newin{3,14}
+ *
+ * @ingroup Gestures
  */
 class GestureSwipe : public GestureSingle
 {
diff --git a/gtk/src/gesturezoom.hg b/gtk/src/gesturezoom.hg
index 1a128a4..8b505d0 100644
--- a/gtk/src/gesturezoom.hg
+++ b/gtk/src/gesturezoom.hg
@@ -28,6 +28,8 @@ namespace Gtk
  * sequences changes, signal_scale_changed() is emitted to report the scale factor.
  *
  * @newin{3,14}
+ *
+ * @ingroup Gestures
  */
 class GestureZoom : public Gesture
 {


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