gtkgesture.c 43.4 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 19
/* GTK - The GIMP Toolkit
 * Copyright (C) 2012, One Laptop Per Child.
 * 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>
 */
20 21 22 23 24

/**
 * SECTION:gtkgesture
 * @Short_description: Gesture recognition
 * @Title: GtkGesture
25
 * @See_also: #GtkGestureSingle
26 27 28 29 30 31 32 33 34 35 36 37
 *
 * #GtkGesture is the base object for gesture recognition, although this
 * object is quite generalized to serve as a base for multi-touch gestures,
 * it is suitable to implement single-touch and pointer-based gestures (using
 * the special %NULL #GdkEventSequence value for these).
 *
 * The number of touches that a #GtkGesture need to be recognized is controlled
 * by the #GtkGesture:n-points property, if a gesture is keeping track of less
 * or more than that number of sequences, it won't check wether the gesture
 * is recognized.
 *
 * As soon as the gesture has the expected number of touches, the gesture will
Carlos Garnacho's avatar
Carlos Garnacho committed
38 39 40
 * run the #GtkGesture::check signal regularly on input events until the gesture
 * is recognized, the criteria to consider a gesture as "recognized" is left to
 * #GtkGesture subclasses.
41 42
 *
 * A recognized gesture will then emit the following signals:
Carlos Garnacho's avatar
Carlos Garnacho committed
43 44 45
 * - #GtkGesture::begin when the gesture is recognized.
 * - A number of #GtkGesture::update, whenever an input event is processed.
 * - #GtkGesture::end when the gesture is no longer recognized.
46 47 48 49 50
 *
 * ## States of a sequence # {#touch-sequence-states}
 *
 * Whenever input interaction happens, a single event may trigger a cascade of
 * #GtkGestures, both across the parents of the widget receiving the
Carlos Garnacho's avatar
Carlos Garnacho committed
51
 * event and parallelly within an individual widget. It is a responsibility of the
52 53 54 55 56 57 58 59 60 61 62 63 64
 * widgets using those gestures to set the state of touch sequences accordingly
 * in order to enable cooperation of gestures around the #GdkEventSequences
 * triggering those.
 *
 * Within a widget, gestures can be grouped through gtk_gesture_group(), grouped
 * gestures synchronize the state of sequences, so calling gtk_gesture_set_sequence_state()
 * on one will effectively propagate the state throughout the group.
 *
 * By default, all sequences start out in the #GTK_EVENT_SEQUENCE_NONE state,
 * sequences in this state trigger the gesture event handler, but event
 * propagation will continue unstopped by gestures.
 *
 * If a sequence enters into the #GTK_EVENT_SEQUENCE_DENIED state, the gesture
Carlos Garnacho's avatar
Carlos Garnacho committed
65 66 67
 * group will effectively ignore the sequence, letting events go unstopped
 * through the gesture, but the "slot" will still remain occupied while
 * the touch is active.
68 69 70
 *
 * If a sequence enters in the #GTK_EVENT_SEQUENCE_CLAIMED state, the gesture
 * group will grab all interaction on the sequence, by:
Carlos Garnacho's avatar
Carlos Garnacho committed
71
 * - Setting the same sequence to #GTK_EVENT_SEQUENCE_DENIED on every other gesture
72 73
 *   group within the widget, and every gesture on parent widgets in the propagation
 *   chain.
Carlos Garnacho's avatar
Carlos Garnacho committed
74
 * - calling #GtkGesture::cancel on every gesture in widgets underneath in the
75
 *   propagation chain.
Carlos Garnacho's avatar
Carlos Garnacho committed
76 77 78 79 80 81 82 83
 * - Stopping event propagation after the gesture group handles the event.
 *
 * Note: if a sequence is set early to #GTK_EVENT_SEQUENCE_CLAIMED on
 * #GDK_TOUCH_BEGIN/#GDK_BUTTON_PRESS (so those events are captured before
 * reaching the event widget, this implies #GTK_PHASE_CAPTURE), one similar
 * event will emulated if the sequence changes to #GTK_EVENT_SEQUENCE_DENIED.
 * This way event coherence is preserved before event propagation is unstopped
 * again.
84 85 86 87 88
 *
 * Sequence states can't be changed freely, see gtk_gesture_set_sequence_state()
 * to know about the possible lifetimes of a #GdkEventSequence.
 */

Carlos Garnacho's avatar
Carlos Garnacho committed
89
#include "config.h"
90
#include "gtkgesture.h"
91
#include "gtkwidgetprivate.h"
92
#include "gtkgestureprivate.h"
Carlos Garnacho's avatar
Carlos Garnacho committed
93 94
#include "gtktypebuiltins.h"
#include "gtkprivate.h"
95
#include "gtkmain.h"
Carlos Garnacho's avatar
Carlos Garnacho committed
96 97 98 99 100 101 102
#include "gtkintl.h"

typedef struct _GtkGesturePrivate GtkGesturePrivate;
typedef struct _PointData PointData;

enum {
  PROP_N_POINTS = 1,
103
  PROP_WINDOW
Carlos Garnacho's avatar
Carlos Garnacho committed
104 105 106 107 108 109
};

enum {
  BEGIN,
  END,
  UPDATE,
110
  CANCEL,
Carlos Garnacho's avatar
Carlos Garnacho committed
111 112 113 114 115 116 117
  SEQUENCE_STATE_CHANGED,
  N_SIGNALS
};

struct _PointData
{
  GdkEvent *event;
118 119
  gdouble widget_x;
  gdouble widget_y;
120
  guint press_handled : 1;
Carlos Garnacho's avatar
Carlos Garnacho committed
121 122 123 124 125 126 127
  guint state : 2;
};

struct _GtkGesturePrivate
{
  GHashTable *points;
  GdkEventSequence *last_sequence;
128
  GdkWindow *user_window;
Carlos Garnacho's avatar
Carlos Garnacho committed
129 130
  GdkWindow *window;
  GdkDevice *device;
131
  GList *group_link;
Carlos Garnacho's avatar
Carlos Garnacho committed
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
  guint n_points;
  guint recognized : 1;
};

static guint signals[N_SIGNALS] = { 0 };

#define BUTTONS_MASK (GDK_BUTTON1_MASK | GDK_BUTTON2_MASK | GDK_BUTTON3_MASK)

G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GtkGesture, gtk_gesture, GTK_TYPE_EVENT_CONTROLLER)

static void
gtk_gesture_get_property (GObject    *object,
                          guint       prop_id,
                          GValue     *value,
                          GParamSpec *pspec)
{
  GtkGesturePrivate *priv = gtk_gesture_get_instance_private (GTK_GESTURE (object));

  switch (prop_id)
    {
    case PROP_N_POINTS:
      g_value_set_uint (value, priv->n_points);
      break;
155 156
    case PROP_WINDOW:
      g_value_set_object (value, priv->user_window);
Carlos Garnacho's avatar
Carlos Garnacho committed
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
gtk_gesture_set_property (GObject      *object,
                          guint         prop_id,
                          const GValue *value,
                          GParamSpec   *pspec)
{
  GtkGesturePrivate *priv = gtk_gesture_get_instance_private (GTK_GESTURE (object));

  switch (prop_id)
    {
    case PROP_N_POINTS:
      priv->n_points = g_value_get_uint (value);
      break;
176 177 178
    case PROP_WINDOW:
      gtk_gesture_set_window (GTK_GESTURE (object),
                              g_value_get_object (value));
Carlos Garnacho's avatar
Carlos Garnacho committed
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
gtk_gesture_finalize (GObject *object)
{
  GtkGesturePrivate *priv = gtk_gesture_get_instance_private (GTK_GESTURE (object));

  g_hash_table_destroy (priv->points);

  G_OBJECT_CLASS (gtk_gesture_parent_class)->finalize (object);
}

static guint
_gtk_gesture_effective_n_points (GtkGesture *gesture)
{
  GtkGesturePrivate *priv;
  GHashTableIter iter;
  guint n_points = 0;
  PointData *data;

  priv = gtk_gesture_get_instance_private (gesture);
  g_hash_table_iter_init (&iter, priv->points);

  while (g_hash_table_iter_next (&iter, NULL, (gpointer *) &data))
    {
208 209
      if (data->state == GTK_EVENT_SEQUENCE_DENIED ||
          data->event->type == GDK_TOUCH_END ||
Carlos Garnacho's avatar
Carlos Garnacho committed
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
          data->event->type == GDK_BUTTON_RELEASE)
        continue;

      n_points++;
    }

  return n_points;
}

static gboolean
gtk_gesture_check_impl (GtkGesture *gesture)
{
  GtkGesturePrivate *priv;
  guint n_points;

  priv = gtk_gesture_get_instance_private (gesture);
  n_points = _gtk_gesture_effective_n_points (gesture);

  return n_points == priv->n_points;
}

static void
_gtk_gesture_set_recognized (GtkGesture       *gesture,
                             gboolean          recognized,
                             GdkEventSequence *sequence)
{
  GtkGesturePrivate *priv;

  priv = gtk_gesture_get_instance_private (gesture);

  if (priv->recognized == recognized)
    return;

  priv->recognized = recognized;

  if (recognized)
    g_signal_emit (gesture, signals[BEGIN], 0, sequence);
  else
    g_signal_emit (gesture, signals[END], 0, sequence);
}

static gboolean
_gtk_gesture_do_check (GtkGesture *gesture)
{
254 255
  GtkGestureClass *gesture_class;
  gboolean retval = FALSE;
Carlos Garnacho's avatar
Carlos Garnacho committed
256

257
  gesture_class = GTK_GESTURE_GET_CLASS (gesture);
Carlos Garnacho's avatar
Carlos Garnacho committed
258

259 260 261 262
  if (!gesture_class->check)
    return retval;

  retval = gesture_class->check (gesture);
Carlos Garnacho's avatar
Carlos Garnacho committed
263 264 265 266 267 268 269 270 271 272 273 274
  return retval;
}

static gboolean
_gtk_gesture_check_recognized (GtkGesture       *gesture,
                               GdkEventSequence *sequence)
{
  GtkGesturePrivate *priv = gtk_gesture_get_instance_private (gesture);
  guint current_n_points;

  current_n_points = _gtk_gesture_effective_n_points (gesture);

275 276 277
  if (priv->recognized &&
      (current_n_points != priv->n_points ||
       g_hash_table_size (priv->points) != priv->n_points))
Carlos Garnacho's avatar
Carlos Garnacho committed
278 279 280
    _gtk_gesture_set_recognized (gesture, FALSE, sequence);
  else if (!priv->recognized &&
           current_n_points == priv->n_points &&
281
           g_hash_table_size (priv->points) == priv->n_points &&
Carlos Garnacho's avatar
Carlos Garnacho committed
282 283 284 285 286 287
           _gtk_gesture_do_check (gesture))
    _gtk_gesture_set_recognized (gesture, TRUE, sequence);

  return priv->recognized;
}

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
/* Finds the first window pertaining to the controller's widget */
static GdkWindow *
_find_widget_window (GtkGesture *gesture,
                     GdkWindow  *window)
{
  GtkWidget *widget, *window_widget;

  widget = gtk_event_controller_get_widget (GTK_EVENT_CONTROLLER (gesture));

  while (window)
    {
      gdk_window_get_user_data (window, (gpointer*) &window_widget);

      if (window_widget == widget ||
          gtk_widget_get_window (widget) == window)
        return window;

      window = gdk_window_get_effective_parent (window);
    }

  return NULL;
}

311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
static void
_update_widget_coordinates (GtkGesture *gesture,
                            PointData  *data)
{
  GdkWindow *window, *event_widget_window;
  GtkWidget *event_widget, *widget;
  GtkAllocation allocation;
  gdouble event_x, event_y;
  gint wx, wy, x, y;

  event_widget = gtk_get_event_widget (data->event);
  widget = gtk_event_controller_get_widget (GTK_EVENT_CONTROLLER (gesture));
  event_widget_window = gtk_widget_get_window (event_widget);
  gdk_event_get_coords (data->event, &event_x, &event_y);
  window = data->event->any.window;

327
  while (window && window != event_widget_window)
328 329 330 331 332 333 334
    {
      gdk_window_get_position (window, &wx, &wy);
      event_x += wx;
      event_y += wy;
      window = gdk_window_get_effective_parent (window);
    }

335 336 337
  if (!window)
    return;

338 339 340 341 342 343 344 345 346 347 348 349 350
  if (!gtk_widget_get_has_window (event_widget))
    {
      gtk_widget_get_allocation (event_widget, &allocation);
      event_x -= allocation.x;
      event_y -= allocation.y;
    }

  gtk_widget_translate_coordinates (event_widget, widget,
                                    event_x, event_y, &x, &y);
  data->widget_x = x;
  data->widget_y = y;
}

Carlos Garnacho's avatar
Carlos Garnacho committed
351 352 353 354 355 356
static gboolean
_gtk_gesture_update_point (GtkGesture     *gesture,
                           const GdkEvent *event,
                           gboolean        add)
{
  GdkEventSequence *sequence;
357
  GdkWindow *widget_window;
Carlos Garnacho's avatar
Carlos Garnacho committed
358 359
  GtkGesturePrivate *priv;
  GdkDevice *device;
360
  gboolean existed;
Carlos Garnacho's avatar
Carlos Garnacho committed
361 362 363 364 365 366 367 368 369 370 371 372
  PointData *data;
  gdouble x, y;

  if (!gdk_event_get_coords (event, &x, &y))
    return FALSE;

  device = gdk_event_get_device (event);

  if (!device)
    return FALSE;

  priv = gtk_gesture_get_instance_private (gesture);
373
  widget_window = _find_widget_window (gesture, event->any.window);
Carlos Garnacho's avatar
Carlos Garnacho committed
374

375 376 377
  if (!widget_window)
    return FALSE;

378 379 380 381 382 383 384 385 386 387 388 389 390
  if (add)
    {
      /* If the event happens with the wrong device, or
       * on the wrong window, ignore.
       */
      if (priv->device && priv->device != device)
        return FALSE;
      if (priv->window && priv->window != widget_window)
        return FALSE;
      if (priv->user_window && priv->user_window != widget_window)
        return FALSE;
    }
  else if (!priv->device || !priv->window)
Carlos Garnacho's avatar
Carlos Garnacho committed
391 392 393
    return FALSE;

  sequence = gdk_event_get_event_sequence (event);
394 395 396
  existed = g_hash_table_lookup_extended (priv->points, sequence,
                                          NULL, (gpointer *) &data);
  if (!existed)
Carlos Garnacho's avatar
Carlos Garnacho committed
397 398 399 400 401 402
    {
      if (!add)
        return FALSE;

      if (g_hash_table_size (priv->points) == 0)
        {
403
          priv->window = widget_window;
Carlos Garnacho's avatar
Carlos Garnacho committed
404 405 406 407 408 409 410 411 412 413 414
          priv->device = device;
        }

      data = g_new0 (PointData, 1);
      g_hash_table_insert (priv->points, sequence, data);
    }

  if (data->event)
    gdk_event_free (data->event);

  data->event = gdk_event_copy (event);
415
  _update_widget_coordinates (gesture, data);
Carlos Garnacho's avatar
Carlos Garnacho committed
416

417 418 419 420 421 422 423 424
  /* Deny the sequence right away if the expected
   * number of points is exceeded, so this sequence
   * can be tracked with gtk_gesture_handles_sequence().
   */
  if (!existed && g_hash_table_size (priv->points) > priv->n_points)
    gtk_gesture_set_sequence_state (gesture, sequence,
                                    GTK_EVENT_SEQUENCE_DENIED);

Carlos Garnacho's avatar
Carlos Garnacho committed
425 426 427
  return TRUE;
}

428 429 430 431 432 433 434 435 436 437 438 439 440 441
static void
_gtk_gesture_check_empty (GtkGesture *gesture)
{
  GtkGesturePrivate *priv;

  priv = gtk_gesture_get_instance_private (gesture);

  if (g_hash_table_size (priv->points) == 0)
    {
      priv->window = NULL;
      priv->device = NULL;
    }
}

Carlos Garnacho's avatar
Carlos Garnacho committed
442 443 444 445 446 447 448 449 450 451 452 453
static void
_gtk_gesture_remove_point (GtkGesture     *gesture,
                           const GdkEvent *event)
{
  GdkEventSequence *sequence;
  GtkGesturePrivate *priv;
  GdkDevice *device;

  sequence = gdk_event_get_event_sequence (event);
  device = gdk_event_get_device (event);
  priv = gtk_gesture_get_instance_private (gesture);

454 455 456
  if (priv->device != device)
    return;

Carlos Garnacho's avatar
Carlos Garnacho committed
457
  g_hash_table_remove (priv->points, sequence);
458 459
  _gtk_gesture_check_empty (gesture);
}
Carlos Garnacho's avatar
Carlos Garnacho committed
460

461 462 463 464 465 466 467 468 469 470 471
static void
_gtk_gesture_cancel_all (GtkGesture *gesture)
{
  GdkEventSequence *sequence;
  GtkGesturePrivate *priv;
  GHashTableIter iter;

  priv = gtk_gesture_get_instance_private (gesture);
  g_hash_table_iter_init (&iter, priv->points);

  while (g_hash_table_iter_next (&iter, (gpointer*) &sequence, NULL))
Carlos Garnacho's avatar
Carlos Garnacho committed
472
    {
473 474 475
      g_signal_emit (gesture, signals[CANCEL], 0, sequence);
      g_hash_table_iter_remove (&iter);
      _gtk_gesture_check_recognized (gesture, sequence);
Carlos Garnacho's avatar
Carlos Garnacho committed
476
    }
477 478

  _gtk_gesture_check_empty (gesture);
Carlos Garnacho's avatar
Carlos Garnacho committed
479 480
}

481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
static gboolean
gesture_within_window (GtkGesture *gesture,
                       GdkWindow  *parent)
{
  GdkWindow *window;
  GtkWidget *widget;

  widget = gtk_event_controller_get_widget (GTK_EVENT_CONTROLLER (gesture));
  window = gtk_widget_get_window (widget);

  while (window)
    {
      if (window == parent)
        return TRUE;

      window = gdk_window_get_effective_parent (window);
    }

  return FALSE;
}

Carlos Garnacho's avatar
Carlos Garnacho committed
502 503 504 505 506 507 508
static gboolean
gtk_gesture_handle_event (GtkEventController *controller,
                          const GdkEvent     *event)
{
  GtkGesture *gesture = GTK_GESTURE (controller);
  GdkEventSequence *sequence;
  GtkGesturePrivate *priv;
509
  GdkDevice *source_device;
510
  gboolean was_recognized;
Carlos Garnacho's avatar
Carlos Garnacho committed
511

512 513 514 515 516
  source_device = gdk_event_get_source_device (event);

  if (!source_device)
    return FALSE;

Carlos Garnacho's avatar
Carlos Garnacho committed
517 518
  priv = gtk_gesture_get_instance_private (gesture);
  sequence = gdk_event_get_event_sequence (event);
519
  was_recognized = gtk_gesture_is_recognized (gesture);
Carlos Garnacho's avatar
Carlos Garnacho committed
520

521 522
  if (gtk_gesture_get_sequence_state (gesture, sequence) != GTK_EVENT_SEQUENCE_DENIED)
    priv->last_sequence = sequence;
Carlos Garnacho's avatar
Carlos Garnacho committed
523 524 525 526 527

  switch (event->type)
    {
    case GDK_BUTTON_PRESS:
    case GDK_TOUCH_BEGIN:
528 529 530 531 532 533
      if (_gtk_gesture_update_point (gesture, event, TRUE) &&
          _gtk_gesture_check_recognized (gesture, sequence))
        {
          PointData *data;

          data = g_hash_table_lookup (priv->points, sequence);
534 535 536 537

          /* If the sequence was claimed early, the press event will be consumed */
          if (gtk_gesture_get_sequence_state (gesture, sequence) == GTK_EVENT_SEQUENCE_CLAIMED)
            data->press_handled = TRUE;
538
        }
539

Carlos Garnacho's avatar
Carlos Garnacho committed
540 541 542 543 544
      break;
    case GDK_BUTTON_RELEASE:
    case GDK_TOUCH_END:
      if (_gtk_gesture_update_point (gesture, event, FALSE))
        {
545 546
          if (was_recognized &&
              _gtk_gesture_check_recognized (gesture, sequence))
Carlos Garnacho's avatar
Carlos Garnacho committed
547 548 549 550 551 552 553 554 555 556 557 558 559 560
            g_signal_emit (gesture, signals[UPDATE], 0, sequence);

          _gtk_gesture_remove_point (gesture, event);
        }
      break;
    case GDK_MOTION_NOTIFY:
      if ((event->motion.state & BUTTONS_MASK) == 0)
        break;

      if (event->motion.is_hint)
        gdk_event_request_motions (&event->motion);

      /* Fall through */
    case GDK_TOUCH_UPDATE:
561
      if (_gtk_gesture_update_point (gesture, event, FALSE) &&
Carlos Garnacho's avatar
Carlos Garnacho committed
562 563 564
          _gtk_gesture_check_recognized (gesture, sequence))
        g_signal_emit (gesture, signals[UPDATE], 0, sequence);
      break;
565
    case GDK_TOUCH_CANCEL:
566
      _gtk_gesture_cancel_sequence (gesture, sequence);
567
      break;
568 569 570 571 572 573
    case GDK_GRAB_BROKEN:
      if (!event->grab_broken.grab_window ||
          !gesture_within_window (gesture, event->grab_broken.grab_window))
        _gtk_gesture_cancel_all (gesture);

      return FALSE;
Carlos Garnacho's avatar
Carlos Garnacho committed
574 575 576 577 578 579 580 581 582 583 584
    default:
      /* Unhandled event */
      return FALSE;
    }

  if (gtk_gesture_get_sequence_state (gesture, sequence) != GTK_EVENT_SEQUENCE_CLAIMED)
    return FALSE;

  return priv->recognized;
}

585 586 587 588 589 590
static void
gtk_gesture_reset (GtkEventController *controller)
{
  _gtk_gesture_cancel_all (GTK_GESTURE (controller));
}

Carlos Garnacho's avatar
Carlos Garnacho committed
591 592 593 594 595 596 597 598 599 600 601
static void
gtk_gesture_class_init (GtkGestureClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);
  GtkEventControllerClass *controller_class = GTK_EVENT_CONTROLLER_CLASS (klass);

  object_class->get_property = gtk_gesture_get_property;
  object_class->set_property = gtk_gesture_set_property;
  object_class->finalize = gtk_gesture_finalize;

  controller_class->handle_event = gtk_gesture_handle_event;
602
  controller_class->reset = gtk_gesture_reset;
Carlos Garnacho's avatar
Carlos Garnacho committed
603 604 605

  klass->check = gtk_gesture_check_impl;

606 607 608 609 610 611 612 613
  /**
   * GtkGesture:n-points:
   *
   * The number of touch points that trigger recognition on this gesture,
   * 
   *
   * Since: 3.14
   */
Carlos Garnacho's avatar
Carlos Garnacho committed
614 615 616 617 618 619 620 621
  g_object_class_install_property (object_class,
                                   PROP_N_POINTS,
                                   g_param_spec_uint ("n-points",
                                                      P_("Number of points"),
                                                      P_("Number of points needed "
                                                         "to trigger the gesture"),
                                                      1, G_MAXUINT, 1,
                                                      GTK_PARAM_READWRITE |
622 623 624 625 626 627 628 629 630
						      G_PARAM_CONSTRUCT_ONLY));
  /**
   * GtkGesture:window:
   *
   * If non-%NULL, the gesture will only listen for events that happen on
   * this #GdkWindow, or a child of it.
   *
   * Since: 3.14
   */
631 632
  g_object_class_install_property (object_class,
                                   PROP_WINDOW,
633 634 635 636 637
                                   g_param_spec_object ("window",
                                                        P_("GdkWindow to receive events about"),
                                                        P_("GdkWindow to receive events about"),
                                                        GDK_TYPE_WINDOW,
                                                        GTK_PARAM_READWRITE));
638
  /**
Carlos Garnacho's avatar
Carlos Garnacho committed
639
   * GtkGesture::begin:
640 641 642 643
   * @gesture: the object which received the signal
   * @sequence: the #GdkEventSequence that made the gesture to be recognized
   *
   * This signal is emitted when the gesture is recognized. This means the
Carlos Garnacho's avatar
Carlos Garnacho committed
644
   * number of touch sequences matches #GtkGesture:n-points, and the #GtkGesture::check
645 646 647 648 649 650 651 652
   * handler(s) returned #TRUE.
   *
   * Note: These conditions may also happen when an extra touch (eg. a third touch
   * on a 2-touches gesture) is lifted, in that situation @sequence won't pertain
   * to the current set of active touches, so don't rely on this being true.
   *
   * Since: 3.14
   */
Carlos Garnacho's avatar
Carlos Garnacho committed
653 654 655 656 657 658 659
  signals[BEGIN] =
    g_signal_new ("begin",
                  G_TYPE_FROM_CLASS (klass),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (GtkGestureClass, begin),
                  NULL, NULL, NULL,
                  G_TYPE_NONE, 1, G_TYPE_POINTER);
660
  /**
Carlos Garnacho's avatar
Carlos Garnacho committed
661
   * GtkGesture::end:
662 663 664 665
   * @gesture: the object which received the signal
   * @sequence: the #GdkEventSequence that made gesture recognition to finish.
   *
   * This signal is emitted when @gesture either stopped recognizing the event
Carlos Garnacho's avatar
Carlos Garnacho committed
666
   * sequences as something to be handled (the #GtkGesture::check handler returned
667 668 669
   * #FALSE), or the number of touch sequences became higher or lower than
   * #GtkGesture:n-points.
   *
670 671 672 673 674
   * Note: @sequence might not pertain to the group of sequences that were
   * previously triggering recognition on @gesture (ie. a just pressed touch
   * sequence that exceeds #GtkGesture:n-points). This situation may be detected
   * by checking through gtk_gesture_handles_sequence().
   *
675 676
   * Since: 3.14
   */
Carlos Garnacho's avatar
Carlos Garnacho committed
677 678 679 680 681 682 683
  signals[END] =
    g_signal_new ("end",
                  G_TYPE_FROM_CLASS (klass),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (GtkGestureClass, end),
                  NULL, NULL, NULL,
                  G_TYPE_NONE, 1, G_TYPE_POINTER);
684
  /**
Carlos Garnacho's avatar
Carlos Garnacho committed
685
   * GtkGesture::update:
686 687 688 689 690 691 692 693
   * @gesture: the object which received the signal
   * @sequence: the #GdkEventSequence that was updated.
   *
   * This signal is emitted whenever an event is handled while the gesture is
   * recognized. @sequence is guaranteed to pertain to the set of active touches.
   *
   * Since: 3.14
   */
Carlos Garnacho's avatar
Carlos Garnacho committed
694 695 696 697 698 699 700
  signals[UPDATE] =
    g_signal_new ("update",
                  G_TYPE_FROM_CLASS (klass),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (GtkGestureClass, update),
                  NULL, NULL, NULL,
                  G_TYPE_NONE, 1, G_TYPE_POINTER);
701
  /**
Carlos Garnacho's avatar
Carlos Garnacho committed
702
   * GtkGesture::cancel:
703 704 705 706 707 708 709 710 711 712 713 714
   * @gesture: the object which received the signal
   * @sequence: the #GdkEventSequence that was cancelled.
   *
   * This signal is emitted whenever a sequence is cancelled. This usually
   * happens on active touches when gtk_event_controller_reset() is called
   * on @gesture (manually, due to grabs...), or the individual @sequence
   * was claimed by parent widgets' controllers (see gtk_gesture_set_sequence_state()).
   *
   * @gesture must forget everything about @sequence as a reaction to this signal.
   *
   * Since: 3.14
   */
715 716 717 718 719 720 721
  signals[CANCEL] =
    g_signal_new ("cancel",
                  G_TYPE_FROM_CLASS (klass),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (GtkGestureClass, cancel),
                  NULL, NULL, NULL,
                  G_TYPE_NONE, 1, G_TYPE_POINTER);
722
  /**
Carlos Garnacho's avatar
Carlos Garnacho committed
723
   * GtkGesture::sequence-state-changed:
724 725 726 727 728 729 730 731 732 733
   * @gesture: the object which received the signal
   * @sequence: the #GdkEventSequence that was cancelled.
   * @state: the new sequence state
   *
   * This signal is emitted whenever a sequence state changes. See
   * gtk_gesture_set_sequence_state() to know more about the expectable
   * sequence lifetimes.
   *
   * Since: 3.14
   */
Carlos Garnacho's avatar
Carlos Garnacho committed
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
  signals[SEQUENCE_STATE_CHANGED] =
    g_signal_new ("sequence-state-changed",
                  G_TYPE_FROM_CLASS (klass),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (GtkGestureClass, sequence_state_changed),
                  NULL, NULL, NULL,
                  G_TYPE_NONE, 2, G_TYPE_POINTER,
                  GTK_TYPE_EVENT_SEQUENCE_STATE);
}

static void
gtk_gesture_init (GtkGesture *gesture)
{
  GtkGesturePrivate *priv;

  priv = gtk_gesture_get_instance_private (gesture);
  priv->points = g_hash_table_new_full (NULL, NULL, NULL,
                                        (GDestroyNotify) g_free);
752 753
  gtk_event_controller_set_event_mask (GTK_EVENT_CONTROLLER (gesture),
                                       GDK_TOUCH_MASK);
754 755

  priv->group_link = g_list_prepend (NULL, gesture);
Carlos Garnacho's avatar
Carlos Garnacho committed
756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
}

/**
 * gtk_gesture_get_device:
 * @gesture: a #GtkGesture
 *
 * Returns the master #GdkDevice that is currently operating
 * on @gesture, or %NULL if the gesture is not being interacted.
 *
 * Returns: a #GdkDevice, or %NULL.
 *
 * Since: 3.14
 **/
GdkDevice *
gtk_gesture_get_device (GtkGesture *gesture)
{
  GtkGesturePrivate *priv;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), NULL);

  priv = gtk_gesture_get_instance_private (gesture);

  return priv->device;
}

/**
 * gtk_gesture_get_sequence_state:
 * @gesture: a #GtkGesture
 * @sequence: a #GdkEventSequence
 *
 * Returns the @sequence state, as seen by @gesture.
 *
 * Returns: The sequence state in @gesture.
 *
 * Since: 3.14
 **/
GtkEventSequenceState
gtk_gesture_get_sequence_state (GtkGesture       *gesture,
                                GdkEventSequence *sequence)
{
  GtkGesturePrivate *priv;
  PointData *data;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture),
                        GTK_EVENT_SEQUENCE_NONE);

  priv = gtk_gesture_get_instance_private (gesture);
  data = g_hash_table_lookup (priv->points, sequence);

  if (!data)
    return GTK_EVENT_SEQUENCE_NONE;

  return data->state;
}

/**
 * gtk_gesture_set_sequence_state:
 * @gesture: a #GtkGesture
 * @sequence: a #GdkEventSequence
 * @state: the sequence state
 *
817 818 819 820 821 822
 * Sets the state of @sequence in @gesture. Sequences start
 * in state #GTK_EVENT_SEQUENCE_NONE, and whenever they change
 * state, they can never go back to that state. Likewise,
 * sequences in state #GTK_EVENT_SEQUENCE_DENIED cannot turn
 * back to a not denied state. With these rules, the lifetime
 * of an event sequence is constrained to the next four:
Carlos Garnacho's avatar
Carlos Garnacho committed
823
 *
824 825 826 827 828 829 830
 * * None
 * * None → Denied
 * * None → Claimed
 * * None → Claimed → Denied
 *
 * Returns: #TRUE if @sequence is handled by @gesture,
 *          and the state is changed successfully.
Carlos Garnacho's avatar
Carlos Garnacho committed
831 832 833 834 835 836 837 838 839 840 841
 *
 * Since: 3.14
 **/
gboolean
gtk_gesture_set_sequence_state (GtkGesture            *gesture,
                                GdkEventSequence      *sequence,
                                GtkEventSequenceState  state)
{
  GtkGesturePrivate *priv;
  PointData *data;

842 843 844
  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);
  g_return_val_if_fail (state >= GTK_EVENT_SEQUENCE_NONE &&
                        state <= GTK_EVENT_SEQUENCE_DENIED, FALSE);
Carlos Garnacho's avatar
Carlos Garnacho committed
845 846 847 848

  priv = gtk_gesture_get_instance_private (gesture);
  data = g_hash_table_lookup (priv->points, sequence);

849
  if (!data)
Carlos Garnacho's avatar
Carlos Garnacho committed
850 851
    return FALSE;

852
  if (data->state == state)
853
    return FALSE;
854

855 856 857 858 859 860 861 862 863
  /* denied sequences remain denied */
  if (data->state == GTK_EVENT_SEQUENCE_DENIED)
    return FALSE;

  /* Sequences can't go from claimed/denied to none */
  if (state == GTK_EVENT_SEQUENCE_NONE &&
      data->state != GTK_EVENT_SEQUENCE_NONE)
    return FALSE;

Carlos Garnacho's avatar
Carlos Garnacho committed
864 865
  data->state = state;
  g_signal_emit (gesture, signals[SEQUENCE_STATE_CHANGED], 0,
866
                 sequence, state);
867 868 869 870

  if (state == GTK_EVENT_SEQUENCE_DENIED)
    _gtk_gesture_check_recognized (gesture, sequence);

Carlos Garnacho's avatar
Carlos Garnacho committed
871 872 873
  return TRUE;
}

874 875 876 877 878 879 880 881 882 883 884 885 886 887
/**
 * gtk_gesture_set_state:
 * @gesture: a #GtkGesture
 * @state: the sequence state
 *
 * Sets the state of all sequences that @gesture is currently
 * interacting with. See gtk_gesture_set_sequence_state()
 * for more details on sequence states.
 *
 * Returns: %TRUE if the state of at least one sequence
 *     was changed successfully.
 *
 * Since: 3.14
 */
888 889 890 891 892 893
gboolean
gtk_gesture_set_state (GtkGesture            *gesture,
                       GtkEventSequenceState  state)
{
  gboolean handled = FALSE;
  GtkGesturePrivate *priv;
894
  GList *sequences, *l;
895 896 897 898 899 900

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);
  g_return_val_if_fail (state >= GTK_EVENT_SEQUENCE_NONE &&
                        state <= GTK_EVENT_SEQUENCE_DENIED, FALSE);

  priv = gtk_gesture_get_instance_private (gesture);
901
  sequences = g_hash_table_get_keys (priv->points);
902

903 904 905 906
  for (l = sequences; l; l = l->next)
    handled |= gtk_gesture_set_sequence_state (gesture, l->data, state);

  g_list_free (sequences);
907 908 909 910

  return handled;
}

Carlos Garnacho's avatar
Carlos Garnacho committed
911 912 913 914
/**
 * gtk_gesture_get_sequences:
 * @gesture: a #GtkGesture
 *
915
 * Returns the list of #GdkEventSequences currently being interpreted
Carlos Garnacho's avatar
Carlos Garnacho committed
916 917
 * by @gesture
 *
Carlos Garnacho's avatar
Carlos Garnacho committed
918
 * Returns: (transfer container) (element-type GdkEventSequence): A list
919
 *          of #GdkEventSequences, the list elements are owned by GTK+
Carlos Garnacho's avatar
Carlos Garnacho committed
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972
 *          and must not be freed or modified, the list itself must be deleted
 *          through g_list_free()
 **/
GList *
gtk_gesture_get_sequences (GtkGesture *gesture)
{
  GdkEventSequence *sequence;
  GtkGesturePrivate *priv;
  GList *sequences = NULL;
  GHashTableIter iter;
  PointData *data;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), NULL);

  priv = gtk_gesture_get_instance_private (gesture);
  g_hash_table_iter_init (&iter, priv->points);

  while (g_hash_table_iter_next (&iter, (gpointer *) &sequence, (gpointer *) &data))
    {
      if (data->state == GTK_EVENT_SEQUENCE_DENIED)
        continue;
      if (data->event->type == GDK_TOUCH_END ||
          data->event->type == GDK_BUTTON_RELEASE)
        continue;

      sequences = g_list_prepend (sequences, sequence);
    }

  return sequences;
}

/**
 * gtk_gesture_get_last_updated_sequence:
 * @gesture: a #GtkGesture
 *
 * Returns the #GdkEventSequence that was last updated on @gesture.
 *
 * Returns: The last updated sequence.
 *
 * Since: 3.14
 **/
GdkEventSequence *
gtk_gesture_get_last_updated_sequence (GtkGesture *gesture)
{
  GtkGesturePrivate *priv;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), NULL);

  priv = gtk_gesture_get_instance_private (gesture);

  return priv->last_sequence;
}

Carlos Garnacho's avatar
Carlos Garnacho committed
973 974 975 976 977 978 979 980 981
/**
 * gtk_gesture_get_last_event:
 * @gesture: a #GtkGesture
 * @sequence: a #GdkEventSequence
 *
 * Returns the last event that was processed for @sequence.
 *
 * Returns: (transfer none): The last event from @sequence
 **/
Carlos Garnacho's avatar
Carlos Garnacho committed
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
const GdkEvent *
gtk_gesture_get_last_event (GtkGesture       *gesture,
                            GdkEventSequence *sequence)
{
  GtkGesturePrivate *priv;
  PointData *data;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), NULL);

  priv = gtk_gesture_get_instance_private (gesture);
  data = g_hash_table_lookup (priv->points, sequence);

  if (!data)
    return NULL;

  return data->event;
}

/**
 * gtk_gesture_get_point:
 * @gesture: a #GtkGesture
 * @sequence: (allow-none): a #GdkEventSequence, or %NULL for pointer events
 * @x: (out) (allow-none): return location for X axis of the sequence coordinates
 * @y: (out) (allow-none): return location for Y axis of the sequence coordinates
 *
 * If @sequence is currently being interpreted by @gesture, this
 * function returns %TRUE and fills in @x and @y with the last coordinates
1009 1010
 * stored for that event sequence. The coordinates are always relative to the
 * widget allocation.
Carlos Garnacho's avatar
Carlos Garnacho committed
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
 *
 * Returns: %TRUE if @sequence is currently interpreted
 *
 * Since: 3.14
 **/
gboolean
gtk_gesture_get_point (GtkGesture       *gesture,
                       GdkEventSequence *sequence,
                       gdouble          *x,
                       gdouble          *y)
{
  GtkGesturePrivate *priv;
  PointData *data;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);

  priv = gtk_gesture_get_instance_private (gesture);

  if (!g_hash_table_lookup_extended (priv->points, sequence,
                                     NULL, (gpointer *) &data))
    return FALSE;

1033 1034 1035 1036 1037 1038
  if (x)
    *x = data->widget_x;
  if (y)
    *y = data->widget_y;

  return TRUE;
Carlos Garnacho's avatar
Carlos Garnacho committed
1039 1040 1041
}

gboolean
1042 1043 1044
_gtk_gesture_get_last_update_time (GtkGesture       *gesture,
                                   GdkEventSequence *sequence,
                                   guint32          *evtime)
Carlos Garnacho's avatar
Carlos Garnacho committed
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175
{
  GtkGesturePrivate *priv;
  PointData *data;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);

  priv = gtk_gesture_get_instance_private (gesture);

  if (!g_hash_table_lookup_extended (priv->points, sequence,
                                     NULL, (gpointer *) &data))
    return FALSE;

  if (evtime)
    *evtime = gdk_event_get_time (data->event);

  return TRUE;
};

/**
 * gtk_gesture_get_bounding_box:
 * @gesture: a #GtkGesture
 * @rect: (out): bounding box containing all active touches.
 *
 * If there are touch sequences being currently handled by @gesture,
 * this function returns #TRUE and fills in @rect with the bounding
 * box containing all active touches. Otherwise, #FALSE will be
 * returned.
 *
 * Returns: #TRUE if there are active touches, #FALSE otherwise
 *
 * Since: 3.14
 **/
gboolean
gtk_gesture_get_bounding_box (GtkGesture   *gesture,
                              GdkRectangle *rect)
{
  GtkGesturePrivate *priv;
  gdouble x1, y1, x2, y2;
  GHashTableIter iter;
  guint n_points = 0;
  PointData *data;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);
  g_return_val_if_fail (rect != NULL, FALSE);

  priv = gtk_gesture_get_instance_private (gesture);
  x1 = y1 = G_MAXDOUBLE;
  x2 = y2 = -G_MAXDOUBLE;

  g_hash_table_iter_init (&iter, priv->points);

  while (g_hash_table_iter_next (&iter, NULL, (gpointer *) &data))
    {
      gdouble x, y;

      if (data->state == GTK_EVENT_SEQUENCE_DENIED)
        continue;
      if (data->event->type == GDK_TOUCH_END ||
          data->event->type == GDK_BUTTON_RELEASE)
        continue;

      gdk_event_get_coords (data->event, &x, &y);
      n_points++;
      x1 = MIN (x1, x);
      y1 = MIN (y1, y);
      x2 = MAX (x2, x);
      y2 = MAX (y2, y);
    }

  if (n_points == 0)
    return FALSE;

  rect->x = x1;
  rect->y = y1;
  rect->width = x2 - x1;
  rect->height = y2 - y1;

  return TRUE;
}


/**
 * gtk_gesture_get_bounding_box_center:
 * @gesture: a #GtkGesture
 * @x: (out): X coordinate for the bounding box center
 * @y: (out): Y coordinate for the bounding box center
 *
 * If there are touch sequences being currently handled by @gesture,
 * this function returns #TRUE and fills in @x and @y with the center
 * of the bounding box containing all active touches. Otherwise, #FALSE
 * will be returned.
 *
 * Returns: #FALSE if no active touches are present, #TRUE otherwise
 *
 * Since: 3.14
 **/
gboolean
gtk_gesture_get_bounding_box_center (GtkGesture *gesture,
                                     gdouble    *x,
                                     gdouble    *y)
{
  GdkRectangle rect;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);
  g_return_val_if_fail (x != NULL && y != NULL, FALSE);

  if (!gtk_gesture_get_bounding_box (gesture, &rect))
    return FALSE;

  *x = rect.x + rect.width / 2;
  *y = rect.y + rect.height / 2;
  return TRUE;
}

/**
 * gtk_gesture_is_active:
 * @gesture: a #GtkGesture
 *
 * Returns %TRUE if the gesture is currently active.
 * A gesture is active meanwhile there are touch sequences
 * interacting with it.
 *
 * Returns: %TRUE if gesture is active.
 *
 * Since: 3.14
 **/
gboolean
gtk_gesture_is_active (GtkGesture *gesture)
{
  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);

1176
  return _gtk_gesture_effective_n_points (gesture) != 0;
Carlos Garnacho's avatar
Carlos Garnacho committed
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
}

/**
 * gtk_gesture_is_recognized:
 * @gesture: a #GtkGesture
 *
 * Returns %TRUE if the gesture is currently recognized.
 * A gesture is recognized if there are as many interacting
 * touch sequences as required by @gesture, and #GtkGesture::check
 * returned #TRUE for the sequences being currently interpreted.
 *
 * Returns: %TRUE if gesture is recognized.
 *
 * Since: 3.14
 **/
gboolean
gtk_gesture_is_recognized (GtkGesture *gesture)
{
  GtkGesturePrivate *priv;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);

  priv = gtk_gesture_get_instance_private (gesture);

  return priv->recognized;
}

gboolean
1205
_gtk_gesture_check (GtkGesture *gesture)
Carlos Garnacho's avatar
Carlos Garnacho committed
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
{
  GtkGesturePrivate *priv;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);

  priv = gtk_gesture_get_instance_private (gesture);

  return _gtk_gesture_check_recognized (gesture, priv->last_sequence);
}

/**
 * gtk_gesture_handles_sequence:
 * @gesture: a #GtkGesture
 * @sequence: a #GdkEventSequence
 *
 * Returns #TRUE if @gesture is currently handling events corresponding to
 * @sequence.
 *
 * Returns: #TRUE if @gesture is handling @sequence.
 *
 * Since: 3.14
 **/
gboolean
gtk_gesture_handles_sequence (GtkGesture       *gesture,
                              GdkEventSequence *sequence)
{
  GtkGesturePrivate *priv;
1233
  PointData *data;
Carlos Garnacho's avatar
Carlos Garnacho committed
1234 1235 1236 1237

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);

  priv = gtk_gesture_get_instance_private (gesture);
1238
  data = g_hash_table_lookup (priv->points, sequence);
Carlos Garnacho's avatar
Carlos Garnacho committed
1239

1240 1241 1242 1243 1244 1245 1246
  if (!data)
    return FALSE;

  if (data->state == GTK_EVENT_SEQUENCE_DENIED)
    return FALSE;

  return TRUE;
Carlos Garnacho's avatar
Carlos Garnacho committed
1247
}
1248 1249

gboolean
1250 1251
_gtk_gesture_cancel_sequence (GtkGesture       *gesture,
                              GdkEventSequence *sequence)
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
{
  GtkGesturePrivate *priv;
  PointData *data;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);

  priv = gtk_gesture_get_instance_private (gesture);
  data = g_hash_table_lookup (priv->points, sequence);

  if (!data)
    return FALSE;

  g_signal_emit (gesture, signals[CANCEL], 0, sequence);
  _gtk_gesture_check_recognized (gesture, sequence);
  _gtk_gesture_remove_point (gesture, data->event);
  return TRUE;
}
1269

1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
/**
 * gtk_gesture_get_window:
 * @gesture: a #GtkGesture
 *
 * Returns the user-defined window that receives the events
 * handled by @gesture. See gtk_gesture_set_window() for more
 * information.
 *
 * Returns: the user defined window, or %NULL if none.
 *
 * Since: 3.14
 **/
GdkWindow *
gtk_gesture_get_window (GtkGesture *gesture)
{
  GtkGesturePrivate *priv;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), NULL);

  priv = gtk_gesture_get_instance_private (gesture);

  return priv->user_window;
}

/**
 * gtk_gesture_set_window:
 * @gesture: a #GtkGesture
 * @window: (allow-none): a #GdkWindow, or %NULL
 *
 * Sets a specific window to receive events about, so @gesture
 * will effectively handle only events targeting @window, or
 * a child of it. @window must pertain to gtk_event_controller_get_widget().
 *
 * Since: 3.14
 **/
void
gtk_gesture_set_window (GtkGesture *gesture,
                        GdkWindow  *window)
{
  GtkGesturePrivate *priv;

  g_return_if_fail (GTK_IS_GESTURE (gesture));
  g_return_if_fail (!window || GDK_IS_WINDOW (window));

  priv = gtk_gesture_get_instance_private (gesture);

  if (window)
    {
      GtkWidget *window_widget;

      gdk_window_get_user_data (window, (gpointer*) &window_widget);
      g_return_if_fail (window_widget !=
                        gtk_event_controller_get_widget (GTK_EVENT_CONTROLLER (gesture)));
    }

  if (priv->user_window == window)
    return;

  priv->user_window = window;
  g_object_notify (G_OBJECT (gesture), "window");
}

1332 1333 1334 1335 1336 1337 1338 1339 1340 1341
GList *
_gtk_gesture_get_group_link (GtkGesture *gesture)
{
  GtkGesturePrivate *priv;

  priv = gtk_gesture_get_instance_private (gesture);

  return priv->group_link;
}

1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
/**
 * gtk_gesture_group:
 * @gesture: a #GtkGesture
 * @group_gesture: #GtkGesture to group @gesture with
 *
 * Adds @gesture to the same group than @group_gesture. Gestures
 * are by default isolated in their own groups.
 *
 * When gestures are grouped, the state of #GdkEventSequences
 * is kept in sync for all of those, so calling gtk_gesture_set_sequence_state(),
 * on one will transfer the same value to the others.
 *
 * Groups also perform an "implicit grabbing" of sequences, if a
 * #GdkEventSequence state is set to #GTK_EVENT_SEQUENCE_CLAIMED on one group,
 * every other gesture group attached to the same #GtkWidget will switch the
 * state for that sequence to #GTK_EVENT_SEQUENCE_DENIED.
 *
 * Since: 3.14
 **/
1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391
void
gtk_gesture_group (GtkGesture *gesture,
                   GtkGesture *group_gesture)
{
  GList *link, *group_link, *next;

  g_return_if_fail (GTK_IS_GESTURE (gesture));
  g_return_if_fail (GTK_IS_GESTURE (group_gesture));
  g_return_if_fail (gtk_event_controller_get_widget (GTK_EVENT_CONTROLLER (group_gesture)) ==
                    gtk_event_controller_get_widget (GTK_EVENT_CONTROLLER (gesture)));

  link = _gtk_gesture_get_group_link (gesture);

  if (link->prev || link->next)
    {
      if (gtk_gesture_is_grouped_with (gesture, group_gesture))
        return;
      gtk_gesture_ungroup (gesture);
    }

  group_link = _gtk_gesture_get_group_link (group_gesture);
  next = group_link->next;

  /* Rewire link so it's inserted after the group_gesture elem */
  link->prev = group_link;
  link->next = next;
  group_link->next = link;
  if (next)
    next->prev = link;
}

1392 1393 1394 1395
/**
 * gtk_gesture_ungroup:
 * @gesture: a #GtkGesture
 *
Carlos Garnacho's avatar
Carlos Garnacho committed
1396
 * Separates @gesture into an isolated group.
1397 1398 1399
 *
 * Since: 3.14
 **/
1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419
void
gtk_gesture_ungroup (GtkGesture *gesture)
{
  GList *link, *prev, *next;

  g_return_if_fail (GTK_IS_GESTURE (gesture));

  link = _gtk_gesture_get_group_link (gesture);
  prev = link->prev;
  next = link->next;

  /* Detach link from the group chain */
  if (prev)
    prev->next = next;
  if (next)
    next->prev = prev;

  link->next = link->prev = NULL;
}

1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430
/**
 * gtk_gesture_get_group:
 * @gesture: a #GtkGesture
 *
 * Returns all gestures in the group of @gesture
 *
 * Returns: (element-type GtkGesture) (transfer container): The list
 *   of #GtkGestures, free with g_list_free().
 *
 * Since: 3.14
 **/
1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442
GList *
gtk_gesture_get_group (GtkGesture *gesture)
{
  GList *link;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), NULL);

  link = _gtk_gesture_get_group_link (gesture);

  return g_list_copy (g_list_first (link));
}

1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453
/**
 * gtk_gesture_is_grouped_with:
 * @gesture: a #GtkGesture
 * @other: another #GtkGesture
 *
 * Returns #TRUE if both gestures pertain to the same group.
 *
 * Returns: whether the gestures are grouped
 *
 * Since: 3.14
 **/
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468
gboolean
gtk_gesture_is_grouped_with (GtkGesture *gesture,
                             GtkGesture *other)
{
  GList *link;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);
  g_return_val_if_fail (GTK_IS_GESTURE (other), FALSE);

  link = _gtk_gesture_get_group_link (gesture);
  link = g_list_first (link);

  return g_list_find (link, other) != NULL;
}

1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485
gboolean
_gtk_gesture_handled_sequence_press (GtkGesture       *gesture,
                                     GdkEventSequence *sequence)
{
  GtkGesturePrivate *priv;
  PointData *data;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);

  priv = gtk_gesture_get_instance_private (gesture);
  data = g_hash_table_lookup (priv->points, sequence);

  if (!data)
    return FALSE;

  return data->press_handled;
}
1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522

gboolean
_gtk_gesture_get_pointer_emulating_sequence (GtkGesture        *gesture,
                                             GdkEventSequence **sequence)
{
  GtkGesturePrivate *priv;
  GdkEventSequence *seq;
  GHashTableIter iter;
  PointData *data;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);

  priv = gtk_gesture_get_instance_private (gesture);
  g_hash_table_iter_init (&iter, priv->points);

  while (g_hash_table_iter_next (&iter, (gpointer*) &seq, (gpointer*) &data))
    {
      switch (data->event->type)
        {
        case GDK_TOUCH_BEGIN:
        case GDK_TOUCH_UPDATE:
        case GDK_TOUCH_END:
          if (!data->event->touch.emulating_pointer)
            continue;
          /* Fall through */
        case GDK_BUTTON_PRESS:
        case GDK_BUTTON_RELEASE:
        case GDK_MOTION_NOTIFY:
          *sequence = seq;
          return TRUE;
        default:
          break;
        }
    }

  return FALSE;
}
1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546

/**
 * gtk_gesture_attach:
 * @gesture: a #GtkGesture
 * @phase: phase at which events are handled
 *
 * Attaches @gesture to its widget, so @gesture is able to receive
 * and manage the events that are emitted on the #GtkWidget. This call
 * will also make sure that the gesture state is maintained properly
 * whenever input is grabbed elsewhere.
 *
 * If @phase is %GTK_PHASE_NONE, no automatical event handling will be
 * performed, but other additional gesture maintenance will. The events
 * can be managed by calling gtk_event_controller_handle_event().
 *
 * Since: 3.14
 **/
void
gtk_gesture_attach (GtkGesture          *gesture,
                    GtkPropagationPhase  phase)
{
  GtkWidget *widget;

  g_return_if_fail (GTK_IS_GESTURE (gesture));
1547
  g_return_if_fail (phase >= GTK_PHASE_NONE && phase <= GTK_PHASE_TARGET);
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570

  widget = gtk_event_controller_get_widget (GTK_EVENT_CONTROLLER (gesture));
  _gtk_widget_add_controller (widget, GTK_EVENT_CONTROLLER (gesture), phase);
}

/**
 * gtk_gesture_detach:
 * @gesture: a #GtkGesture
 *
 * Detaches @gesture from its widget.
 *
 * Since: 3.14
 **/
void
gtk_gesture_detach (GtkGesture *gesture)
{
  GtkWidget *widget;

  g_return_if_fail (GTK_IS_GESTURE (gesture));

  widget = gtk_event_controller_get_widget (GTK_EVENT_CONTROLLER (gesture));
  _gtk_widget_remove_controller (widget, GTK_EVENT_CONTROLLER (gesture));
}