gtkgesturedrag.c 8.6 KB
Newer Older
Carlos Garnacho's avatar
Carlos Garnacho committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/* GTK - The GIMP Toolkit
 * Copyright (C) 2014, Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
 *
 * Author(s): Carlos Garnacho <carlosg@gnome.org>
 */
19 20 21 22 23 24 25 26 27

/**
 * SECTION:gtkgesturedrag
 * @Short_description: Drag gesture
 * @Title: GtkGestureDrag
 * @See_also: #GtkGestureSwipe
 *
 * #GtkGestureDrag is a #GtkGesture implementation that recognizes drag
 * operations. The drag operation itself can be tracked throught the
28 29
 * #GtkGestureDrag::drag-begin, #GtkGestureDrag::drag-update and
 * #GtkGestureDrag::drag-end signals, or the relevant coordinates be
30 31 32
 * extracted through gtk_gesture_drag_get_offset() and
 * gtk_gesture_drag_get_start_point().
 */
Carlos Garnacho's avatar
Carlos Garnacho committed
33
#include "config.h"
34 35
#include "gtkgesturedrag.h"
#include "gtkgesturedragprivate.h"
36
#include "gtkintl.h"
Carlos Garnacho's avatar
Carlos Garnacho committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57

typedef struct _GtkGestureDragPrivate GtkGestureDragPrivate;
typedef struct _EventData EventData;

struct _GtkGestureDragPrivate
{
  gdouble start_x;
  gdouble start_y;
  gdouble last_x;
  gdouble last_y;
};

enum {
  DRAG_BEGIN,
  DRAG_UPDATE,
  DRAG_END,
  N_SIGNALS
};

static guint signals[N_SIGNALS] = { 0 };

58
G_DEFINE_TYPE_WITH_PRIVATE (GtkGestureDrag, gtk_gesture_drag, GTK_TYPE_GESTURE_SINGLE)
Carlos Garnacho's avatar
Carlos Garnacho committed
59

60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
static gboolean
gtk_gesture_drag_filter_event (GtkEventController *controller,
                               const GdkEvent     *event)
{
  /* Let touchpad swipe events go through, only if they match n-points  */
  if (event->type == GDK_TOUCHPAD_SWIPE)
    {
      guint n_points;

      g_object_get (G_OBJECT (controller), "n-points", &n_points, NULL);

      if (event->touchpad_swipe.n_fingers == n_points)
        return FALSE;
      else
        return TRUE;
    }

  return GTK_EVENT_CONTROLLER_CLASS (gtk_gesture_drag_parent_class)->filter_event (controller, event);
}

Carlos Garnacho's avatar
Carlos Garnacho committed
80 81 82 83 84
static void
gtk_gesture_drag_begin (GtkGesture       *gesture,
                        GdkEventSequence *sequence)
{
  GtkGestureDragPrivate *priv;
85 86 87
  GdkEventSequence *current;

  current = gtk_gesture_single_get_current_sequence (GTK_GESTURE_SINGLE (gesture));
Carlos Garnacho's avatar
Carlos Garnacho committed
88 89

  priv = gtk_gesture_drag_get_instance_private (GTK_GESTURE_DRAG (gesture));
90 91 92 93
  gtk_gesture_get_point (gesture, current, &priv->start_x, &priv->start_y);
  priv->last_x = priv->start_x;
  priv->last_y = priv->start_y;

Carlos Garnacho's avatar
Carlos Garnacho committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
  g_signal_emit (gesture, signals[DRAG_BEGIN], 0, priv->start_x, priv->start_y);
}

static void
gtk_gesture_drag_update (GtkGesture       *gesture,
                         GdkEventSequence *sequence)
{
  GtkGestureDragPrivate *priv;
  gdouble x, y;

  priv = gtk_gesture_drag_get_instance_private (GTK_GESTURE_DRAG (gesture));
  gtk_gesture_get_point (gesture, sequence, &priv->last_x, &priv->last_y);
  x = priv->last_x - priv->start_x;
  y = priv->last_y - priv->start_y;

  g_signal_emit (gesture, signals[DRAG_UPDATE], 0, x, y);
}

static void
gtk_gesture_drag_end (GtkGesture       *gesture,
                      GdkEventSequence *sequence)
{
  GtkGestureDragPrivate *priv;
117
  GdkEventSequence *current;
Carlos Garnacho's avatar
Carlos Garnacho committed
118 119
  gdouble x, y;

120 121
  current = gtk_gesture_single_get_current_sequence (GTK_GESTURE_SINGLE (gesture));

Carlos Garnacho's avatar
Carlos Garnacho committed
122
  priv = gtk_gesture_drag_get_instance_private (GTK_GESTURE_DRAG (gesture));
123
  gtk_gesture_get_point (gesture, current, &priv->last_x, &priv->last_y);
Carlos Garnacho's avatar
Carlos Garnacho committed
124 125 126 127 128 129 130 131 132 133
  x = priv->last_x - priv->start_x;
  y = priv->last_y - priv->start_y;

  g_signal_emit (gesture, signals[DRAG_END], 0, x, y);
}

static void
gtk_gesture_drag_class_init (GtkGestureDragClass *klass)
{
  GtkGestureClass *gesture_class = GTK_GESTURE_CLASS (klass);
134 135 136
  GtkEventControllerClass *event_controller_class = GTK_EVENT_CONTROLLER_CLASS (klass);

  event_controller_class->filter_event = gtk_gesture_drag_filter_event;
Carlos Garnacho's avatar
Carlos Garnacho committed
137 138 139 140 141

  gesture_class->begin = gtk_gesture_drag_begin;
  gesture_class->update = gtk_gesture_drag_update;
  gesture_class->end = gtk_gesture_drag_end;

142
  /**
Carlos Garnacho's avatar
Carlos Garnacho committed
143
   * GtkGestureDrag::drag-begin:
144 145 146 147 148 149 150 151
   * @gesture: the object which received the signal
   * @start_x: X coordinate, relative to the widget allocation
   * @start_y: Y coordinate, relative to the widget allocation
   *
   * This signal is emitted whenever dragging starts.
   *
   * Since: 3.14
   */
Carlos Garnacho's avatar
Carlos Garnacho committed
152
  signals[DRAG_BEGIN] =
153
    g_signal_new (I_("drag-begin"),
Carlos Garnacho's avatar
Carlos Garnacho committed
154 155 156 157 158
                  G_TYPE_FROM_CLASS (klass),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (GtkGestureDragClass, drag_begin),
                  NULL, NULL, NULL,
                  G_TYPE_NONE, 2, G_TYPE_DOUBLE, G_TYPE_DOUBLE);
159
  /**
Carlos Garnacho's avatar
Carlos Garnacho committed
160
   * GtkGestureDrag::drag-update:
161 162 163 164 165 166 167 168
   * @gesture: the object which received the signal
   * @offset_x: X offset, relative to the start point
   * @offset_y: Y offset, relative to the start point
   *
   * This signal is emitted whenever the dragging point moves.
   *
   * Since: 3.14
   */
Carlos Garnacho's avatar
Carlos Garnacho committed
169
  signals[DRAG_UPDATE] =
170
    g_signal_new (I_("drag-update"),
Carlos Garnacho's avatar
Carlos Garnacho committed
171 172 173 174 175
                  G_TYPE_FROM_CLASS (klass),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (GtkGestureDragClass, drag_update),
                  NULL, NULL, NULL,
                  G_TYPE_NONE, 2, G_TYPE_DOUBLE, G_TYPE_DOUBLE);
176
  /**
Carlos Garnacho's avatar
Carlos Garnacho committed
177
   * GtkGestureDrag::drag-end:
178 179 180 181 182 183 184 185
   * @gesture: the object which received the signal
   * @offset_x: X offset, relative to the start point
   * @offset_y: Y offset, relative to the start point
   *
   * This signal is emitted whenever the dragging is finished.
   *
   * Since: 3.14
   */
Carlos Garnacho's avatar
Carlos Garnacho committed
186
  signals[DRAG_END] =
187
    g_signal_new (I_("drag-end"),
Carlos Garnacho's avatar
Carlos Garnacho committed
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
                  G_TYPE_FROM_CLASS (klass),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (GtkGestureDragClass, drag_end),
                  NULL, NULL, NULL,
                  G_TYPE_NONE, 2, G_TYPE_DOUBLE, G_TYPE_DOUBLE);
}

static void
gtk_gesture_drag_init (GtkGestureDrag *gesture)
{
}

/**
 * gtk_gesture_drag_new:
 * @widget: a #GtkWidget
 *
Matthias Clasen's avatar
Matthias Clasen committed
204
 * Returns a newly created #GtkGesture that recognizes drags.
Carlos Garnacho's avatar
Carlos Garnacho committed
205 206 207 208 209 210 211 212
 *
 * Returns: a newly created #GtkGestureDrag
 *
 * Since: 3.14
 **/
GtkGesture *
gtk_gesture_drag_new (GtkWidget *widget)
{
213 214
  g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);

Carlos Garnacho's avatar
Carlos Garnacho committed
215 216 217 218 219 220 221 222
  return g_object_new (GTK_TYPE_GESTURE_DRAG,
                       "widget", widget,
                       NULL);
}

/**
 * gtk_gesture_drag_get_start_point:
 * @gesture: a #GtkGesture
223 224
 * @x: (out) (nullable): X coordinate for the drag start point
 * @y: (out) (nullable): Y coordinate for the drag start point
Carlos Garnacho's avatar
Carlos Garnacho committed
225 226 227 228 229
 *
 * If the @gesture is active, this function returns %TRUE
 * and fills in @x and @y with the drag start coordinates,
 * in window-relative coordinates.
 *
Matthias Clasen's avatar
Matthias Clasen committed
230
 * Returns: %TRUE if the gesture is active
Carlos Garnacho's avatar
Carlos Garnacho committed
231 232 233 234 235
 *
 * Since: 3.14
 **/
gboolean
gtk_gesture_drag_get_start_point (GtkGestureDrag *gesture,
236 237
                                  gdouble        *x,
                                  gdouble        *y)
Carlos Garnacho's avatar
Carlos Garnacho committed
238 239
{
  GtkGestureDragPrivate *priv;
240
  GdkEventSequence *sequence;
Carlos Garnacho's avatar
Carlos Garnacho committed
241

242 243 244 245 246
  g_return_val_if_fail (GTK_IS_GESTURE_DRAG (gesture), FALSE);

  sequence = gtk_gesture_single_get_current_sequence (GTK_GESTURE_SINGLE (gesture));

  if (!gtk_gesture_handles_sequence (GTK_GESTURE (gesture), sequence))
Carlos Garnacho's avatar
Carlos Garnacho committed
247 248 249 250 251 252 253 254 255 256 257 258 259 260
    return FALSE;

  priv = gtk_gesture_drag_get_instance_private (gesture);

  if (x)
    *x = priv->start_x;

  if (y)
    *y = priv->start_y;

  return TRUE;
}

/**
261
 * gtk_gesture_drag_get_offset:
Carlos Garnacho's avatar
Carlos Garnacho committed
262
 * @gesture: a #GtkGesture
263 264
 * @x: (out) (nullable): X offset for the current point
 * @y: (out) (nullable): Y offset for the current point
Carlos Garnacho's avatar
Carlos Garnacho committed
265 266 267 268 269
 *
 * If the @gesture is active, this function returns %TRUE and
 * fills in @x and @y with the coordinates of the current point,
 * as an offset to the starting drag point.
 *
Matthias Clasen's avatar
Matthias Clasen committed
270
 * Returns: %TRUE if the gesture is active
Carlos Garnacho's avatar
Carlos Garnacho committed
271 272 273 274
 *
 * Since: 3.14
 **/
gboolean
275 276 277
gtk_gesture_drag_get_offset (GtkGestureDrag *gesture,
                             gdouble        *x,
                             gdouble        *y)
Carlos Garnacho's avatar
Carlos Garnacho committed
278 279
{
  GtkGestureDragPrivate *priv;
280 281 282 283 284
  GdkEventSequence *sequence;

  g_return_val_if_fail (GTK_IS_GESTURE_DRAG (gesture), FALSE);

  sequence = gtk_gesture_single_get_current_sequence (GTK_GESTURE_SINGLE (gesture));
Carlos Garnacho's avatar
Carlos Garnacho committed
285

286
  if (!gtk_gesture_handles_sequence (GTK_GESTURE (gesture), sequence))
Carlos Garnacho's avatar
Carlos Garnacho committed
287 288 289 290 291
    return FALSE;

  priv = gtk_gesture_drag_get_instance_private (gesture);

  if (x)
292
    *x = priv->last_x - priv->start_x;
Carlos Garnacho's avatar
Carlos Garnacho committed
293 294

  if (y)
295
    *y = priv->last_y - priv->start_y;
Carlos Garnacho's avatar
Carlos Garnacho committed
296 297 298

  return TRUE;
}