gtkdragsource.c 24.2 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1999 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * 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/>.
 */

/*
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

#include "config.h"

27
#include "gtkdragsourceprivate.h"
28
29

#include "gtkgesturedrag.h"
Matthias Clasen's avatar
Matthias Clasen committed
30
#include "gtkgesturesingleprivate.h"
31
#include "gtkimagedefinitionprivate.h"
Matthias Clasen's avatar
Matthias Clasen committed
32
33
#include "gtknative.h"
#include "gtkwidgetprivate.h"
34
#include "gtkintl.h"
Matthias Clasen's avatar
Matthias Clasen committed
35
#include "gtkimageprivate.h"
36
#include "gtkdragicon.h"
Matthias Clasen's avatar
Matthias Clasen committed
37
38
#include "gtkprivate.h"
#include "gtkmarshalers.h"
39
40
#include "gtkicontheme.h"
#include "gtkpicture.h"
41
#include "gtksettingsprivate.h"
Matthias Clasen's avatar
Matthias Clasen committed
42
#include "gtkgesturesingle.h"
43

Matthias Clasen's avatar
Matthias Clasen committed
44
45
/**
 * SECTION:gtkdragsource
Matthias Clasen's avatar
Matthias Clasen committed
46
 * @Short_description: Event controller to initiate DND operations
Matthias Clasen's avatar
Matthias Clasen committed
47
48
49
50
51
52
53
 * @Title: GtkDragSource
 *
 * GtkDragSource is an auxiliary object that is used to initiate
 * Drag-And-Drop operations. It can be set up with the necessary
 * ingredients for a DND operation ahead of time. This includes
 * the source for the data that is being transferred, in the form
 * of a #GdkContentProvider, the desired action, and the icon to
Matthias Clasen's avatar
Matthias Clasen committed
54
55
56
 * use during the drag operation. After setting it up, the drag
 * source must be added to a widget as an event controller, using
 * gtk_widget_add_controller().
Matthias Clasen's avatar
Matthias Clasen committed
57
 *
58
59
60
61
62
63
64
65
66
67
68
69
70
 * |[<!-- language="C" -->
 * static void
 * my_widget_init (MyWidget *self)
 * {
 *   GtkDragSource *drag_source = gtk_drag_source_new ();
 *
 *   g_signal_connect (drag_source, "prepare", G_CALLBACK (on_drag_prepare), self);
 *   g_signal_connect (drag_source, "drag-begin", G_CALLBACK (on_drag_begin), self);
 *
 *   gtk_widget_add_controller (GTK_WIDGET (self), GTK_EVENT_CONTROLLER (drag_source));
 * }
 * ]|
 *
Matthias Clasen's avatar
Matthias Clasen committed
71
72
73
74
 * Setting up the content provider and icon ahead of time only
 * makes sense when the data does not change. More commonly, you
 * will want to set them up just in time. To do so, #GtkDragSource
 * has #GtkDragSource::prepare and #GtkDragSource::drag-begin signals.
75
 *
Matthias Clasen's avatar
Matthias Clasen committed
76
77
 * The ::prepare signal is emitted before a drag is started, and
 * can be used to set the content provider and actions that the
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 * drag should be started with.
 *
 * |[<!-- language="C" -->
 * static GdkContentProvider *
 * on_drag_prepare (GtkDragSource *source,
 *                  double         x,
 *                  double         y,
 *                  MyWidget      *self)
 * {
 *   // This widget supports two types of content: GFile objects
 *   // and GdkPixbuf objects; GTK will handle the serialization
 *   // of these types automatically
 *   GFile *file = my_widget_get_file (self);
 *   GdkPixbuf *pixbuf = my_widget_get_pixbuf (self);
 *
 *   return gdk_content_provider_new_union ((GdkContentProvider *[2]) {
 *       gdk_content_provider_new_typed (G_TYPE_FILE, file),
 *       gdk_content_provider_new_typed (GDK_TYPE_PIXBUF, pixbuf),
 *     }, 2);
 * }
 * ]|
 *
 * The ::drag-begin signal is emitted after the #GdkDrag object has
 * been created, and can be used to set up the drag icon.
 *
 * |[<!-- language="C" -->
 * static void
 * on_drag_begin (GtkDragSource *source,
 *                GtkDrag       *drag,
 *                MyWidget      *self)
 * {
 *   // Set the widget as the drag icon
 *   GdkPaintable *paintable = gtk_widget_paintable_new (GTK_WIDGET (self));
 *   gtk_drag_source_set_icon (source, paintable, 0, 0);
 *   g_object_unref (paintable);
 * }
 * ]|
Matthias Clasen's avatar
Matthias Clasen committed
115
116
117
118
119
 *
 * During the DND operation, GtkDragSource emits signals that
 * can be used to obtain updates about the status of the operation,
 * but it is not normally necessary to connect to any signals,
 * except for one case: when the supported actions include
120
 * %GDK_ACTION_MOVE, you need to listen for the
Matthias Clasen's avatar
Matthias Clasen committed
121
122
 * #GtkDragSource::drag-end signal and delete the
 * data after it has been transferred.
Matthias Clasen's avatar
Matthias Clasen committed
123
124
125
126
 */

struct _GtkDragSource
{
Matthias Clasen's avatar
Matthias Clasen committed
127
  GtkGestureSingle parent_instance;
Matthias Clasen's avatar
Matthias Clasen committed
128
129
130
131
132
133
134
135

  GdkContentProvider *content;
  GdkDragAction actions;

  GdkPaintable *paintable;
  int hot_x;
  int hot_y;

136
137
  double start_x;
  double start_y;
Matthias Clasen's avatar
Matthias Clasen committed
138
139
140
141
142
143

  GdkDrag *drag;
};

struct _GtkDragSourceClass
{
Matthias Clasen's avatar
Matthias Clasen committed
144
  GtkGestureSingleClass parent_class;
145

146
147
148
  GdkContentProvider *(* prepare) (GtkDragSource *source,
                                  double         x,
                                  double         y);
Matthias Clasen's avatar
Matthias Clasen committed
149
150
151
152
153
154
155
156
157
158
159
};

enum {
  PROP_CONTENT = 1,
  PROP_ACTIONS,
  NUM_PROPERTIES
};

static GParamSpec *properties[NUM_PROPERTIES];

enum {
160
  PREPARE,
Matthias Clasen's avatar
Matthias Clasen committed
161
162
  DRAG_BEGIN,
  DRAG_END,
163
  DRAG_CANCEL,
Matthias Clasen's avatar
Matthias Clasen committed
164
165
166
167
168
  NUM_SIGNALS
};

static guint signals[NUM_SIGNALS];

169
170
171
172
173
174
static void gtk_drag_source_dnd_finished_cb   (GdkDrag             *drag,
                                               GtkDragSource       *source);
static void gtk_drag_source_cancel_cb         (GdkDrag             *drag,
                                               GdkDragCancelReason  reason,
                                               GtkDragSource       *source);

175
176
177
static GdkContentProvider *gtk_drag_source_prepare (GtkDragSource *source,
                                                    double         x,
                                                    double         y);
178

179
180
static void gtk_drag_source_drag_begin (GtkDragSource *source);

Matthias Clasen's avatar
Matthias Clasen committed
181
G_DEFINE_TYPE (GtkDragSource, gtk_drag_source, GTK_TYPE_GESTURE_SINGLE);
Matthias Clasen's avatar
Matthias Clasen committed
182
183
184
185

static void
gtk_drag_source_init (GtkDragSource *source)
{
186
  source->actions = GDK_ACTION_COPY;
Matthias Clasen's avatar
Matthias Clasen committed
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
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
}

static void
gtk_drag_source_finalize (GObject *object)
{
  GtkDragSource *source = GTK_DRAG_SOURCE (object);

  g_clear_object (&source->content);
  g_clear_object (&source->paintable);

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

static void
gtk_drag_source_set_property (GObject      *object,
                              guint         prop_id,
                              const GValue *value,
                              GParamSpec   *pspec)
{
  GtkDragSource *source = GTK_DRAG_SOURCE (object);
  
  switch (prop_id)
    {
    case PROP_CONTENT:
      gtk_drag_source_set_content (source, g_value_get_object (value));
      break;

    case PROP_ACTIONS:
      gtk_drag_source_set_actions (source, g_value_get_flags (value));
      break;

    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
gtk_drag_source_get_property (GObject    *object,
                              guint       prop_id,
                              GValue     *value,
                              GParamSpec *pspec)
{
  GtkDragSource *source = GTK_DRAG_SOURCE (object);

  switch (prop_id)
    {
    case PROP_CONTENT:
      g_value_set_object (value, gtk_drag_source_get_content (source));
      break;

    case PROP_ACTIONS:
      g_value_set_flags (value, gtk_drag_source_get_actions (source));
      break;

    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

Matthias Clasen's avatar
Matthias Clasen committed
246
247
static gboolean
gtk_drag_source_filter_event (GtkEventController *controller,
Matthias Clasen's avatar
Matthias Clasen committed
248
                              GdkEvent           *event)
Matthias Clasen's avatar
Matthias Clasen committed
249
250
251
252
253
254
255
256
{
  /* Let touchpad swipe events go through, only if they match n-points  */
  if (gdk_event_get_event_type (event) == GDK_TOUCHPAD_SWIPE)
    {
      guint n_points;
      guint n_fingers;

      g_object_get (G_OBJECT (controller), "n-points", &n_points, NULL);
Matthias Clasen's avatar
Matthias Clasen committed
257
      n_fingers = gdk_touchpad_event_get_n_fingers (event);
Matthias Clasen's avatar
Matthias Clasen committed
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285

      if (n_fingers == n_points)
        return FALSE;
      else
        return TRUE;
    }

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

static void
gtk_drag_source_begin (GtkGesture       *gesture,
                       GdkEventSequence *sequence)
{
  GtkDragSource *source = GTK_DRAG_SOURCE (gesture);
  GdkEventSequence *current;

  current = gtk_gesture_single_get_current_sequence (GTK_GESTURE_SINGLE (gesture));

  gtk_gesture_get_point (gesture, current, &source->start_x, &source->start_y);
}

static void
gtk_drag_source_update (GtkGesture       *gesture,
                        GdkEventSequence *sequence)
{
  GtkDragSource *source = GTK_DRAG_SOURCE (gesture);
  GtkWidget *widget;
286
  double x, y;
Matthias Clasen's avatar
Matthias Clasen committed
287
288
289
290

  if (!gtk_gesture_is_recognized (gesture))
    return;

291
292
  gtk_gesture_get_point (gesture, sequence, &x, &y);

Matthias Clasen's avatar
Matthias Clasen committed
293
294
  widget = gtk_event_controller_get_widget (GTK_EVENT_CONTROLLER (gesture));

295
  if (gtk_drag_check_threshold_double (widget, source->start_x, source->start_y, x, y))
Matthias Clasen's avatar
Matthias Clasen committed
296
    {
297
298
      gtk_drag_source_drag_begin (source);
    }
Matthias Clasen's avatar
Matthias Clasen committed
299
300
}

Matthias Clasen's avatar
Matthias Clasen committed
301
302
303
304
static void
gtk_drag_source_class_init (GtkDragSourceClass *class)
{
  GObjectClass *object_class = G_OBJECT_CLASS (class);
Matthias Clasen's avatar
Matthias Clasen committed
305
306
  GtkEventControllerClass *controller_class = GTK_EVENT_CONTROLLER_CLASS (class);
  GtkGestureClass *gesture_class = GTK_GESTURE_CLASS (class);
Matthias Clasen's avatar
Matthias Clasen committed
307
308
309
310
311

  object_class->finalize = gtk_drag_source_finalize;
  object_class->set_property = gtk_drag_source_set_property;
  object_class->get_property = gtk_drag_source_get_property;

Matthias Clasen's avatar
Matthias Clasen committed
312
313
314
315
316
317
  controller_class->filter_event = gtk_drag_source_filter_event;

  gesture_class->begin = gtk_drag_source_begin;
  gesture_class->update = gtk_drag_source_update;
  gesture_class->end = NULL;

318
319
  class->prepare = gtk_drag_source_prepare;

Matthias Clasen's avatar
Matthias Clasen committed
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
  /**
   * GtkDragSource:content:
   *
   * The data that is offered by drag operations from this source,
   * in the form of a #GdkContentProvider.
   */ 
  properties[PROP_CONTENT] =
       g_param_spec_object ("content",
                            P_("Content"),
                            P_("The content provider for the dragged data"),
                           GDK_TYPE_CONTENT_PROVIDER,
                           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_EXPLICIT_NOTIFY);

  /**
   * GtkDragSource:actions:
   *
   * The actions that are supported by drag operations from the source.
   *
Matthias Clasen's avatar
Matthias Clasen committed
338
   * Note that you must handle the #GtkDragSource::drag-end signal
Matthias Clasen's avatar
Matthias Clasen committed
339
340
341
342
343
344
   * if the actions include %GDK_ACTION_MOVE.
   */ 
  properties[PROP_ACTIONS] =
       g_param_spec_flags ("actions",
                           P_("Actions"),
                           P_("Supported actions"),
345
                           GDK_TYPE_DRAG_ACTION, GDK_ACTION_COPY,
Matthias Clasen's avatar
Matthias Clasen committed
346
347
348
349
                           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_EXPLICIT_NOTIFY);

  g_object_class_install_properties (object_class, NUM_PROPERTIES, properties);

Matthias Clasen's avatar
Matthias Clasen committed
350
351
352
353
354
355
  /**
   * GtkDragSource::prepare:
   * @source: the #GtkDragSource
   * @x: the X coordinate of the drag starting point
   * @y: the Y coordinate fo the drag starting point
   *
356
357
358
   * The ::prepare signal is emitted when a drag is about to be initiated.
   * It returns the * #GdkContentProvider to use for the drag that is about
   * to start. The default handler for this signal returns the value of
359
   * the #GtkDragSource:content property, so if you set up that property
360
   * ahead of time, you don't need to connect to this signal.
Matthias Clasen's avatar
Matthias Clasen committed
361
   *
362
   * Returns: (transfer full) (nullable): a #GdkContentProvider, or %NULL
Matthias Clasen's avatar
Matthias Clasen committed
363
   */
364
365
366
367
  signals[PREPARE] =
      g_signal_new (I_("prepare"),
                    G_TYPE_FROM_CLASS (class),
                    G_SIGNAL_RUN_LAST,
368
369
                    G_STRUCT_OFFSET (GtkDragSourceClass, prepare),
                    g_signal_accumulator_first_wins, NULL,
370
                    NULL,
371
                    GDK_TYPE_CONTENT_PROVIDER, 2,
372
373
                    G_TYPE_DOUBLE, G_TYPE_DOUBLE);

Matthias Clasen's avatar
Matthias Clasen committed
374
375
376
  /**
   * GtkDragSource::drag-begin:
   * @source: the #GtkDragSource
377
   * @drag: the #GdkDrag object
Matthias Clasen's avatar
Matthias Clasen committed
378
379
380
   *
   * The ::drag-begin signal is emitted on the drag source when a drag
   * is started. It can be used to e.g. set a custom drag icon with
381
   * gtk_drag_source_set_icon().
Matthias Clasen's avatar
Matthias Clasen committed
382
383
384
385
386
387
388
389
   */
  signals[DRAG_BEGIN] =
      g_signal_new (I_("drag-begin"),
                    G_TYPE_FROM_CLASS (class),
                    G_SIGNAL_RUN_LAST,
                    0,
                    NULL, NULL,
                    NULL,
390
391
                    G_TYPE_NONE, 1,
                    GDK_TYPE_DRAG);
Matthias Clasen's avatar
Matthias Clasen committed
392
393
394
395

  /**
   * GtkDragSource::drag-end:
   * @source: the #GtkDragSource
396
   * @drag: the #GdkDrag object
397
398
   * @delete_data: %TRUE if the drag was performing %GDK_ACTION_MOVE,
   *    and the data should be deleted
Matthias Clasen's avatar
Matthias Clasen committed
399
400
401
   *
   * The ::drag-end signal is emitted on the drag source when a drag is
   * finished. A typical reason to connect to this signal is to undo
Matthias Clasen's avatar
Matthias Clasen committed
402
   * things done in #GtkDragSource::prepare or #GtkDragSource::drag-begin.
Matthias Clasen's avatar
Matthias Clasen committed
403
404
405
406
407
408
409
410
   */ 
  signals[DRAG_END] =
      g_signal_new (I_("drag-end"),
                    G_TYPE_FROM_CLASS (class),
                    G_SIGNAL_RUN_LAST,
                    0,
                    NULL, NULL,
                    NULL,
411
412
413
                    G_TYPE_NONE, 2,
                    GDK_TYPE_DRAG,
                    G_TYPE_BOOLEAN);
Matthias Clasen's avatar
Matthias Clasen committed
414
415

  /**
416
   * GtkDragSource::drag-cancel:
Matthias Clasen's avatar
Matthias Clasen committed
417
   * @source: the #GtkDragSource
418
   * @drag: the #GdkDrag object
Matthias Clasen's avatar
Matthias Clasen committed
419
420
   * @reason: information on why the drag failed
   *
421
   * The ::drag-cancel signal is emitted on the drag source when a drag has
Matthias Clasen's avatar
Matthias Clasen committed
422
423
   * failed. The signal handler may handle a failed drag operation based on
   * the type of error. It should return %TRUE if the failure has been handled
424
   * and the default "drag operation failed" animation should not be shown.
Matthias Clasen's avatar
Matthias Clasen committed
425
426
427
   *
   * Returns: %TRUE if the failed drag operation has been already handled
   */
428
429
  signals[DRAG_CANCEL] =
      g_signal_new (I_("drag-cancel"),
Matthias Clasen's avatar
Matthias Clasen committed
430
431
432
433
                    G_TYPE_FROM_CLASS (class),
                    G_SIGNAL_RUN_LAST,
                    0,
                    _gtk_boolean_handled_accumulator, NULL,
434
435
436
                    _gtk_marshal_BOOLEAN__OBJECT_ENUM,
                    G_TYPE_BOOLEAN, 2,
                    GDK_TYPE_DRAG,
Matthias Clasen's avatar
Matthias Clasen committed
437
438
439
                    GDK_TYPE_DRAG_CANCEL_REASON);
}

440
static GdkContentProvider *
441
442
443
444
gtk_drag_source_prepare (GtkDragSource *source,
                         double         x,
                         double         y)
{
445
446
447
448
449
450
451
  if (source->actions == 0)
    return NULL;

  if (source->content == NULL)
    return NULL;

  return g_object_ref (source->content);
452
453
}

Matthias Clasen's avatar
Matthias Clasen committed
454
static void
Matthias Clasen's avatar
Matthias Clasen committed
455
456
drag_end (GtkDragSource *source,
          gboolean       success)
Matthias Clasen's avatar
Matthias Clasen committed
457
{
458
459
  gboolean delete_data;

Matthias Clasen's avatar
Matthias Clasen committed
460
461
462
  g_signal_handlers_disconnect_by_func (source->drag, gtk_drag_source_dnd_finished_cb, source);
  g_signal_handlers_disconnect_by_func (source->drag, gtk_drag_source_cancel_cb, source);

463
464
465
  delete_data = success && gdk_drag_get_selected_action (source->drag) == GDK_ACTION_MOVE;

  g_signal_emit (source, signals[DRAG_END], 0, source->drag, delete_data);
Matthias Clasen's avatar
Matthias Clasen committed
466

Matthias Clasen's avatar
Matthias Clasen committed
467
  gdk_drag_drop_done (source->drag, success);
Matthias Clasen's avatar
Matthias Clasen committed
468
469
470
471
472
473
474
  g_clear_object (&source->drag);
}

static void
gtk_drag_source_dnd_finished_cb (GdkDrag       *drag,
                                 GtkDragSource *source)
{
Matthias Clasen's avatar
Matthias Clasen committed
475
  drag_end (source, TRUE);
Matthias Clasen's avatar
Matthias Clasen committed
476
477
478
479
480
481
482
483
484
}

static void
gtk_drag_source_cancel_cb (GdkDrag             *drag,
                           GdkDragCancelReason  reason,
                           GtkDragSource       *source)
{
  gboolean success = FALSE;

485
  g_signal_emit (source, signals[DRAG_CANCEL], 0, source->drag, reason, &success);
486
  drag_end (source, success);
Matthias Clasen's avatar
Matthias Clasen committed
487
488
}

489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
static void
gtk_drag_source_ensure_icon (GtkDragSource *self,
                             GdkDrag       *drag)
{
  GdkContentProvider *provider;
  GtkWidget *icon, *child;
  GdkContentFormats *formats;
  const GType *types;
  gsize i, n_types;

  icon = gtk_drag_icon_get_for_drag (drag);
  /* If an icon has been set already, we don't need to set one. */
  if (gtk_drag_icon_get_child (GTK_DRAG_ICON (icon)))
    return;

504
505
506
507
508
509
510
511
512
  if (self->paintable)
    {
      gtk_drag_icon_set_from_paintable (drag,
                                        self->paintable,
                                        self->hot_x,
                                        self->hot_y);
      return;
    }

513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
  gdk_drag_set_hotspot (drag, -2, -2);

  provider = gdk_drag_get_content (drag);
  formats = gdk_content_provider_ref_formats (provider);
  types = gdk_content_formats_get_gtypes (formats, &n_types);
  for (i = 0; i < n_types; i++)
    {
      GValue value = G_VALUE_INIT;

      g_value_init (&value, types[i]);
      if (gdk_content_provider_get_value (provider, &value, NULL))
        {
          child = gtk_drag_icon_create_widget_for_value (&value);

          if (child)
            {
              gtk_drag_icon_set_child (GTK_DRAG_ICON (icon), child);
              g_value_unset (&value);
              gdk_content_formats_unref (formats);
              return;
            }
        }
      g_value_unset (&value);
    }

  gdk_content_formats_unref (formats);
  child = gtk_image_new_from_icon_name ("text-x-generic");
  gtk_image_set_icon_size (GTK_IMAGE (child), GTK_ICON_SIZE_LARGE);
  gtk_drag_icon_set_child (GTK_DRAG_ICON (icon), child);
}

544
545
static void
gtk_drag_source_drag_begin (GtkDragSource *source)
Matthias Clasen's avatar
Matthias Clasen committed
546
{
547
  GtkWidget *widget;
548
549
  GdkDevice *device, *pointer;
  GdkSeat *seat;
550
  double x, y;
Matthias Clasen's avatar
Matthias Clasen committed
551
552
553
554
  GtkNative *native;
  GdkSurface *surface;
  double px, py;
  int dx, dy;
555
  GdkContentProvider *content = NULL;
Matthias Clasen's avatar
Matthias Clasen committed
556

557
558
  widget = gtk_event_controller_get_widget (GTK_EVENT_CONTROLLER (source));
  device = gtk_gesture_get_device (GTK_GESTURE (source));
559
  seat = gdk_device_get_seat (device);
Matthias Clasen's avatar
Matthias Clasen committed
560

561
562
563
564
  if (device == gdk_seat_get_keyboard (seat))
    pointer = gdk_seat_get_pointer (seat);
  else
    pointer = device;
Matthias Clasen's avatar
Matthias Clasen committed
565
566
567
568

  native = gtk_widget_get_native (widget);
  surface = gtk_native_get_surface (native);

569
  gtk_widget_translate_coordinates (widget, GTK_WIDGET (native), source->start_x, source->start_y, &x, &y);
570
  gdk_surface_get_device_position (surface, pointer, &px, &py, NULL);
Matthias Clasen's avatar
Matthias Clasen committed
571

572
573
  dx = round (px - x);
  dy = round (py - y);
Matthias Clasen's avatar
Matthias Clasen committed
574

575
576
  g_signal_emit (source, signals[PREPARE], 0, source->start_x, source->start_y, &content);
  if (!content)
577
578
    return;

579
  source->drag = gdk_drag_begin (surface, pointer, content, source->actions, dx, dy);
580
581

  g_object_unref (content);
582

Matthias Clasen's avatar
Matthias Clasen committed
583
  if (source->drag == NULL)
584
    return;
Matthias Clasen's avatar
Matthias Clasen committed
585
586
587

  gtk_widget_reset_controllers (widget);

588
  g_signal_emit (source, signals[DRAG_BEGIN], 0, source->drag);
Matthias Clasen's avatar
Matthias Clasen committed
589

590
  gtk_drag_source_ensure_icon (source, source->drag);
Matthias Clasen's avatar
Matthias Clasen committed
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605

  g_signal_connect (source->drag, "dnd-finished",
                    G_CALLBACK (gtk_drag_source_dnd_finished_cb), source);
  g_signal_connect (source->drag, "cancel",
                    G_CALLBACK (gtk_drag_source_cancel_cb), source);
}

/**
 * gtk_drag_source_new:
 *
 * Creates a new #GtkDragSource object.
 *
 * Returns: the new #GtkDragSource
 */
GtkDragSource *
606
gtk_drag_source_new (void)
Matthias Clasen's avatar
Matthias Clasen committed
607
{
608
  return g_object_new (GTK_TYPE_DRAG_SOURCE, NULL);
Matthias Clasen's avatar
Matthias Clasen committed
609
610
611
612
613
614
615
616
}

/**
 * gtk_drag_source_get_content:
 * @source: a #GtkDragSource
 *
 * Gets the current content provider of a #GtkDragSource.
 *
617
 * Returns: (nullable) (transfer none): the #GdkContentProvider of @source
Matthias Clasen's avatar
Matthias Clasen committed
618
619
620
621
622
623
 */
GdkContentProvider *
gtk_drag_source_get_content (GtkDragSource *source)
{
  g_return_val_if_fail (GTK_IS_DRAG_SOURCE (source), NULL);

624
  return source->content;
Matthias Clasen's avatar
Matthias Clasen committed
625
626
627
628
629
}

/**
 * gtk_drag_source_set_content:
 * @source: a #GtkDragSource
630
 * @content: (nullable): a #GdkContentProvider, or %NULL
Matthias Clasen's avatar
Matthias Clasen committed
631
632
633
634
635
636
 *
 * Sets a content provider on a #GtkDragSource.
 *
 * When the data is requested in the cause of a
 * DND operation, it will be obtained from the
 * content provider.
Matthias Clasen's avatar
Matthias Clasen committed
637
638
639
640
641
 *
 * This function can be called before a drag is started,
 * or in a handler for the #GtkDragSource::prepare signal.
 *
 * You may consider setting the content provider back to
642
 * %NULL in a #GtkDragSource::drag-end signal handler.
Matthias Clasen's avatar
Matthias Clasen committed
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 */
void
gtk_drag_source_set_content (GtkDragSource      *source,
                             GdkContentProvider *content)
{
  g_return_if_fail (GTK_IS_DRAG_SOURCE (source));

  if (!g_set_object (&source->content, content))
    return;

  g_object_notify_by_pspec (G_OBJECT (source), properties[PROP_CONTENT]);
}

/**
 * gtk_drag_source_get_actions:
 * @source: a #GtkDragSource
 *
 * Gets the actions that are currently set on the #GtkDragSource.
 *
 * Returns: the actions set on @source
 */
GdkDragAction
gtk_drag_source_get_actions (GtkDragSource *source)
{
  g_return_val_if_fail (GTK_IS_DRAG_SOURCE (source), 0);

  return source->actions;
}

/**
 * gtk_drag_source_set_actions:
 * @source: a #GtkDragSource
 * @actions: the actions to offer
 *
 * Sets the actions on the #GtkDragSource.
 *
 * During a DND operation, the actions are offered
Matthias Clasen's avatar
Matthias Clasen committed
680
681
 * to potential drop targets. If @actions include
 * %GDK_ACTION_MOVE, you need to listen to the
682
 * #GtkDragSource::drag-end signal and handle
Matthias Clasen's avatar
Matthias Clasen committed
683
684
685
686
 * @delete_data being %TRUE.
 *
 * This function can be called before a drag is started,
 * or in a handler for the #GtkDragSource::prepare signal.
Matthias Clasen's avatar
Matthias Clasen committed
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
 */
void
gtk_drag_source_set_actions (GtkDragSource *source,
                             GdkDragAction  actions)
{
  g_return_if_fail (GTK_IS_DRAG_SOURCE (source));

  if (source->actions == actions)
    return;

  source->actions = actions;

  g_object_notify_by_pspec (G_OBJECT (source), properties[PROP_ACTIONS]);
}

/**
 * gtk_drag_source_set_icon:
 * @source: a #GtkDragSource
705
 * @paintable: (nullable): the #GdkPaintable to use as icon, or %NULL
Matthias Clasen's avatar
Matthias Clasen committed
706
707
708
709
710
711
712
713
714
 * @hot_x: the hotspot X coordinate on the icon
 * @hot_y: the hotspot Y coordinate on the icon
 *
 * Sets a paintable to use as icon during DND operations.
 *
 * The hotspot coordinates determine the point on the icon
 * that gets aligned with the hotspot of the cursor.
 *
 * If @paintable is %NULL, a default icon is used.
Matthias Clasen's avatar
Matthias Clasen committed
715
716
717
 *
 * This function can be called before a drag is started, or in
 * a #GtkDragSource::prepare or #GtkDragSource::drag-begin signal handler.
Matthias Clasen's avatar
Matthias Clasen committed
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
 */
void
gtk_drag_source_set_icon (GtkDragSource *source,
                          GdkPaintable  *paintable,
                          int            hot_x,
                          int            hot_y)
{
  g_return_if_fail (GTK_IS_DRAG_SOURCE (source));

  g_set_object (&source->paintable, paintable);

  source->hot_x = hot_x;
  source->hot_y = hot_y;
}

/**
 * gtk_drag_source_get_drag:
 * @source: a #GtkDragSource
 *
737
 * Returns the underlying #GdkDrag object for an ongoing drag.
Matthias Clasen's avatar
Matthias Clasen committed
738
 *
739
 * Returns: (nullable) (transfer none): the #GdkDrag of the current drag operation, or %NULL
Matthias Clasen's avatar
Matthias Clasen committed
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
 */
GdkDrag *
gtk_drag_source_get_drag (GtkDragSource *source)
{
  g_return_val_if_fail (GTK_IS_DRAG_SOURCE (source), NULL);

  return source->drag;
}

/**
 * gtk_drag_source_drag_cancel:
 * @source: a #GtkDragSource
 *
 * Cancels a currently ongoing drag operation.
 */
void
gtk_drag_source_drag_cancel (GtkDragSource *source)
{
  g_return_if_fail (GTK_IS_DRAG_SOURCE (source));

  if (source->drag)
    {
      gboolean success = FALSE;

764
      g_signal_emit (source, signals[DRAG_CANCEL], 0, source->drag, GDK_DRAG_CANCEL_ERROR, &success);
765
      drag_end (source, FALSE);
Matthias Clasen's avatar
Matthias Clasen committed
766
767
    }
}
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789

/**
 * gtk_drag_check_threshold: (method)
 * @widget: a #GtkWidget
 * @start_x: X coordinate of start of drag
 * @start_y: Y coordinate of start of drag
 * @current_x: current X coordinate
 * @current_y: current Y coordinate
 * 
 * Checks to see if a mouse drag starting at (@start_x, @start_y) and ending
 * at (@current_x, @current_y) has passed the GTK drag threshold, and thus
 * should trigger the beginning of a drag-and-drop operation.
 *
 * Returns: %TRUE if the drag threshold has been passed.
 */
gboolean
gtk_drag_check_threshold (GtkWidget *widget,
                          int        start_x,
                          int        start_y,
                          int        current_x,
                          int        current_y)
{
Benjamin Otte's avatar
Benjamin Otte committed
790
  int drag_threshold;
791
792
793
794
795
796
797
798

  g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);

  drag_threshold = gtk_settings_get_dnd_drag_threshold (gtk_widget_get_settings (widget));

  return (ABS (current_x - start_x) > drag_threshold ||
          ABS (current_y - start_y) > drag_threshold);
}
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815

gboolean
gtk_drag_check_threshold_double (GtkWidget *widget,
                                 double     start_x,
                                 double     start_y,
                                 double     current_x,
                                 double     current_y)
{
  int drag_threshold;

  g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);

  drag_threshold = gtk_settings_get_dnd_drag_threshold (gtk_widget_get_settings (widget));

  return (ABS (current_x - start_x) > drag_threshold ||
          ABS (current_y - start_y) > drag_threshold);
}