1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1999 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
32 #include "gdkconfig.h"
34 #include "gdk/gdkkeysyms.h"
36 #ifdef GDK_WINDOWING_X11
38 #include <X11/keysym.h>
39 #include "gdk/x11/gdkx.h"
43 #include "gtkiconfactory.h"
44 #include "gtkicontheme.h"
46 #include "gtkinvisible.h"
50 #include "gtkwindow.h"
52 #include "gtkdndcursors.h"
55 static GSList *source_widgets = NULL;
57 typedef struct _GtkDragSourceSite GtkDragSourceSite;
58 typedef struct _GtkDragSourceInfo GtkDragSourceInfo;
59 typedef struct _GtkDragDestSite GtkDragDestSite;
60 typedef struct _GtkDragDestInfo GtkDragDestInfo;
61 typedef struct _GtkDragAnim GtkDragAnim;
62 typedef struct _GtkDragFindData GtkDragFindData;
72 struct _GtkDragSourceSite
74 GdkModifierType start_button_mask;
75 GtkTargetList *target_list; /* Targets for drag data */
76 GdkDragAction actions; /* Possible actions */
79 GtkImageType icon_type;
82 GtkImagePixmapData pixmap;
83 GtkImagePixbufData pixbuf;
84 GtkImageStockData stock;
85 GtkImageIconNameData name;
89 GdkColormap *colormap; /* Colormap for drag icon */
91 /* Stored button press information to detect drag beginning */
96 struct _GtkDragSourceInfo
99 GtkTargetList *target_list; /* Targets for drag data */
100 GdkDragAction possible_actions; /* Actions allowed by source */
101 GdkDragContext *context; /* drag context */
102 GtkWidget *icon_window; /* Window for drag */
103 GtkWidget *fallback_icon; /* Window for drag used on other screens */
104 GtkWidget *ipc_widget; /* GtkInvisible for grab, message passing */
105 GdkCursor *cursor; /* Cursor for drag */
106 gint hot_x, hot_y; /* Hot spot for drag */
107 gint button; /* mouse button starting drag */
109 GtkDragStatus status; /* drag status */
110 GdkEvent *last_event; /* pending event */
112 gint start_x, start_y; /* Initial position */
113 gint cur_x, cur_y; /* Current Position */
114 GdkScreen *cur_screen; /* Current screen for pointer */
116 guint32 grab_time; /* timestamp for initial grab */
117 GList *selections; /* selections we've claimed */
119 GtkDragDestInfo *proxy_dest; /* Set if this is a proxy drag */
121 guint update_idle; /* Idle function to update the drag */
122 guint drop_timeout; /* Timeout for aborting drop */
123 guint destroy_icon : 1; /* If true, destroy icon_window
125 guint have_grab : 1; /* Do we still have the pointer grab
127 GdkPixbuf *icon_pixbuf;
128 GdkCursor *drag_cursors[6];
131 struct _GtkDragDestSite
133 GtkDestDefaults flags;
134 GtkTargetList *target_list;
135 GdkDragAction actions;
136 GdkWindow *proxy_window;
137 GdkDragProtocol proxy_protocol;
139 guint proxy_coords : 1;
141 guint track_motion : 1;
144 struct _GtkDragDestInfo
146 GtkWidget *widget; /* Widget in which drag is in */
147 GdkDragContext *context; /* Drag context */
148 GtkDragSourceInfo *proxy_source; /* Set if this is a proxy drag */
149 GtkSelectionData *proxy_data; /* Set while retrieving proxied data */
150 guint dropped : 1; /* Set after we receive a drop */
151 guint32 proxy_drop_time; /* Timestamp for proxied drop */
152 guint proxy_drop_wait : 1; /* Set if we are waiting for a
153 * status reply before sending
156 gint drop_x, drop_y; /* Position of drop */
159 #define DROP_ABORT_TIME 300000
161 #define ANIM_STEP_TIME 50
162 #define ANIM_STEP_LENGTH 50
163 #define ANIM_MIN_STEPS 5
164 #define ANIM_MAX_STEPS 10
168 GtkDragSourceInfo *info;
173 struct _GtkDragFindData
177 GdkDragContext *context;
178 GtkDragDestInfo *info;
181 gboolean (*callback) (GtkWidget *widget, GdkDragContext *context,
182 gint x, gint y, guint32 time);
186 /* Enumeration for some targets we handle internally */
189 TARGET_MOTIF_SUCCESS = 0x40000000,
190 TARGET_MOTIF_FAILURE,
196 static GdkPixmap *default_icon_pixmap = NULL;
197 static GdkPixmap *default_icon_mask = NULL;
198 static GdkColormap *default_icon_colormap = NULL;
199 static gint default_icon_hot_x;
200 static gint default_icon_hot_y;
202 /* Forward declarations */
203 static void gtk_drag_get_event_actions (GdkEvent *event,
205 GdkDragAction actions,
206 GdkDragAction *suggested_action,
207 GdkDragAction *possible_actions);
208 static GdkCursor * gtk_drag_get_cursor (GdkDisplay *display,
209 GdkDragAction action,
210 GtkDragSourceInfo *info);
211 static void gtk_drag_update_cursor (GtkDragSourceInfo *info);
212 static GtkWidget *gtk_drag_get_ipc_widget (GtkWidget *widget);
213 static GtkWidget *gtk_drag_get_ipc_widget_for_screen (GdkScreen *screen);
214 static void gtk_drag_release_ipc_widget (GtkWidget *widget);
216 static gboolean gtk_drag_highlight_expose (GtkWidget *widget,
217 GdkEventExpose *event,
220 static void gtk_drag_selection_received (GtkWidget *widget,
221 GtkSelectionData *selection_data,
224 static void gtk_drag_find_widget (GtkWidget *widget,
225 GtkDragFindData *data);
226 static void gtk_drag_proxy_begin (GtkWidget *widget,
227 GtkDragDestInfo *dest_info,
229 static void gtk_drag_dest_realized (GtkWidget *widget);
230 static void gtk_drag_dest_hierarchy_changed (GtkWidget *widget,
231 GtkWidget *previous_toplevel);
232 static void gtk_drag_dest_site_destroy (gpointer data);
233 static void gtk_drag_dest_leave (GtkWidget *widget,
234 GdkDragContext *context,
236 static gboolean gtk_drag_dest_motion (GtkWidget *widget,
237 GdkDragContext *context,
241 static gboolean gtk_drag_dest_drop (GtkWidget *widget,
242 GdkDragContext *context,
247 static GtkDragDestInfo * gtk_drag_get_dest_info (GdkDragContext *context,
249 static GtkDragSourceInfo *gtk_drag_get_source_info (GdkDragContext *context,
251 static void gtk_drag_clear_source_info (GdkDragContext *context);
253 static void gtk_drag_source_check_selection (GtkDragSourceInfo *info,
256 static void gtk_drag_source_release_selections (GtkDragSourceInfo *info,
258 static void gtk_drag_drop (GtkDragSourceInfo *info,
260 static void gtk_drag_drop_finished (GtkDragSourceInfo *info,
261 GtkDragResult result,
263 static void gtk_drag_cancel (GtkDragSourceInfo *info,
264 GtkDragResult result,
267 static gboolean gtk_drag_source_event_cb (GtkWidget *widget,
270 static void gtk_drag_source_site_destroy (gpointer data);
271 static void gtk_drag_selection_get (GtkWidget *widget,
272 GtkSelectionData *selection_data,
276 static gboolean gtk_drag_anim_timeout (gpointer data);
277 static void gtk_drag_remove_icon (GtkDragSourceInfo *info);
278 static void gtk_drag_source_info_destroy (GtkDragSourceInfo *info);
279 static void gtk_drag_add_update_idle (GtkDragSourceInfo *info);
281 static void gtk_drag_update (GtkDragSourceInfo *info,
286 static gboolean gtk_drag_motion_cb (GtkWidget *widget,
287 GdkEventMotion *event,
289 static gboolean gtk_drag_key_cb (GtkWidget *widget,
292 static gboolean gtk_drag_grab_broken_event_cb (GtkWidget *widget,
293 GdkEventGrabBroken *event,
295 static void gtk_drag_grab_notify_cb (GtkWidget *widget,
296 gboolean was_grabbed,
298 static gboolean gtk_drag_button_release_cb (GtkWidget *widget,
299 GdkEventButton *event,
301 static gboolean gtk_drag_abort_timeout (gpointer data);
303 static void set_icon_stock_pixbuf (GdkDragContext *context,
304 const gchar *stock_id,
308 gboolean force_window);
310 /************************
311 * Cursor and Icon data *
312 ************************/
315 GdkDragAction action;
321 { GDK_ACTION_DEFAULT, NULL },
322 { GDK_ACTION_ASK, "dnd-ask", dnd_cursor_ask, NULL, NULL },
323 { GDK_ACTION_COPY, "dnd-copy", dnd_cursor_copy, NULL, NULL },
324 { GDK_ACTION_MOVE, "dnd-move", dnd_cursor_move, NULL, NULL },
325 { GDK_ACTION_LINK, "dnd-link", dnd_cursor_link, NULL, NULL },
326 { 0 , "dnd-none", dnd_cursor_none, NULL, NULL },
329 static const gint n_drag_cursors = sizeof (drag_cursors) / sizeof (drag_cursors[0]);
331 /*********************
332 * Utility functions *
333 *********************/
336 set_can_change_screen (GtkWidget *widget,
337 gboolean can_change_screen)
339 can_change_screen = can_change_screen != FALSE;
341 g_object_set_data (G_OBJECT (widget), I_("gtk-dnd-can-change-screen"),
342 GUINT_TO_POINTER (can_change_screen));
346 get_can_change_screen (GtkWidget *widget)
348 return g_object_get_data (G_OBJECT (widget), "gtk-dnd-can-change-screen") != NULL;
353 gtk_drag_get_ipc_widget_for_screen (GdkScreen *screen)
356 GSList *drag_widgets = g_object_get_data (G_OBJECT (screen),
357 "gtk-dnd-ipc-widgets");
361 GSList *tmp = drag_widgets;
362 result = drag_widgets->data;
363 drag_widgets = drag_widgets->next;
364 g_object_set_data (G_OBJECT (screen),
365 I_("gtk-dnd-ipc-widgets"),
367 g_slist_free_1 (tmp);
371 result = gtk_window_new (GTK_WINDOW_POPUP);
372 gtk_window_set_screen (GTK_WINDOW (result), screen);
373 gtk_window_resize (GTK_WINDOW (result), 1, 1);
374 gtk_window_move (GTK_WINDOW (result), -100, -100);
375 gtk_widget_show (result);
382 gtk_drag_get_ipc_widget (GtkWidget *widget)
387 result = gtk_drag_get_ipc_widget_for_screen (gtk_widget_get_screen (widget));
389 toplevel = gtk_widget_get_toplevel (widget);
391 if (GTK_IS_WINDOW (toplevel))
393 if (GTK_WINDOW (toplevel)->group)
394 gtk_window_group_add_window (GTK_WINDOW (toplevel)->group,
395 GTK_WINDOW (result));
402 #ifdef GDK_WINDOWING_X11
405 * We want to handle a handful of keys during DND, e.g. Escape to abort.
406 * Grabbing the keyboard has the unfortunate side-effect of preventing
407 * useful things such as using Alt-Tab to cycle between windows or
408 * switching workspaces. Therefore, we just grab the few keys we are
409 * interested in. Note that we need to put the grabs on the root window
410 * in order for them to still work when the focus is moved to another
413 * GDK needs a little help to successfully deliver root key events...
416 static GdkFilterReturn
417 root_key_filter (GdkXEvent *xevent,
421 XEvent *ev = (XEvent *)xevent;
423 if ((ev->type == KeyPress || ev->type == KeyRelease) &&
424 ev->xkey.root == ev->xkey.window)
425 ev->xkey.window = (Window)data;
427 return GDK_FILTER_CONTINUE;
435 static GrabKey grab_keys[] = {
444 { XK_Down, Mod1Mask },
446 { XK_Left, Mod1Mask },
448 { XK_Right, Mod1Mask },
450 { XK_KP_Up, Mod1Mask },
452 { XK_KP_Down, Mod1Mask },
454 { XK_KP_Left, Mod1Mask },
456 { XK_KP_Right, Mod1Mask }
460 grab_dnd_keys (GtkWidget *widget,
464 GdkWindow *window, *root;
467 window = widget->window;
468 root = gdk_screen_get_root_window (gtk_widget_get_screen (widget));
470 gdk_error_trap_push ();
472 for (i = 0; i < G_N_ELEMENTS (grab_keys); ++i)
474 keycode = XKeysymToKeycode (GDK_WINDOW_XDISPLAY (window), grab_keys[i].keysym);
475 XGrabKey (GDK_WINDOW_XDISPLAY (window),
476 keycode, grab_keys[i].modifiers,
477 GDK_WINDOW_XID (root),
484 gdk_error_trap_pop ();
486 gdk_window_add_filter (NULL, root_key_filter, (gpointer) GDK_WINDOW_XID (window));
490 ungrab_dnd_keys (GtkWidget *widget,
494 GdkWindow *window, *root;
497 window = widget->window;
498 root = gdk_screen_get_root_window (gtk_widget_get_screen (widget));
500 gdk_window_remove_filter (NULL, root_key_filter, (gpointer) GDK_WINDOW_XID (window));
502 gdk_error_trap_push ();
504 for (i = 0; i < G_N_ELEMENTS (grab_keys); ++i)
506 keycode = XKeysymToKeycode (GDK_WINDOW_XDISPLAY (window), grab_keys[i].keysym);
507 XUngrabKey (GDK_WINDOW_XDISPLAY (window),
508 keycode, grab_keys[i].modifiers,
509 GDK_WINDOW_XID (root));
513 gdk_error_trap_pop ();
519 grab_dnd_keys (GtkWidget *widget,
522 gdk_keyboard_grab (widget->window, FALSE, time);
526 ungrab_dnd_keys (GtkWidget *widget,
529 gdk_display_keyboard_ungrab (gtk_widget_get_display (widget), time);
535 /***************************************************************
536 * gtk_drag_release_ipc_widget:
537 * Releases widget retrieved with gtk_drag_get_ipc_widget ()
539 * widget: the widget to release.
541 ***************************************************************/
544 gtk_drag_release_ipc_widget (GtkWidget *widget)
546 GtkWindow *window = GTK_WINDOW (widget);
547 GdkScreen *screen = gtk_widget_get_screen (widget);
548 GSList *drag_widgets = g_object_get_data (G_OBJECT (screen),
549 "gtk-dnd-ipc-widgets");
550 ungrab_dnd_keys (widget, GDK_CURRENT_TIME);
552 gtk_window_group_remove_window (window->group, window);
553 drag_widgets = g_slist_prepend (drag_widgets, widget);
554 g_object_set_data (G_OBJECT (screen),
555 I_("gtk-dnd-ipc-widgets"),
560 gtk_drag_get_event_time (GdkEvent *event)
562 guint32 tm = GDK_CURRENT_TIME;
567 case GDK_MOTION_NOTIFY:
568 tm = event->motion.time; break;
569 case GDK_BUTTON_PRESS:
570 case GDK_2BUTTON_PRESS:
571 case GDK_3BUTTON_PRESS:
572 case GDK_BUTTON_RELEASE:
573 tm = event->button.time; break;
575 case GDK_KEY_RELEASE:
576 tm = event->key.time; break;
577 case GDK_ENTER_NOTIFY:
578 case GDK_LEAVE_NOTIFY:
579 tm = event->crossing.time; break;
580 case GDK_PROPERTY_NOTIFY:
581 tm = event->property.time; break;
582 case GDK_SELECTION_CLEAR:
583 case GDK_SELECTION_REQUEST:
584 case GDK_SELECTION_NOTIFY:
585 tm = event->selection.time; break;
586 case GDK_PROXIMITY_IN:
587 case GDK_PROXIMITY_OUT:
588 tm = event->proximity.time; break;
589 default: /* use current time */
597 gtk_drag_get_event_actions (GdkEvent *event,
599 GdkDragAction actions,
600 GdkDragAction *suggested_action,
601 GdkDragAction *possible_actions)
603 *suggested_action = 0;
604 *possible_actions = 0;
608 GdkModifierType state = 0;
612 case GDK_MOTION_NOTIFY:
613 state = event->motion.state;
615 case GDK_BUTTON_PRESS:
616 case GDK_2BUTTON_PRESS:
617 case GDK_3BUTTON_PRESS:
618 case GDK_BUTTON_RELEASE:
619 state = event->button.state;
622 case GDK_KEY_RELEASE:
623 state = event->key.state;
625 case GDK_ENTER_NOTIFY:
626 case GDK_LEAVE_NOTIFY:
627 state = event->crossing.state;
633 if ((button == 2 || button == 3) && (actions & GDK_ACTION_ASK))
635 *suggested_action = GDK_ACTION_ASK;
636 *possible_actions = actions;
638 else if (state & (GDK_SHIFT_MASK | GDK_CONTROL_MASK))
640 if ((state & GDK_SHIFT_MASK) && (state & GDK_CONTROL_MASK))
642 if (actions & GDK_ACTION_LINK)
644 *suggested_action = GDK_ACTION_LINK;
645 *possible_actions = GDK_ACTION_LINK;
648 else if (state & GDK_CONTROL_MASK)
650 if (actions & GDK_ACTION_COPY)
652 *suggested_action = GDK_ACTION_COPY;
653 *possible_actions = GDK_ACTION_COPY;
659 if (actions & GDK_ACTION_MOVE)
661 *suggested_action = GDK_ACTION_MOVE;
662 *possible_actions = GDK_ACTION_MOVE;
669 *possible_actions = actions;
671 if ((state & (GDK_MOD1_MASK)) && (actions & GDK_ACTION_ASK))
672 *suggested_action = GDK_ACTION_ASK;
673 else if (actions & GDK_ACTION_COPY)
674 *suggested_action = GDK_ACTION_COPY;
675 else if (actions & GDK_ACTION_MOVE)
676 *suggested_action = GDK_ACTION_MOVE;
677 else if (actions & GDK_ACTION_LINK)
678 *suggested_action = GDK_ACTION_LINK;
683 *possible_actions = actions;
685 if (actions & GDK_ACTION_COPY)
686 *suggested_action = GDK_ACTION_COPY;
687 else if (actions & GDK_ACTION_MOVE)
688 *suggested_action = GDK_ACTION_MOVE;
689 else if (actions & GDK_ACTION_LINK)
690 *suggested_action = GDK_ACTION_LINK;
695 gtk_drag_can_use_rgba_cursor (GdkDisplay *display,
699 guint max_width, max_height;
701 if (!gdk_display_supports_cursor_color (display))
704 if (!gdk_display_supports_cursor_alpha (display))
707 gdk_display_get_maximal_cursor_size (display,
710 if (width > max_width || height > max_height)
712 /* can't use rgba cursor (too large) */
720 gtk_drag_get_cursor (GdkDisplay *display,
721 GdkDragAction action,
722 GtkDragSourceInfo *info)
726 /* reconstruct the cursors for each new drag (thus !info),
727 * to catch cursor theme changes
731 for (i = 0 ; i < n_drag_cursors - 1; i++)
732 if (drag_cursors[i].cursor != NULL)
734 gdk_cursor_unref (drag_cursors[i].cursor);
735 drag_cursors[i].cursor = NULL;
739 for (i = 0 ; i < n_drag_cursors - 1; i++)
740 if (drag_cursors[i].action == action)
743 if (drag_cursors[i].pixbuf == NULL)
744 drag_cursors[i].pixbuf =
745 gdk_pixbuf_new_from_inline (-1, drag_cursors[i].data, FALSE, NULL);
747 if (drag_cursors[i].cursor != NULL)
749 if (display != gdk_cursor_get_display (drag_cursors[i].cursor))
751 gdk_cursor_unref (drag_cursors[i].cursor);
752 drag_cursors[i].cursor = NULL;
756 if (drag_cursors[i].cursor == NULL)
757 drag_cursors[i].cursor = gdk_cursor_new_from_name (display, drag_cursors[i].name);
759 if (drag_cursors[i].cursor == NULL)
760 drag_cursors[i].cursor = gdk_cursor_new_from_pixbuf (display, drag_cursors[i].pixbuf, 0, 0);
762 if (info && info->icon_pixbuf)
764 gint cursor_width, cursor_height;
765 gint icon_width, icon_height;
767 GdkPixbuf *cursor_pixbuf, *pixbuf;
769 gint icon_x, icon_y, ref_x, ref_y;
771 if (info->drag_cursors[i] != NULL)
773 if (display == gdk_cursor_get_display (info->drag_cursors[i]))
774 return info->drag_cursors[i];
776 gdk_cursor_unref (info->drag_cursors[i]);
777 info->drag_cursors[i] = NULL;
780 icon_x = info->hot_x;
781 icon_y = info->hot_y;
782 icon_width = gdk_pixbuf_get_width (info->icon_pixbuf);
783 icon_height = gdk_pixbuf_get_height (info->icon_pixbuf);
786 cursor_pixbuf = gdk_cursor_get_image (drag_cursors[i].cursor);
788 cursor_pixbuf = g_object_ref (drag_cursors[i].pixbuf);
791 if (gdk_pixbuf_get_option (cursor_pixbuf, "x_hot"))
792 hot_x = atoi (gdk_pixbuf_get_option (cursor_pixbuf, "x_hot"));
794 if (gdk_pixbuf_get_option (cursor_pixbuf, "y_hot"))
795 hot_y = atoi (gdk_pixbuf_get_option (cursor_pixbuf, "y_hot"));
798 /* The code below is an attempt to let cursor themes
799 * determine the attachment of the icon to enable things
800 * like the following:
808 * It does not work since Xcursor doesn't allow to attach
809 * any additional information to cursors in a retrievable
810 * way (there are comments, but no way to get at them
811 * short of searching for the actual cursor file).
812 * If this code ever gets used, the icon_window placement
813 * must be changed to recognize these placement options
814 * as well. Note that this code ignores info->hot_x/y.
816 for (j = 0; j < 10; j++)
821 GtkAnchorType icon_anchor;
823 g_snprintf (key, 32, "comment%d", j);
824 opt = gdk_pixbuf_get_option (cursor_pixbuf, key);
825 if (opt && g_str_has_prefix ("icon-attach:", opt))
827 toks = g_strsplit (opt + strlen ("icon-attach:"), "'", -1);
828 if (g_strv_length (toks) != 3)
833 icon_anchor = atoi (toks[0]);
834 icon_x = atoi (toks[1]);
835 icon_y = atoi (toks[2]);
839 case GTK_ANCHOR_NORTH:
840 case GTK_ANCHOR_CENTER:
841 case GTK_ANCHOR_SOUTH:
842 icon_x += icon_width / 2;
844 case GTK_ANCHOR_NORTH_EAST:
845 case GTK_ANCHOR_EAST:
846 case GTK_ANCHOR_SOUTH_EAST:
847 icon_x += icon_width;
854 case GTK_ANCHOR_WEST:
855 case GTK_ANCHOR_CENTER:
856 case GTK_ANCHOR_EAST:
857 icon_y += icon_height / 2;
859 case GTK_ANCHOR_SOUTH_WEST:
860 case GTK_ANCHOR_SOUTH:
861 case GTK_ANCHOR_SOUTH_EAST:
862 icon_x += icon_height;
874 cursor_width = gdk_pixbuf_get_width (cursor_pixbuf);
875 cursor_height = gdk_pixbuf_get_height (cursor_pixbuf);
877 ref_x = MAX (hot_x, icon_x);
878 ref_y = MAX (hot_y, icon_y);
879 width = ref_x + MAX (cursor_width - hot_x, icon_width - icon_x);
880 height = ref_y + MAX (cursor_height - hot_y, icon_height - icon_y);
882 if (gtk_drag_can_use_rgba_cursor (display, width, height))
884 /* Composite cursor and icon so that both hotspots
885 * end up at (ref_x, ref_y)
887 pixbuf = gdk_pixbuf_new (GDK_COLORSPACE_RGB, TRUE, 8,
890 gdk_pixbuf_fill (pixbuf, 0xff000000);
892 gdk_pixbuf_composite (info->icon_pixbuf, pixbuf,
893 ref_x - icon_x, ref_y - icon_y,
894 icon_width, icon_height,
895 ref_x - icon_x, ref_y - icon_y,
897 GDK_INTERP_BILINEAR, 255);
899 gdk_pixbuf_composite (cursor_pixbuf, pixbuf,
900 ref_x - hot_x, ref_y - hot_y,
901 cursor_width, cursor_height,
902 ref_x - hot_x, ref_y - hot_y,
904 GDK_INTERP_BILINEAR, 255);
906 info->drag_cursors[i] =
907 gdk_cursor_new_from_pixbuf (display, pixbuf, ref_x, ref_y);
909 g_object_unref (pixbuf);
912 g_object_unref (cursor_pixbuf);
914 if (info->drag_cursors[i] != NULL)
915 return info->drag_cursors[i];
918 return drag_cursors[i].cursor;
922 gtk_drag_update_cursor (GtkDragSourceInfo *info)
927 if (!info->have_grab)
930 for (i = 0 ; i < n_drag_cursors - 1; i++)
931 if (info->cursor == drag_cursors[i].cursor ||
932 info->cursor == info->drag_cursors[i])
935 if (i == n_drag_cursors)
938 cursor = gtk_drag_get_cursor (gdk_cursor_get_display (info->cursor),
939 drag_cursors[i].action, info);
941 if (cursor != info->cursor)
943 gdk_pointer_grab (info->ipc_widget->window, FALSE,
944 GDK_POINTER_MOTION_MASK |
945 GDK_BUTTON_RELEASE_MASK,
947 cursor, info->grab_time);
948 info->cursor = cursor;
952 /********************
954 ********************/
956 /*************************************************************
958 * Get the data for a drag or drop
960 * context - drag context
961 * target - format to retrieve the data in.
962 * time - timestamp of triggering event.
965 *************************************************************/
968 gtk_drag_get_data (GtkWidget *widget,
969 GdkDragContext *context,
973 GtkWidget *selection_widget;
975 g_return_if_fail (GTK_IS_WIDGET (widget));
976 g_return_if_fail (GDK_IS_DRAG_CONTEXT (context));
977 g_return_if_fail (!context->is_source);
979 selection_widget = gtk_drag_get_ipc_widget (widget);
981 g_object_ref (context);
982 g_object_ref (widget);
984 g_signal_connect (selection_widget, "selection-received",
985 G_CALLBACK (gtk_drag_selection_received), widget);
987 g_object_set_data (G_OBJECT (selection_widget), I_("drag-context"), context);
989 gtk_selection_convert (selection_widget,
990 gdk_drag_get_selection (context),
996 /*************************************************************
997 * gtk_drag_get_source_widget:
998 * Get the widget the was the source of this drag, if
999 * the drag originated from this application.
1001 * context: The drag context for this drag
1003 * The source widget, or NULL if the drag originated from
1004 * a different application.
1005 *************************************************************/
1008 gtk_drag_get_source_widget (GdkDragContext *context)
1012 g_return_val_if_fail (GDK_IS_DRAG_CONTEXT (context), NULL);
1013 g_return_val_if_fail (!context->is_source, NULL);
1015 tmp_list = source_widgets;
1018 GtkWidget *ipc_widget = tmp_list->data;
1020 if (ipc_widget->window == context->source_window)
1022 GtkDragSourceInfo *info;
1023 info = g_object_get_data (G_OBJECT (ipc_widget), "gtk-info");
1025 return info ? info->widget : NULL;
1028 tmp_list = tmp_list->next;
1034 /*************************************************************
1036 * Notify the drag source that the transfer of data
1039 * context: The drag context for this drag
1040 * success: Was the data successfully transferred?
1041 * time: The timestamp to use when notifying the destination.
1043 *************************************************************/
1046 gtk_drag_finish (GdkDragContext *context,
1051 GdkAtom target = GDK_NONE;
1053 g_return_if_fail (GDK_IS_DRAG_CONTEXT (context));
1054 g_return_if_fail (!context->is_source);
1058 target = gdk_atom_intern_static_string ("DELETE");
1060 else if (context->protocol == GDK_DRAG_PROTO_MOTIF)
1062 target = gdk_atom_intern_static_string (success ?
1063 "XmTRANSFER_SUCCESS" :
1064 "XmTRANSFER_FAILURE");
1067 if (target != GDK_NONE)
1069 GtkWidget *selection_widget = gtk_drag_get_ipc_widget_for_screen (gdk_drawable_get_screen (context->source_window));
1071 g_object_ref (context);
1073 g_object_set_data (G_OBJECT (selection_widget), I_("drag-context"), context);
1074 g_signal_connect (selection_widget, "selection-received",
1075 G_CALLBACK (gtk_drag_selection_received),
1078 gtk_selection_convert (selection_widget,
1079 gdk_drag_get_selection (context),
1084 if (!(success && del))
1085 gdk_drop_finish (context, success, time);
1088 /*************************************************************
1089 * gtk_drag_highlight_expose:
1090 * Callback for expose_event for highlighted widgets.
1096 *************************************************************/
1099 gtk_drag_highlight_expose (GtkWidget *widget,
1100 GdkEventExpose *event,
1103 gint x, y, width, height;
1105 if (GTK_WIDGET_DRAWABLE (widget))
1109 if (GTK_WIDGET_NO_WINDOW (widget))
1111 x = widget->allocation.x;
1112 y = widget->allocation.y;
1113 width = widget->allocation.width;
1114 height = widget->allocation.height;
1120 gdk_drawable_get_size (widget->window, &width, &height);
1123 gtk_paint_shadow (widget->style, widget->window,
1124 GTK_STATE_NORMAL, GTK_SHADOW_OUT,
1125 &event->area, widget, "dnd",
1126 x, y, width, height);
1128 cr = gdk_cairo_create (widget->window);
1129 cairo_set_source_rgb (cr, 0.0, 0.0, 0.0); /* black */
1130 cairo_set_line_width (cr, 1.0);
1131 cairo_rectangle (cr,
1133 width - 1, height - 1);
1141 /*************************************************************
1142 * gtk_drag_highlight:
1143 * Highlight the given widget in the default manner.
1147 *************************************************************/
1150 gtk_drag_highlight (GtkWidget *widget)
1152 g_return_if_fail (GTK_IS_WIDGET (widget));
1154 g_signal_connect_after (widget, "expose-event",
1155 G_CALLBACK (gtk_drag_highlight_expose),
1158 gtk_widget_queue_draw (widget);
1161 /*************************************************************
1162 * gtk_drag_unhighlight:
1163 * Refresh the given widget to remove the highlight.
1167 *************************************************************/
1170 gtk_drag_unhighlight (GtkWidget *widget)
1172 g_return_if_fail (GTK_IS_WIDGET (widget));
1174 g_signal_handlers_disconnect_by_func (widget,
1175 gtk_drag_highlight_expose,
1178 gtk_widget_queue_draw (widget);
1182 gtk_drag_dest_set_internal (GtkWidget *widget,
1183 GtkDragDestSite *site)
1185 GtkDragDestSite *old_site;
1187 g_return_if_fail (widget != NULL);
1189 /* HACK, do this in the destroy */
1190 old_site = g_object_get_data (G_OBJECT (widget), "gtk-drag-dest");
1193 g_signal_handlers_disconnect_by_func (widget,
1194 gtk_drag_dest_realized,
1196 g_signal_handlers_disconnect_by_func (widget,
1197 gtk_drag_dest_hierarchy_changed,
1200 site->track_motion = old_site->track_motion;
1203 if (GTK_WIDGET_REALIZED (widget))
1204 gtk_drag_dest_realized (widget);
1206 g_signal_connect (widget, "realize",
1207 G_CALLBACK (gtk_drag_dest_realized), site);
1208 g_signal_connect (widget, "hierarchy-changed",
1209 G_CALLBACK (gtk_drag_dest_hierarchy_changed), site);
1211 g_object_set_data_full (G_OBJECT (widget), I_("gtk-drag-dest"),
1212 site, gtk_drag_dest_site_destroy);
1216 * gtk_drag_dest_set:
1217 * @widget: a #GtkWidget
1218 * @flags: which types of default drag behavior to use
1219 * @targets: a pointer to an array of #GtkTargetEntry<!-- -->s indicating
1220 * the drop types that this @widget will accept. Later you can access the list
1221 * with gtk_drag_dest_get_target_list() and gtk_drag_dest_find_target().
1222 * @n_targets: the number of entries in @targets.
1223 * @actions: a bitmask of possible actions for a drop onto this @widget.
1225 * Sets a widget as a potential drop destination, and adds default behaviors.
1227 * The default behaviors listed in @flags have an effect similar
1228 * to installing default handlers for the widget's drag-and-drop signals
1229 * (#GtkWidget:drag-motion, #GtkWidget:drag-drop, ...). They all exist
1230 * for convenience. When passing #GTK_DEST_DEFAULT_ALL for instance it is
1231 * sufficient to connect to the widget's #GtkWidget::drag-data-received
1232 * signal to get primitive, but consistent drag-and-drop support.
1234 * Things become more complicated when you try to preview the dragged data,
1235 * as described in the documentation for #GtkWidget:drag-motion. The default
1236 * behaviors described by @flags make some assumptions, that can conflict
1237 * with your own signal handlers. For instance #GTK_DEST_DEFAULT_DROP causes
1238 * invokations of gdk_drag_status() in the context of #GtkWidget:drag-motion,
1239 * and invokations of gtk_drag_finish() in #GtkWidget:drag-data-received.
1240 * Especially the later is dramatic, when your own #GtkWidget:drag-motion
1241 * handler calls gtk_drag_get_data() to inspect the dragged data.
1244 gtk_drag_dest_set (GtkWidget *widget,
1245 GtkDestDefaults flags,
1246 const GtkTargetEntry *targets,
1248 GdkDragAction actions)
1250 GtkDragDestSite *site;
1252 g_return_if_fail (GTK_IS_WIDGET (widget));
1254 site = g_new (GtkDragDestSite, 1);
1256 site->flags = flags;
1257 site->have_drag = FALSE;
1259 site->target_list = gtk_target_list_new (targets, n_targets);
1261 site->target_list = NULL;
1262 site->actions = actions;
1263 site->do_proxy = FALSE;
1264 site->proxy_window = NULL;
1265 site->track_motion = FALSE;
1267 gtk_drag_dest_set_internal (widget, site);
1270 /*************************************************************
1271 * gtk_drag_dest_set_proxy:
1272 * Set up this widget to proxy drags elsewhere.
1275 * proxy_window: window to which forward drag events
1276 * protocol: Drag protocol which the dest widget accepts
1277 * use_coordinates: If true, send the same coordinates to the
1278 * destination, because it is a embedded
1281 *************************************************************/
1284 gtk_drag_dest_set_proxy (GtkWidget *widget,
1285 GdkWindow *proxy_window,
1286 GdkDragProtocol protocol,
1287 gboolean use_coordinates)
1289 GtkDragDestSite *site;
1291 g_return_if_fail (GTK_IS_WIDGET (widget));
1292 g_return_if_fail (!proxy_window || GDK_IS_WINDOW (proxy_window));
1294 site = g_new (GtkDragDestSite, 1);
1297 site->have_drag = FALSE;
1298 site->target_list = NULL;
1300 site->proxy_window = proxy_window;
1302 g_object_ref (proxy_window);
1303 site->do_proxy = TRUE;
1304 site->proxy_protocol = protocol;
1305 site->proxy_coords = use_coordinates;
1306 site->track_motion = FALSE;
1308 gtk_drag_dest_set_internal (widget, site);
1311 /*************************************************************
1312 * gtk_drag_dest_unset
1313 * Unregister this widget as a drag target.
1317 *************************************************************/
1320 gtk_drag_dest_unset (GtkWidget *widget)
1322 g_return_if_fail (GTK_IS_WIDGET (widget));
1324 g_object_set_data (G_OBJECT (widget), I_("gtk-drag-dest"), NULL);
1328 * gtk_drag_dest_get_target_list:
1329 * @widget: a #GtkWidget
1331 * Returns the list of targets this widget can accept from
1334 * Return value: the #GtkTargetList, or %NULL if none
1337 gtk_drag_dest_get_target_list (GtkWidget *widget)
1339 GtkDragDestSite *site;
1341 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
1343 site = g_object_get_data (G_OBJECT (widget), "gtk-drag-dest");
1345 return site ? site->target_list : NULL;
1349 * gtk_drag_dest_set_target_list:
1350 * @widget: a #GtkWidget that's a drag destination
1351 * @target_list: list of droppable targets, or %NULL for none
1353 * Sets the target types that this widget can accept from drag-and-drop.
1354 * The widget must first be made into a drag destination with
1355 * gtk_drag_dest_set().
1358 gtk_drag_dest_set_target_list (GtkWidget *widget,
1359 GtkTargetList *target_list)
1361 GtkDragDestSite *site;
1363 g_return_if_fail (GTK_IS_WIDGET (widget));
1365 site = g_object_get_data (G_OBJECT (widget), "gtk-drag-dest");
1369 g_warning ("Can't set a target list on a widget until you've called gtk_drag_dest_set() "
1370 "to make the widget into a drag destination");
1375 gtk_target_list_ref (target_list);
1377 if (site->target_list)
1378 gtk_target_list_unref (site->target_list);
1380 site->target_list = target_list;
1384 * gtk_drag_dest_add_text_targets:
1385 * @widget: a #GtkWidget that's a drag destination
1387 * Add the text targets supported by #GtkSelection to
1388 * the target list of the drag destination. The targets
1389 * are added with @info = 0. If you need another value,
1390 * use gtk_target_list_add_text_targets() and
1391 * gtk_drag_dest_set_target_list().
1396 gtk_drag_dest_add_text_targets (GtkWidget *widget)
1398 GtkTargetList *target_list;
1400 target_list = gtk_drag_dest_get_target_list (widget);
1402 gtk_target_list_ref (target_list);
1404 target_list = gtk_target_list_new (NULL, 0);
1405 gtk_target_list_add_text_targets (target_list, 0);
1406 gtk_drag_dest_set_target_list (widget, target_list);
1407 gtk_target_list_unref (target_list);
1411 * gtk_drag_dest_add_image_targets:
1412 * @widget: a #GtkWidget that's a drag destination
1414 * Add the image targets supported by #GtkSelection to
1415 * the target list of the drag destination. The targets
1416 * are added with @info = 0. If you need another value,
1417 * use gtk_target_list_add_image_targets() and
1418 * gtk_drag_dest_set_target_list().
1423 gtk_drag_dest_add_image_targets (GtkWidget *widget)
1425 GtkTargetList *target_list;
1427 target_list = gtk_drag_dest_get_target_list (widget);
1429 gtk_target_list_ref (target_list);
1431 target_list = gtk_target_list_new (NULL, 0);
1432 gtk_target_list_add_image_targets (target_list, 0, FALSE);
1433 gtk_drag_dest_set_target_list (widget, target_list);
1434 gtk_target_list_unref (target_list);
1438 * gtk_drag_dest_add_uri_targets:
1439 * @widget: a #GtkWidget that's a drag destination
1441 * Add the URI targets supported by #GtkSelection to
1442 * the target list of the drag destination. The targets
1443 * are added with @info = 0. If you need another value,
1444 * use gtk_target_list_add_uri_targets() and
1445 * gtk_drag_dest_set_target_list().
1450 gtk_drag_dest_add_uri_targets (GtkWidget *widget)
1452 GtkTargetList *target_list;
1454 target_list = gtk_drag_dest_get_target_list (widget);
1456 gtk_target_list_ref (target_list);
1458 target_list = gtk_target_list_new (NULL, 0);
1459 gtk_target_list_add_uri_targets (target_list, 0);
1460 gtk_drag_dest_set_target_list (widget, target_list);
1461 gtk_target_list_unref (target_list);
1465 * gtk_drag_dest_set_track_motion:
1466 * @widget: a #GtkWidget that's a drag destination
1467 * @track_motion: whether to accept all targets
1469 * Tells the widget to emit ::drag-motion and ::drag-leave
1470 * events regardless of the targets and the %GTK_DEST_DEFAULT_MOTION
1473 * This may be used when a widget wants to do generic
1474 * actions regardless of the targets that the source offers.
1479 gtk_drag_dest_set_track_motion (GtkWidget *widget,
1480 gboolean track_motion)
1482 GtkDragDestSite *site;
1484 g_return_if_fail (GTK_IS_WIDGET (widget));
1486 site = g_object_get_data (G_OBJECT (widget), "gtk-drag-dest");
1488 g_return_if_fail (site != NULL);
1490 site->track_motion = track_motion != FALSE;
1494 * gtk_drag_dest_get_track_motion:
1495 * @widget: a #GtkWidget that's a drag destination
1497 * Returns whether the widget has been configured to always
1498 * emit ::drag-motion signals.
1500 * Return Value: %TRUE if the widget always emits ::drag-motion events
1505 gtk_drag_dest_get_track_motion (GtkWidget *widget)
1507 GtkDragDestSite *site;
1509 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
1511 site = g_object_get_data (G_OBJECT (widget), "gtk-drag-dest");
1514 return site->track_motion;
1519 /*************************************************************
1520 * _gtk_drag_dest_handle_event:
1521 * Called from widget event handling code on Drag events
1525 * toplevel: Toplevel widget that received the event
1528 *************************************************************/
1531 _gtk_drag_dest_handle_event (GtkWidget *toplevel,
1534 GtkDragDestInfo *info;
1535 GdkDragContext *context;
1537 g_return_if_fail (toplevel != NULL);
1538 g_return_if_fail (event != NULL);
1540 context = event->dnd.context;
1542 info = gtk_drag_get_dest_info (context, TRUE);
1544 /* Find the widget for the event */
1545 switch (event->type)
1547 case GDK_DRAG_ENTER:
1550 case GDK_DRAG_LEAVE:
1553 gtk_drag_dest_leave (info->widget, context, event->dnd.time);
1554 info->widget = NULL;
1558 case GDK_DRAG_MOTION:
1559 case GDK_DROP_START:
1561 GtkDragFindData data;
1564 if (event->type == GDK_DROP_START)
1566 info->dropped = TRUE;
1567 /* We send a leave here so that the widget unhighlights
1572 gtk_drag_dest_leave (info->widget, context, event->dnd.time);
1573 info->widget = NULL;
1577 #ifdef GDK_WINDOWING_X11
1578 /* Hackaround for: http://bugzilla.gnome.org/show_bug.cgi?id=136112
1580 * Currently gdk_window_get_position doesn't provide reliable
1581 * information for embedded windows, so we call the much more
1582 * expensive gdk_window_get_origin().
1584 if (GTK_IS_PLUG (toplevel))
1585 gdk_window_get_origin (toplevel->window, &tx, &ty);
1587 #endif /* GDK_WINDOWING_X11 */
1588 gdk_window_get_position (toplevel->window, &tx, &ty);
1590 data.x = event->dnd.x_root - tx;
1591 data.y = event->dnd.y_root - ty;
1592 data.context = context;
1595 data.toplevel = TRUE;
1596 data.callback = (event->type == GDK_DRAG_MOTION) ?
1597 gtk_drag_dest_motion : gtk_drag_dest_drop;
1598 data.time = event->dnd.time;
1600 gtk_drag_find_widget (toplevel, &data);
1602 if (info->widget && !data.found)
1604 gtk_drag_dest_leave (info->widget, context, event->dnd.time);
1605 info->widget = NULL;
1610 if (event->type == GDK_DRAG_MOTION)
1613 gdk_drag_status (context, 0, event->dnd.time);
1615 else if (event->type == GDK_DROP_START && !info->proxy_source)
1617 gdk_drop_reply (context, data.found, event->dnd.time);
1618 if ((context->protocol == GDK_DRAG_PROTO_MOTIF) && !data.found)
1619 gtk_drag_finish (context, FALSE, FALSE, event->dnd.time);
1625 g_assert_not_reached ();
1630 * gtk_drag_dest_find_target:
1631 * @widget: drag destination widget
1632 * @context: drag context
1633 * @target_list: list of droppable targets, or %NULL to use
1634 * gtk_drag_dest_get_target_list (@widget).
1636 * Looks for a match between @context->targets and the
1637 * @dest_target_list, returning the first matching target, otherwise
1638 * returning %GDK_NONE. @dest_target_list should usually be the return
1639 * value from gtk_drag_dest_get_target_list(), but some widgets may
1640 * have different valid targets for different parts of the widget; in
1641 * that case, they will have to implement a drag_motion handler that
1642 * passes the correct target list to this function.
1644 * Return value: first target that the source offers and the dest can accept, or %GDK_NONE
1647 gtk_drag_dest_find_target (GtkWidget *widget,
1648 GdkDragContext *context,
1649 GtkTargetList *target_list)
1652 GList *tmp_source = NULL;
1653 GtkWidget *source_widget;
1655 g_return_val_if_fail (GTK_IS_WIDGET (widget), GDK_NONE);
1656 g_return_val_if_fail (GDK_IS_DRAG_CONTEXT (context), GDK_NONE);
1657 g_return_val_if_fail (!context->is_source, GDK_NONE);
1660 source_widget = gtk_drag_get_source_widget (context);
1662 if (target_list == NULL)
1663 target_list = gtk_drag_dest_get_target_list (widget);
1665 if (target_list == NULL)
1668 tmp_target = target_list->list;
1671 GtkTargetPair *pair = tmp_target->data;
1672 tmp_source = context->targets;
1675 if (tmp_source->data == GUINT_TO_POINTER (pair->target))
1677 if ((!(pair->flags & GTK_TARGET_SAME_APP) || source_widget) &&
1678 (!(pair->flags & GTK_TARGET_SAME_WIDGET) || (source_widget == widget)) &&
1679 (!(pair->flags & GTK_TARGET_OTHER_APP) || !source_widget) &&
1680 (!(pair->flags & GTK_TARGET_OTHER_WIDGET) || (source_widget != widget)))
1681 return pair->target;
1685 tmp_source = tmp_source->next;
1687 tmp_target = tmp_target->next;
1694 gtk_drag_selection_received (GtkWidget *widget,
1695 GtkSelectionData *selection_data,
1699 GdkDragContext *context;
1700 GtkDragDestInfo *info;
1701 GtkWidget *drop_widget;
1705 context = g_object_get_data (G_OBJECT (widget), "drag-context");
1706 info = gtk_drag_get_dest_info (context, FALSE);
1708 if (info->proxy_data &&
1709 info->proxy_data->target == selection_data->target)
1711 gtk_selection_data_set (info->proxy_data,
1712 selection_data->type,
1713 selection_data->format,
1714 selection_data->data,
1715 selection_data->length);
1720 if (selection_data->target == gdk_atom_intern_static_string ("DELETE"))
1722 gtk_drag_finish (context, TRUE, FALSE, time);
1724 else if ((selection_data->target == gdk_atom_intern_static_string ("XmTRANSFER_SUCCESS")) ||
1725 (selection_data->target == gdk_atom_intern_static_string ("XmTRANSFER_FAILURE")))
1731 GtkDragDestSite *site;
1733 site = g_object_get_data (G_OBJECT (drop_widget), "gtk-drag-dest");
1735 if (site && site->target_list)
1739 if (gtk_target_list_find (site->target_list,
1740 selection_data->target,
1743 if (!(site->flags & GTK_DEST_DEFAULT_DROP) ||
1744 selection_data->length >= 0)
1745 g_signal_emit_by_name (drop_widget,
1746 "drag-data-received",
1747 context, info->drop_x, info->drop_y,
1754 g_signal_emit_by_name (drop_widget,
1755 "drag-data-received",
1756 context, info->drop_x, info->drop_y,
1761 if (site && site->flags & GTK_DEST_DEFAULT_DROP)
1764 gtk_drag_finish (context,
1765 (selection_data->length >= 0),
1766 (context->action == GDK_ACTION_MOVE),
1770 g_object_unref (drop_widget);
1773 g_signal_handlers_disconnect_by_func (widget,
1774 gtk_drag_selection_received,
1777 g_object_set_data (G_OBJECT (widget), I_("drag-context"), NULL);
1778 g_object_unref (context);
1780 gtk_drag_release_ipc_widget (widget);
1784 prepend_and_ref_widget (GtkWidget *widget,
1787 GSList **slist_p = data;
1789 *slist_p = g_slist_prepend (*slist_p, g_object_ref (widget));
1792 /*************************************************************
1793 * gtk_drag_find_widget:
1794 * Recursive callback used to locate widgets for
1795 * DRAG_MOTION and DROP_START events.
1799 *************************************************************/
1802 gtk_drag_find_widget (GtkWidget *widget,
1803 GtkDragFindData *data)
1805 GtkAllocation new_allocation;
1806 gint allocation_to_window_x = 0;
1807 gint allocation_to_window_y = 0;
1811 if (data->found || !GTK_WIDGET_MAPPED (widget) || !GTK_WIDGET_SENSITIVE (widget))
1814 /* Note that in the following code, we only count the
1815 * position as being inside a WINDOW widget if it is inside
1816 * widget->window; points that are outside of widget->window
1817 * but within the allocation are not counted. This is consistent
1818 * with the way we highlight drag targets.
1820 * data->x,y are relative to widget->parent->window (if
1821 * widget is not a toplevel, widget->window otherwise).
1822 * We compute the allocation of widget in the same coordinates,
1823 * clipping to widget->window, and all intermediate
1824 * windows. If data->x,y is inside that, then we translate
1825 * our coordinates to be relative to widget->window and
1828 new_allocation = widget->allocation;
1833 GdkWindow *window = widget->window;
1835 /* Compute the offset from allocation-relative to
1836 * window-relative coordinates.
1838 allocation_to_window_x = widget->allocation.x;
1839 allocation_to_window_y = widget->allocation.y;
1841 if (!GTK_WIDGET_NO_WINDOW (widget))
1843 /* The allocation is relative to the parent window for
1844 * window widgets, not to widget->window.
1846 gdk_window_get_position (window, &tx, &ty);
1848 allocation_to_window_x -= tx;
1849 allocation_to_window_y -= ty;
1852 new_allocation.x = 0 + allocation_to_window_x;
1853 new_allocation.y = 0 + allocation_to_window_y;
1855 while (window && window != widget->parent->window)
1857 GdkRectangle window_rect = { 0, 0, 0, 0 };
1859 gdk_drawable_get_size (window, &window_rect.width, &window_rect.height);
1861 gdk_rectangle_intersect (&new_allocation, &window_rect, &new_allocation);
1863 gdk_window_get_position (window, &tx, &ty);
1864 new_allocation.x += tx;
1866 new_allocation.y += ty;
1869 window = gdk_window_get_parent (window);
1872 if (!window) /* Window and widget heirarchies didn't match. */
1876 if (data->toplevel ||
1877 ((data->x >= new_allocation.x) && (data->y >= new_allocation.y) &&
1878 (data->x < new_allocation.x + new_allocation.width) &&
1879 (data->y < new_allocation.y + new_allocation.height)))
1881 /* First, check if the drag is in a valid drop site in
1882 * one of our children
1884 if (GTK_IS_CONTAINER (widget))
1886 GtkDragFindData new_data = *data;
1887 GSList *children = NULL;
1890 new_data.x -= x_offset;
1891 new_data.y -= y_offset;
1892 new_data.found = FALSE;
1893 new_data.toplevel = FALSE;
1895 /* need to reference children temporarily in case the
1896 * ::drag-motion/::drag-drop callbacks change the widget hierarchy.
1898 gtk_container_forall (GTK_CONTAINER (widget), prepend_and_ref_widget, &children);
1899 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
1901 if (!new_data.found && GTK_WIDGET_DRAWABLE (tmp_list->data))
1902 gtk_drag_find_widget (tmp_list->data, &new_data);
1903 g_object_unref (tmp_list->data);
1905 g_slist_free (children);
1907 data->found = new_data.found;
1910 /* If not, and this widget is registered as a drop site, check to
1911 * emit "drag-motion" to check if we are actually in
1915 g_object_get_data (G_OBJECT (widget), "gtk-drag-dest"))
1917 data->found = data->callback (widget,
1919 data->x - x_offset - allocation_to_window_x,
1920 data->y - y_offset - allocation_to_window_y,
1922 /* If so, send a "drag-leave" to the last widget */
1925 if (data->info->widget && data->info->widget != widget)
1927 gtk_drag_dest_leave (data->info->widget, data->context, data->time);
1929 data->info->widget = widget;
1936 gtk_drag_proxy_begin (GtkWidget *widget,
1937 GtkDragDestInfo *dest_info,
1940 GtkDragSourceInfo *source_info;
1942 GdkDragContext *context;
1943 GtkWidget *ipc_widget;
1945 if (dest_info->proxy_source)
1947 gdk_drag_abort (dest_info->proxy_source->context, time);
1948 gtk_drag_source_info_destroy (dest_info->proxy_source);
1949 dest_info->proxy_source = NULL;
1952 ipc_widget = gtk_drag_get_ipc_widget (widget);
1953 context = gdk_drag_begin (ipc_widget->window,
1954 dest_info->context->targets);
1956 source_info = gtk_drag_get_source_info (context, TRUE);
1958 source_info->ipc_widget = ipc_widget;
1959 source_info->widget = g_object_ref (widget);
1961 source_info->target_list = gtk_target_list_new (NULL, 0);
1962 tmp_list = dest_info->context->targets;
1965 gtk_target_list_add (source_info->target_list,
1966 GDK_POINTER_TO_ATOM (tmp_list->data), 0, 0);
1967 tmp_list = tmp_list->next;
1970 source_info->proxy_dest = dest_info;
1972 g_signal_connect (ipc_widget,
1974 G_CALLBACK (gtk_drag_selection_get),
1977 dest_info->proxy_source = source_info;
1981 gtk_drag_dest_info_destroy (gpointer data)
1983 GtkDragDestInfo *info = data;
1988 static GtkDragDestInfo *
1989 gtk_drag_get_dest_info (GdkDragContext *context,
1992 GtkDragDestInfo *info;
1993 static GQuark info_quark = 0;
1995 info_quark = g_quark_from_static_string ("gtk-dest-info");
1997 info = g_object_get_qdata (G_OBJECT (context), info_quark);
1998 if (!info && create)
2000 info = g_new (GtkDragDestInfo, 1);
2001 info->widget = NULL;
2002 info->context = context;
2003 info->proxy_source = NULL;
2004 info->proxy_data = NULL;
2005 info->dropped = FALSE;
2006 info->proxy_drop_wait = FALSE;
2007 g_object_set_qdata_full (G_OBJECT (context), info_quark,
2008 info, gtk_drag_dest_info_destroy);
2014 static GQuark dest_info_quark = 0;
2016 static GtkDragSourceInfo *
2017 gtk_drag_get_source_info (GdkDragContext *context,
2020 GtkDragSourceInfo *info;
2021 if (!dest_info_quark)
2022 dest_info_quark = g_quark_from_static_string ("gtk-source-info");
2024 info = g_object_get_qdata (G_OBJECT (context), dest_info_quark);
2025 if (!info && create)
2027 info = g_new0 (GtkDragSourceInfo, 1);
2028 info->context = context;
2029 g_object_set_qdata (G_OBJECT (context), dest_info_quark, info);
2036 gtk_drag_clear_source_info (GdkDragContext *context)
2038 g_object_set_qdata (G_OBJECT (context), dest_info_quark, NULL);
2042 gtk_drag_dest_realized (GtkWidget *widget)
2044 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
2046 if (GTK_WIDGET_TOPLEVEL (toplevel))
2047 gdk_window_register_dnd (toplevel->window);
2051 gtk_drag_dest_hierarchy_changed (GtkWidget *widget,
2052 GtkWidget *previous_toplevel)
2054 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
2056 if (GTK_WIDGET_TOPLEVEL (toplevel) && GTK_WIDGET_REALIZED (toplevel))
2057 gdk_window_register_dnd (toplevel->window);
2061 gtk_drag_dest_site_destroy (gpointer data)
2063 GtkDragDestSite *site = data;
2065 if (site->proxy_window)
2066 g_object_unref (site->proxy_window);
2068 if (site->target_list)
2069 gtk_target_list_unref (site->target_list);
2075 * Default drag handlers
2078 gtk_drag_dest_leave (GtkWidget *widget,
2079 GdkDragContext *context,
2082 GtkDragDestSite *site;
2084 site = g_object_get_data (G_OBJECT (widget), "gtk-drag-dest");
2085 g_return_if_fail (site != NULL);
2089 GtkDragDestInfo *info = gtk_drag_get_dest_info (context, FALSE);
2091 if (info->proxy_source && info->proxy_source->widget == widget && !info->dropped)
2093 gdk_drag_abort (info->proxy_source->context, time);
2094 gtk_drag_source_info_destroy (info->proxy_source);
2095 info->proxy_source = NULL;
2102 if ((site->flags & GTK_DEST_DEFAULT_HIGHLIGHT) && site->have_drag)
2103 gtk_drag_unhighlight (widget);
2105 if (!(site->flags & GTK_DEST_DEFAULT_MOTION) || site->have_drag ||
2107 g_signal_emit_by_name (widget, "drag-leave", context, time);
2109 site->have_drag = FALSE;
2114 gtk_drag_dest_motion (GtkWidget *widget,
2115 GdkDragContext *context,
2120 GtkDragDestSite *site;
2121 GdkDragAction action = 0;
2124 site = g_object_get_data (G_OBJECT (widget), "gtk-drag-dest");
2125 g_return_val_if_fail (site != NULL, FALSE);
2130 GdkEvent *current_event;
2131 GdkWindow *dest_window;
2132 GdkDragProtocol proto;
2134 GtkDragDestInfo *info = gtk_drag_get_dest_info (context, FALSE);
2136 if (!info->proxy_source || info->proxy_source->widget != widget)
2137 gtk_drag_proxy_begin (widget, info, time);
2139 current_event = gtk_get_current_event ();
2141 if (site->proxy_window)
2143 dest_window = site->proxy_window;
2144 proto = site->proxy_protocol;
2148 gdk_drag_find_window_for_screen (info->proxy_source->context,
2150 gdk_drawable_get_screen (current_event->dnd.window),
2151 current_event->dnd.x_root,
2152 current_event->dnd.y_root,
2153 &dest_window, &proto);
2156 gdk_drag_motion (info->proxy_source->context,
2158 current_event->dnd.x_root,
2159 current_event->dnd.y_root,
2160 context->suggested_action,
2161 context->actions, time);
2163 if (!site->proxy_window && dest_window)
2164 g_object_unref (dest_window);
2166 selection = gdk_drag_get_selection (info->proxy_source->context);
2168 selection != gdk_drag_get_selection (info->context))
2169 gtk_drag_source_check_selection (info->proxy_source, selection, time);
2171 gdk_event_free (current_event);
2176 if (site->track_motion || site->flags & GTK_DEST_DEFAULT_MOTION)
2178 if (context->suggested_action & site->actions)
2179 action = context->suggested_action;
2184 for (i = 0; i < 8; i++)
2186 if ((site->actions & (1 << i)) &&
2187 (context->actions & (1 << i)))
2195 if (action && gtk_drag_dest_find_target (widget, context, NULL))
2197 if (!site->have_drag)
2199 site->have_drag = TRUE;
2200 if (site->flags & GTK_DEST_DEFAULT_HIGHLIGHT)
2201 gtk_drag_highlight (widget);
2204 gdk_drag_status (context, action, time);
2208 gdk_drag_status (context, 0, time);
2209 if (!site->track_motion)
2214 g_signal_emit_by_name (widget, "drag-motion",
2215 context, x, y, time, &retval);
2217 return (site->flags & GTK_DEST_DEFAULT_MOTION) ? TRUE : retval;
2221 gtk_drag_dest_drop (GtkWidget *widget,
2222 GdkDragContext *context,
2227 GtkDragDestSite *site;
2228 GtkDragDestInfo *info;
2230 site = g_object_get_data (G_OBJECT (widget), "gtk-drag-dest");
2231 g_return_val_if_fail (site != NULL, FALSE);
2233 info = gtk_drag_get_dest_info (context, FALSE);
2234 g_return_val_if_fail (info != NULL, FALSE);
2241 if (info->proxy_source ||
2242 (info->context->protocol == GDK_DRAG_PROTO_ROOTWIN))
2244 gtk_drag_drop (info->proxy_source, time);
2248 /* We need to synthesize a motion event, wait for a status,
2249 * and, if we get a good one, do a drop.
2252 GdkEvent *current_event;
2254 GdkWindow *dest_window;
2255 GdkDragProtocol proto;
2257 gtk_drag_proxy_begin (widget, info, time);
2258 info->proxy_drop_wait = TRUE;
2259 info->proxy_drop_time = time;
2261 current_event = gtk_get_current_event ();
2263 if (site->proxy_window)
2265 dest_window = site->proxy_window;
2266 proto = site->proxy_protocol;
2270 gdk_drag_find_window_for_screen (info->proxy_source->context,
2272 gdk_drawable_get_screen (current_event->dnd.window),
2273 current_event->dnd.x_root,
2274 current_event->dnd.y_root,
2275 &dest_window, &proto);
2278 gdk_drag_motion (info->proxy_source->context,
2280 current_event->dnd.x_root,
2281 current_event->dnd.y_root,
2282 context->suggested_action,
2283 context->actions, time);
2285 if (!site->proxy_window && dest_window)
2286 g_object_unref (dest_window);
2288 selection = gdk_drag_get_selection (info->proxy_source->context);
2290 selection != gdk_drag_get_selection (info->context))
2291 gtk_drag_source_check_selection (info->proxy_source, selection, time);
2293 gdk_event_free (current_event);
2302 if (site->flags & GTK_DEST_DEFAULT_DROP)
2304 GdkAtom target = gtk_drag_dest_find_target (widget, context, NULL);
2306 if (target == GDK_NONE)
2308 gtk_drag_finish (context, FALSE, FALSE, time);
2312 gtk_drag_get_data (widget, context, target, time);
2315 g_signal_emit_by_name (widget, "drag-drop",
2316 context, x, y, time, &retval);
2318 return (site->flags & GTK_DEST_DEFAULT_DROP) ? TRUE : retval;
2326 /* Like GtkDragBegin, but also takes a GtkDragSourceSite,
2327 * so that we can set the icon from the source site information
2329 static GdkDragContext *
2330 gtk_drag_begin_internal (GtkWidget *widget,
2331 GtkDragSourceSite *site,
2332 GtkTargetList *target_list,
2333 GdkDragAction actions,
2337 GtkDragSourceInfo *info;
2338 GList *targets = NULL;
2340 guint32 time = GDK_CURRENT_TIME;
2341 GdkDragAction possible_actions, suggested_action;
2342 GdkDragContext *context;
2343 GtkWidget *ipc_widget;
2346 ipc_widget = gtk_drag_get_ipc_widget (widget);
2348 gtk_drag_get_event_actions (event, button, actions,
2349 &suggested_action, &possible_actions);
2351 cursor = gtk_drag_get_cursor (gtk_widget_get_display (widget),
2356 time = gdk_event_get_time (event);
2358 if (gdk_pointer_grab (ipc_widget->window, FALSE,
2359 GDK_POINTER_MOTION_MASK |
2360 GDK_BUTTON_RELEASE_MASK, NULL,
2361 cursor, time) != GDK_GRAB_SUCCESS)
2363 gtk_drag_release_ipc_widget (ipc_widget);
2367 grab_dnd_keys (ipc_widget, time);
2369 /* We use a GTK grab here to override any grabs that the widget
2370 * we are dragging from might have held
2372 gtk_grab_add (ipc_widget);
2374 tmp_list = g_list_last (target_list->list);
2377 GtkTargetPair *pair = tmp_list->data;
2378 targets = g_list_prepend (targets,
2379 GINT_TO_POINTER (pair->target));
2380 tmp_list = tmp_list->prev;
2383 source_widgets = g_slist_prepend (source_widgets, ipc_widget);
2385 context = gdk_drag_begin (ipc_widget->window, targets);
2386 g_list_free (targets);
2388 info = gtk_drag_get_source_info (context, TRUE);
2390 info->ipc_widget = ipc_widget;
2391 g_object_set_data (G_OBJECT (info->ipc_widget), I_("gtk-info"), info);
2393 info->widget = g_object_ref (widget);
2395 info->button = button;
2396 info->cursor = cursor;
2397 info->target_list = target_list;
2398 gtk_target_list_ref (target_list);
2400 info->possible_actions = actions;
2402 info->status = GTK_DRAG_STATUS_DRAG;
2403 info->last_event = NULL;
2404 info->selections = NULL;
2405 info->icon_window = NULL;
2406 info->destroy_icon = FALSE;
2408 /* Set cur_x, cur_y here so if the "drag-begin" signal shows
2409 * the drag icon, it will be in the right place
2411 if (event && event->type == GDK_MOTION_NOTIFY)
2413 info->cur_screen = gtk_widget_get_screen (widget);
2414 info->cur_x = event->motion.x_root;
2415 info->cur_y = event->motion.y_root;
2419 gdk_display_get_pointer (gtk_widget_get_display (widget),
2420 &info->cur_screen, &info->cur_x, &info->cur_y, NULL);
2423 g_signal_emit_by_name (widget, "drag-begin", info->context);
2425 /* Ensure that we have an icon before we start the drag; the
2426 * application may have set one in ::drag_begin, or it may
2429 if (!info->icon_window && !info->icon_pixbuf)
2431 if (!site || site->icon_type == GTK_IMAGE_EMPTY)
2432 gtk_drag_set_icon_default (context);
2434 switch (site->icon_type)
2436 case GTK_IMAGE_PIXMAP:
2437 gtk_drag_set_icon_pixmap (context,
2439 site->icon_data.pixmap.pixmap,
2443 case GTK_IMAGE_PIXBUF:
2444 gtk_drag_set_icon_pixbuf (context,
2445 site->icon_data.pixbuf.pixbuf,
2448 case GTK_IMAGE_STOCK:
2449 gtk_drag_set_icon_stock (context,
2450 site->icon_data.stock.stock_id,
2453 case GTK_IMAGE_ICON_NAME:
2454 gtk_drag_set_icon_name (context,
2455 site->icon_data.name.icon_name,
2458 case GTK_IMAGE_EMPTY:
2460 g_assert_not_reached();
2465 /* We need to composite the icon into the cursor, if we are
2466 * not using an icon window.
2468 if (info->icon_pixbuf)
2470 cursor = gtk_drag_get_cursor (gtk_widget_get_display (widget),
2474 if (cursor != info->cursor)
2476 gdk_pointer_grab (widget->window, FALSE,
2477 GDK_POINTER_MOTION_MASK |
2478 GDK_BUTTON_RELEASE_MASK,
2481 info->cursor = cursor;
2485 if (event && event->type == GDK_MOTION_NOTIFY)
2486 gtk_drag_motion_cb (info->ipc_widget, (GdkEventMotion *)event, info);
2488 gtk_drag_update (info, info->cur_screen, info->cur_x, info->cur_y, event);
2490 info->start_x = info->cur_x;
2491 info->start_y = info->cur_y;
2493 g_signal_connect (info->ipc_widget, "grab-broken-event",
2494 G_CALLBACK (gtk_drag_grab_broken_event_cb), info);
2495 g_signal_connect (info->ipc_widget, "grab-notify",
2496 G_CALLBACK (gtk_drag_grab_notify_cb), info);
2497 g_signal_connect (info->ipc_widget, "button-release-event",
2498 G_CALLBACK (gtk_drag_button_release_cb), info);
2499 g_signal_connect (info->ipc_widget, "motion-notify-event",
2500 G_CALLBACK (gtk_drag_motion_cb), info);
2501 g_signal_connect (info->ipc_widget, "key-press-event",
2502 G_CALLBACK (gtk_drag_key_cb), info);
2503 g_signal_connect (info->ipc_widget, "key-release-event",
2504 G_CALLBACK (gtk_drag_key_cb), info);
2505 g_signal_connect (info->ipc_widget, "selection-get",
2506 G_CALLBACK (gtk_drag_selection_get), info);
2508 info->have_grab = TRUE;
2509 info->grab_time = time;
2511 return info->context;
2516 * @widget: the source widget.
2517 * @targets: The targets (data formats) in which the
2518 * source can provide the data.
2519 * @actions: A bitmask of the allowed drag actions for this drag.
2520 * @button: The button the user clicked to start the drag.
2521 * @event: The event that triggered the start of the drag.
2523 * Initiates a drag on the source side. The function
2524 * only needs to be used when the application is
2525 * starting drags itself, and is not needed when
2526 * gtk_drag_source_set() is used.
2528 * Return value: the context for this drag.
2531 gtk_drag_begin (GtkWidget *widget,
2532 GtkTargetList *targets,
2533 GdkDragAction actions,
2537 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
2538 g_return_val_if_fail (GTK_WIDGET_REALIZED (widget), NULL);
2539 g_return_val_if_fail (targets != NULL, NULL);
2541 return gtk_drag_begin_internal (widget, NULL, targets,
2542 actions, button, event);
2545 /*************************************************************
2546 * gtk_drag_source_set:
2547 * Register a drop site, and possibly add default behaviors.
2550 * start_button_mask: Mask of allowed buttons to start drag
2551 * targets: Table of targets for this source
2553 * actions: Actions allowed for this source
2555 *************************************************************/
2558 gtk_drag_source_set (GtkWidget *widget,
2559 GdkModifierType start_button_mask,
2560 const GtkTargetEntry *targets,
2562 GdkDragAction actions)
2564 GtkDragSourceSite *site;
2566 g_return_if_fail (GTK_IS_WIDGET (widget));
2568 site = g_object_get_data (G_OBJECT (widget), "gtk-site-data");
2570 gtk_widget_add_events (widget,
2571 gtk_widget_get_events (widget) |
2572 GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
2573 GDK_BUTTON_MOTION_MASK);
2577 if (site->target_list)
2578 gtk_target_list_unref (site->target_list);
2582 site = g_new0 (GtkDragSourceSite, 1);
2584 site->icon_type = GTK_IMAGE_EMPTY;
2586 g_signal_connect (widget, "button-press-event",
2587 G_CALLBACK (gtk_drag_source_event_cb),
2589 g_signal_connect (widget, "button-release-event",
2590 G_CALLBACK (gtk_drag_source_event_cb),
2592 g_signal_connect (widget, "motion-notify-event",
2593 G_CALLBACK (gtk_drag_source_event_cb),
2596 g_object_set_data_full (G_OBJECT (widget),
2597 I_("gtk-site-data"),
2598 site, gtk_drag_source_site_destroy);
2601 site->start_button_mask = start_button_mask;
2603 site->target_list = gtk_target_list_new (targets, n_targets);
2605 site->actions = actions;
2608 /*************************************************************
2609 * gtk_drag_source_unset
2610 * Unregister this widget as a drag source.
2614 *************************************************************/
2617 gtk_drag_source_unset (GtkWidget *widget)
2619 GtkDragSourceSite *site;
2621 g_return_if_fail (GTK_IS_WIDGET (widget));
2623 site = g_object_get_data (G_OBJECT (widget), "gtk-site-data");
2627 g_signal_handlers_disconnect_by_func (widget,
2628 gtk_drag_source_event_cb,
2630 g_object_set_data (G_OBJECT (widget), I_("gtk-site-data"), NULL);
2635 * gtk_drag_source_get_target_list:
2636 * @widget: a #GtkWidget
2638 * Gets the list of targets this widget can provide for
2641 * Return value: the #GtkTargetList, or %NULL if none
2646 gtk_drag_source_get_target_list (GtkWidget *widget)
2648 GtkDragSourceSite *site;
2650 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
2652 site = g_object_get_data (G_OBJECT (widget), "gtk-site-data");
2654 return site ? site->target_list : NULL;
2658 * gtk_drag_source_set_target_list:
2659 * @widget: a #GtkWidget that's a drag source
2660 * @target_list: list of draggable targets, or %NULL for none
2662 * Changes the target types that this widget offers for drag-and-drop.
2663 * The widget must first be made into a drag source with
2664 * gtk_drag_source_set().
2669 gtk_drag_source_set_target_list (GtkWidget *widget,
2670 GtkTargetList *target_list)
2672 GtkDragSourceSite *site;
2674 g_return_if_fail (GTK_IS_WIDGET (widget));
2676 site = g_object_get_data (G_OBJECT (widget), "gtk-site-data");
2679 g_warning ("gtk_drag_source_set_target_list() requires the widget "
2680 "to already be a drag source.");
2685 gtk_target_list_ref (target_list);
2687 if (site->target_list)
2688 gtk_target_list_unref (site->target_list);
2690 site->target_list = target_list;
2694 * gtk_drag_source_add_text_targets:
2695 * @widget: a #GtkWidget that's is a drag source
2697 * Add the text targets supported by #GtkSelection to
2698 * the target list of the drag source. The targets
2699 * are added with @info = 0. If you need another value,
2700 * use gtk_target_list_add_text_targets() and
2701 * gtk_drag_source_set_target_list().
2706 gtk_drag_source_add_text_targets (GtkWidget *widget)
2708 GtkTargetList *target_list;
2710 target_list = gtk_drag_source_get_target_list (widget);
2712 gtk_target_list_ref (target_list);
2714 target_list = gtk_target_list_new (NULL, 0);
2715 gtk_target_list_add_text_targets (target_list, 0);
2716 gtk_drag_source_set_target_list (widget, target_list);
2717 gtk_target_list_unref (target_list);
2721 * gtk_drag_source_add_image_targets:
2722 * @widget: a #GtkWidget that's is a drag source
2724 * Add the writable image targets supported by #GtkSelection to
2725 * the target list of the drag source. The targets
2726 * are added with @info = 0. If you need another value,
2727 * use gtk_target_list_add_image_targets() and
2728 * gtk_drag_source_set_target_list().
2733 gtk_drag_source_add_image_targets (GtkWidget *widget)
2735 GtkTargetList *target_list;
2737 target_list = gtk_drag_source_get_target_list (widget);
2739 gtk_target_list_ref (target_list);
2741 target_list = gtk_target_list_new (NULL, 0);
2742 gtk_target_list_add_image_targets (target_list, 0, TRUE);
2743 gtk_drag_source_set_target_list (widget, target_list);
2744 gtk_target_list_unref (target_list);
2748 * gtk_drag_source_add_uri_targets:
2749 * @widget: a #GtkWidget that's is a drag source
2751 * Add the URI targets supported by #GtkSelection to
2752 * the target list of the drag source. The targets
2753 * are added with @info = 0. If you need another value,
2754 * use gtk_target_list_add_uri_targets() and
2755 * gtk_drag_source_set_target_list().
2760 gtk_drag_source_add_uri_targets (GtkWidget *widget)
2762 GtkTargetList *target_list;
2764 target_list = gtk_drag_source_get_target_list (widget);
2766 gtk_target_list_ref (target_list);
2768 target_list = gtk_target_list_new (NULL, 0);
2769 gtk_target_list_add_uri_targets (target_list, 0);
2770 gtk_drag_source_set_target_list (widget, target_list);
2771 gtk_target_list_unref (target_list);
2775 gtk_drag_source_unset_icon (GtkDragSourceSite *site)
2777 switch (site->icon_type)
2779 case GTK_IMAGE_EMPTY:
2781 case GTK_IMAGE_PIXMAP:
2782 if (site->icon_data.pixmap.pixmap)
2783 g_object_unref (site->icon_data.pixmap.pixmap);
2784 if (site->icon_mask)
2785 g_object_unref (site->icon_mask);
2787 case GTK_IMAGE_PIXBUF:
2788 g_object_unref (site->icon_data.pixbuf.pixbuf);
2790 case GTK_IMAGE_STOCK:
2791 g_free (site->icon_data.stock.stock_id);
2793 case GTK_IMAGE_ICON_NAME:
2794 g_free (site->icon_data.name.icon_name);
2797 g_assert_not_reached();
2800 site->icon_type = GTK_IMAGE_EMPTY;
2803 g_object_unref (site->colormap);
2804 site->colormap = NULL;
2808 * gtk_drag_source_set_icon:
2809 * @widget: a #GtkWidget
2810 * @colormap: the colormap of the icon
2811 * @pixmap: the image data for the icon
2812 * @mask: the transparency mask for an image.
2814 * Sets the icon that will be used for drags from a particular widget
2815 * from a pixmap/mask. GTK+ retains references for the arguments, and
2816 * will release them when they are no longer needed.
2817 * Use gtk_drag_source_set_icon_pixbuf() instead.
2820 gtk_drag_source_set_icon (GtkWidget *widget,
2821 GdkColormap *colormap,
2825 GtkDragSourceSite *site;
2827 g_return_if_fail (GTK_IS_WIDGET (widget));
2828 g_return_if_fail (GDK_IS_COLORMAP (colormap));
2829 g_return_if_fail (GDK_IS_PIXMAP (pixmap));
2830 g_return_if_fail (!mask || GDK_IS_PIXMAP (mask));
2832 site = g_object_get_data (G_OBJECT (widget), "gtk-site-data");
2833 g_return_if_fail (site != NULL);
2835 g_object_ref (colormap);
2836 g_object_ref (pixmap);
2838 g_object_ref (mask);
2840 gtk_drag_source_unset_icon (site);
2842 site->icon_type = GTK_IMAGE_PIXMAP;
2844 site->icon_data.pixmap.pixmap = pixmap;
2845 site->icon_mask = mask;
2846 site->colormap = colormap;
2850 * gtk_drag_source_set_icon_pixbuf:
2851 * @widget: a #GtkWidget
2852 * @pixbuf: the #GdkPixbuf for the drag icon
2854 * Sets the icon that will be used for drags from a particular widget
2855 * from a #GdkPixbuf. GTK+ retains a reference for @pixbuf and will
2856 * release it when it is no longer needed.
2859 gtk_drag_source_set_icon_pixbuf (GtkWidget *widget,
2862 GtkDragSourceSite *site;
2864 g_return_if_fail (GTK_IS_WIDGET (widget));
2865 g_return_if_fail (GDK_IS_PIXBUF (pixbuf));
2867 site = g_object_get_data (G_OBJECT (widget), "gtk-site-data");
2868 g_return_if_fail (site != NULL);
2869 g_object_ref (pixbuf);
2871 gtk_drag_source_unset_icon (site);
2873 site->icon_type = GTK_IMAGE_PIXBUF;
2874 site->icon_data.pixbuf.pixbuf = pixbuf;
2878 * gtk_drag_source_set_icon_stock:
2879 * @widget: a #GtkWidget
2880 * @stock_id: the ID of the stock icon to use
2882 * Sets the icon that will be used for drags from a particular source
2886 gtk_drag_source_set_icon_stock (GtkWidget *widget,
2887 const gchar *stock_id)
2889 GtkDragSourceSite *site;
2891 g_return_if_fail (GTK_IS_WIDGET (widget));
2892 g_return_if_fail (stock_id != NULL);
2894 site = g_object_get_data (G_OBJECT (widget), "gtk-site-data");
2895 g_return_if_fail (site != NULL);
2897 gtk_drag_source_unset_icon (site);
2899 site->icon_type = GTK_IMAGE_STOCK;
2900 site->icon_data.stock.stock_id = g_strdup (stock_id);
2904 * gtk_drag_source_set_icon_name:
2905 * @widget: a #GtkWidget
2906 * @icon_name: name of icon to use
2908 * Sets the icon that will be used for drags from a particular source
2909 * to a themed icon. See the docs for #GtkIconTheme for more details.
2914 gtk_drag_source_set_icon_name (GtkWidget *widget,
2915 const gchar *icon_name)
2917 GtkDragSourceSite *site;
2919 g_return_if_fail (GTK_IS_WIDGET (widget));
2920 g_return_if_fail (icon_name != NULL);
2922 site = g_object_get_data (G_OBJECT (widget), "gtk-site-data");
2923 g_return_if_fail (site != NULL);
2925 gtk_drag_source_unset_icon (site);
2927 site->icon_type = GTK_IMAGE_ICON_NAME;
2928 site->icon_data.name.icon_name = g_strdup (icon_name);
2932 gtk_drag_get_icon (GtkDragSourceInfo *info,
2933 GtkWidget **icon_window,
2937 if (get_can_change_screen (info->icon_window))
2938 gtk_window_set_screen (GTK_WINDOW (info->icon_window),
2941 if (gtk_widget_get_screen (info->icon_window) != info->cur_screen)
2943 if (!info->fallback_icon)
2945 gint save_hot_x, save_hot_y;
2946 gboolean save_destroy_icon;
2947 GtkWidget *save_icon_window;
2949 /* HACK to get the appropriate icon
2951 save_icon_window = info->icon_window;
2952 save_hot_x = info->hot_x;
2953 save_hot_y = info->hot_x;
2954 save_destroy_icon = info->destroy_icon;
2956 info->icon_window = NULL;
2957 if (!default_icon_pixmap)
2958 set_icon_stock_pixbuf (info->context,
2959 GTK_STOCK_DND, NULL, -2, -2, TRUE);
2961 gtk_drag_set_icon_pixmap (info->context,
2962 default_icon_colormap,
2963 default_icon_pixmap,
2966 default_icon_hot_y);
2967 info->fallback_icon = info->icon_window;
2969 info->icon_window = save_icon_window;
2970 info->hot_x = save_hot_x;
2971 info->hot_y = save_hot_y;
2972 info->destroy_icon = save_destroy_icon;
2975 gtk_widget_hide (info->icon_window);
2977 *icon_window = info->fallback_icon;
2978 gtk_window_set_screen (GTK_WINDOW (*icon_window), info->cur_screen);
2980 if (!default_icon_pixmap)
2987 *hot_x = default_icon_hot_x;
2988 *hot_y = default_icon_hot_y;
2993 if (info->fallback_icon)
2994 gtk_widget_hide (info->fallback_icon);
2996 *icon_window = info->icon_window;
2997 *hot_x = info->hot_x;
2998 *hot_y = info->hot_y;
3003 gtk_drag_update_icon (GtkDragSourceInfo *info)
3005 if (info->icon_window)
3007 GtkWidget *icon_window;
3010 gtk_drag_get_icon (info, &icon_window, &hot_x, &hot_y);
3012 gtk_window_move (GTK_WINDOW (icon_window),
3013 info->cur_x - hot_x,
3014 info->cur_y - hot_y);
3016 if (GTK_WIDGET_VISIBLE (icon_window))
3017 gdk_window_raise (icon_window->window);
3019 gtk_widget_show (icon_window);
3024 gtk_drag_set_icon_window (GdkDragContext *context,
3028 gboolean destroy_on_release)
3030 GtkDragSourceInfo *info;
3032 info = gtk_drag_get_source_info (context, FALSE);
3035 if (destroy_on_release)
3036 gtk_widget_destroy (widget);
3040 gtk_drag_remove_icon (info);
3043 g_object_ref (widget);
3045 info->icon_window = widget;
3046 info->hot_x = hot_x;
3047 info->hot_y = hot_y;
3048 info->destroy_icon = destroy_on_release;
3050 if (widget && info->icon_pixbuf)
3052 g_object_unref (info->icon_pixbuf);
3053 info->icon_pixbuf = NULL;
3056 gtk_drag_update_cursor (info);
3057 gtk_drag_update_icon (info);
3061 * gtk_drag_set_icon_widget:
3062 * @context: the context for a drag. (This must be called
3063 with a context for the source side of a drag)
3064 * @widget: a toplevel window to use as an icon.
3065 * @hot_x: the X offset within @widget of the hotspot.
3066 * @hot_y: the Y offset within @widget of the hotspot.
3068 * Changes the icon for a widget to a given widget. GTK+
3069 * will not destroy the icon, so if you don't want
3070 * it to persist, you should connect to the "drag-end"
3071 * signal and destroy it yourself.
3074 gtk_drag_set_icon_widget (GdkDragContext *context,
3079 g_return_if_fail (GDK_IS_DRAG_CONTEXT (context));
3080 g_return_if_fail (context->is_source);
3081 g_return_if_fail (GTK_IS_WIDGET (widget));
3083 gtk_drag_set_icon_window (context, widget, hot_x, hot_y, FALSE);
3087 icon_window_realize (GtkWidget *window,
3093 gdk_pixbuf_render_pixmap_and_mask_for_colormap (pixbuf,
3094 gtk_widget_get_colormap (window),
3095 &pixmap, &mask, 128);
3097 gdk_window_set_back_pixmap (window->window, pixmap, FALSE);
3098 g_object_unref (pixmap);
3102 gtk_widget_shape_combine_mask (window, mask, 0, 0);
3103 g_object_unref (mask);
3108 set_icon_stock_pixbuf (GdkDragContext *context,
3109 const gchar *stock_id,
3113 gboolean force_window)
3118 GdkDisplay *display;
3120 g_return_if_fail (context != NULL);
3121 g_return_if_fail (pixbuf != NULL || stock_id != NULL);
3122 g_return_if_fail (pixbuf == NULL || stock_id == NULL);
3124 screen = gdk_drawable_get_screen (context->source_window);
3126 /* Push a NULL colormap to guard against gtk_widget_push_colormap() */
3127 gtk_widget_push_colormap (NULL);
3128 window = gtk_window_new (GTK_WINDOW_POPUP);
3129 gtk_window_set_type_hint (GTK_WINDOW (window), GDK_WINDOW_TYPE_HINT_DND);
3130 gtk_window_set_screen (GTK_WINDOW (window), screen);
3131 set_can_change_screen (window, TRUE);
3132 gtk_widget_pop_colormap ();
3134 gtk_widget_set_events (window, GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK);
3135 gtk_widget_set_app_paintable (window, TRUE);
3139 pixbuf = gtk_widget_render_icon (window, stock_id,
3140 GTK_ICON_SIZE_DND, NULL);
3144 g_warning ("Cannot load drag icon from stock_id %s", stock_id);
3145 gtk_widget_destroy (window);
3151 g_object_ref (pixbuf);
3153 display = gdk_drawable_get_display (context->source_window);
3154 width = gdk_pixbuf_get_width (pixbuf);
3155 height = gdk_pixbuf_get_height (pixbuf);
3157 if (!force_window &&
3158 gtk_drag_can_use_rgba_cursor (display, width + 2, height + 2))
3160 GtkDragSourceInfo *info;
3162 gtk_widget_destroy (window);
3164 info = gtk_drag_get_source_info (context, FALSE);
3166 if (info->icon_pixbuf)
3167 g_object_unref (info->icon_pixbuf);
3168 info->icon_pixbuf = pixbuf;
3170 gtk_drag_set_icon_window (context, NULL, hot_x, hot_y, TRUE);
3174 gtk_widget_set_size_request (window, width, height);
3176 g_signal_connect_closure (window, "realize",
3177 g_cclosure_new (G_CALLBACK (icon_window_realize),
3179 (GClosureNotify)g_object_unref),
3182 gtk_drag_set_icon_window (context, window, hot_x, hot_y, TRUE);
3187 * gtk_drag_set_icon_pixbuf:
3188 * @context: the context for a drag. (This must be called
3189 * with a context for the source side of a drag)
3190 * @pixbuf: the #GdkPixbuf to use as the drag icon.
3191 * @hot_x: the X offset within @widget of the hotspot.
3192 * @hot_y: the Y offset within @widget of the hotspot.
3194 * Sets @pixbuf as the icon for a given drag.
3197 gtk_drag_set_icon_pixbuf (GdkDragContext *context,
3202 g_return_if_fail (GDK_IS_DRAG_CONTEXT (context));
3203 g_return_if_fail (context->is_source);
3204 g_return_if_fail (GDK_IS_PIXBUF (pixbuf));
3206 set_icon_stock_pixbuf (context, NULL, pixbuf, hot_x, hot_y, FALSE);
3210 * gtk_drag_set_icon_stock:
3211 * @context: the context for a drag. (This must be called
3212 * with a context for the source side of a drag)
3213 * @stock_id: the ID of the stock icon to use for the drag.
3214 * @hot_x: the X offset within the icon of the hotspot.
3215 * @hot_y: the Y offset within the icon of the hotspot.
3217 * Sets the icon for a given drag from a stock ID.
3220 gtk_drag_set_icon_stock (GdkDragContext *context,
3221 const gchar *stock_id,
3225 g_return_if_fail (GDK_IS_DRAG_CONTEXT (context));
3226 g_return_if_fail (context->is_source);
3227 g_return_if_fail (stock_id != NULL);
3229 set_icon_stock_pixbuf (context, stock_id, NULL, hot_x, hot_y, FALSE);
3233 * gtk_drag_set_icon_pixmap:
3234 * @context: the context for a drag. (This must be called
3235 * with a context for the source side of a drag)
3236 * @colormap: the colormap of the icon
3237 * @pixmap: the image data for the icon
3238 * @mask: the transparency mask for the icon or %NULL for none.
3239 * @hot_x: the X offset within @pixmap of the hotspot.
3240 * @hot_y: the Y offset within @pixmap of the hotspot.
3242 * Sets @pixmap as the icon for a given drag. GTK+ retains
3243 * references for the arguments, and will release them when
3244 * they are no longer needed. In general, gtk_drag_set_icon_pixbuf()
3245 * will be more convenient to use.
3248 gtk_drag_set_icon_pixmap (GdkDragContext *context,
3249 GdkColormap *colormap,
3259 g_return_if_fail (GDK_IS_DRAG_CONTEXT (context));
3260 g_return_if_fail (context->is_source);
3261 g_return_if_fail (GDK_IS_COLORMAP (colormap));
3262 g_return_if_fail (GDK_IS_PIXMAP (pixmap));
3263 g_return_if_fail (!mask || GDK_IS_PIXMAP (mask));
3265 screen = gdk_colormap_get_screen (colormap);
3267 g_return_if_fail (gdk_drawable_get_screen (pixmap) == screen);
3268 g_return_if_fail (!mask || gdk_drawable_get_screen (mask) == screen);
3270 gdk_drawable_get_size (pixmap, &width, &height);
3272 gtk_widget_push_colormap (colormap);
3274 window = gtk_window_new (GTK_WINDOW_POPUP);
3275 gtk_window_set_type_hint (GTK_WINDOW (window), GDK_WINDOW_TYPE_HINT_DND);
3276 gtk_window_set_screen (GTK_WINDOW (window), screen);
3277 set_can_change_screen (window, FALSE);
3278 gtk_widget_set_events (window, GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK);
3279 gtk_widget_set_app_paintable (GTK_WIDGET (window), TRUE);
3281 gtk_widget_pop_colormap ();
3283 gtk_widget_set_size_request (window, width, height);
3284 gtk_widget_realize (window);
3286 gdk_window_set_back_pixmap (window->window, pixmap, FALSE);
3289 gtk_widget_shape_combine_mask (window, mask, 0, 0);
3291 gtk_drag_set_icon_window (context, window, hot_x, hot_y, TRUE);
3295 * gtk_drag_set_icon_name:
3296 * @context: the context for a drag. (This must be called
3297 * with a context for the source side of a drag)
3298 * @icon_name: name of icon to use
3299 * @hot_x: the X offset of the hotspot within the icon
3300 * @hot_y: the Y offset of the hotspot within the icon
3302 * Sets the icon for a given drag from a named themed icon. See
3303 * the docs for #GtkIconTheme for more details. Note that the
3304 * size of the icon depends on the icon theme (the icon is
3305 * loaded at the symbolic size #GTK_ICON_SIZE_DND), thus
3306 * @hot_x and @hot_y have to be used with care.
3311 gtk_drag_set_icon_name (GdkDragContext *context,
3312 const gchar *icon_name,
3317 GtkSettings *settings;
3318 GtkIconTheme *icon_theme;
3320 gint width, height, icon_size;
3322 g_return_if_fail (GDK_IS_DRAG_CONTEXT (context));
3323 g_return_if_fail (context->is_source);
3324 g_return_if_fail (icon_name != NULL);
3326 screen = gdk_drawable_get_screen (context->source_window);
3327 g_return_if_fail (screen != NULL);
3329 settings = gtk_settings_get_for_screen (screen);
3330 if (gtk_icon_size_lookup_for_settings (settings,
3333 icon_size = MAX (width, height);
3335 icon_size = 32; /* default value for GTK_ICON_SIZE_DND */
3337 icon_theme = gtk_icon_theme_get_for_screen (screen);
3339 pixbuf = gtk_icon_theme_load_icon (icon_theme, icon_name,
3340 icon_size, 0, NULL);
3342 set_icon_stock_pixbuf (context, NULL, pixbuf, hot_x, hot_y, FALSE);
3344 g_warning ("Cannot load drag icon from icon name %s", icon_name);
3348 * gtk_drag_set_icon_default:
3349 * @context: the context for a drag. (This must be called
3350 with a context for the source side of a drag)
3352 * Sets the icon for a particular drag to the default
3356 gtk_drag_set_icon_default (GdkDragContext *context)
3358 g_return_if_fail (GDK_IS_DRAG_CONTEXT (context));
3359 g_return_if_fail (context->is_source);
3361 if (!default_icon_pixmap)
3362 gtk_drag_set_icon_stock (context, GTK_STOCK_DND, -2, -2);
3364 gtk_drag_set_icon_pixmap (context,
3365 default_icon_colormap,
3366 default_icon_pixmap,
3369 default_icon_hot_y);
3373 * gtk_drag_set_default_icon:
3374 * @colormap: the colormap of the icon
3375 * @pixmap: the image data for the icon
3376 * @mask: the transparency mask for an image.
3377 * @hot_x: The X offset within @widget of the hotspot.
3378 * @hot_y: The Y offset within @widget of the hotspot.
3380 * Changes the default drag icon. GTK+ retains references for the
3381 * arguments, and will release them when they are no longer needed.
3383 * Deprecated: Change the default drag icon via the stock system by
3384 * changing the stock pixbuf for #GTK_STOCK_DND instead.
3387 gtk_drag_set_default_icon (GdkColormap *colormap,
3393 g_return_if_fail (GDK_IS_COLORMAP (colormap));
3394 g_return_if_fail (GDK_IS_PIXMAP (pixmap));
3395 g_return_if_fail (!mask || GDK_IS_PIXMAP (mask));
3397 if (default_icon_colormap)
3398 g_object_unref (default_icon_colormap);
3399 if (default_icon_pixmap)
3400 g_object_unref (default_icon_pixmap);
3401 if (default_icon_mask)
3402 g_object_unref (default_icon_mask);
3404 default_icon_colormap = colormap;
3405 g_object_ref (colormap);
3407 default_icon_pixmap = pixmap;
3408 g_object_ref (pixmap);
3410 default_icon_mask = mask;
3412 g_object_ref (mask);
3414 default_icon_hot_x = hot_x;
3415 default_icon_hot_y = hot_y;
3419 /*************************************************************
3420 * _gtk_drag_source_handle_event:
3421 * Called from widget event handling code on Drag events
3425 * toplevel: Toplevel widget that received the event
3428 *************************************************************/
3431 _gtk_drag_source_handle_event (GtkWidget *widget,
3434 GtkDragSourceInfo *info;
3435 GdkDragContext *context;
3437 g_return_if_fail (widget != NULL);
3438 g_return_if_fail (event != NULL);
3440 context = event->dnd.context;
3441 info = gtk_drag_get_source_info (context, FALSE);
3445 switch (event->type)
3447 case GDK_DRAG_STATUS:
3451 if (info->proxy_dest)
3453 if (!event->dnd.send_event)
3455 if (info->proxy_dest->proxy_drop_wait)
3457 gboolean result = context->action != 0;
3459 /* Aha - we can finally pass the MOTIF DROP on... */
3460 gdk_drop_reply (info->proxy_dest->context, result, info->proxy_dest->proxy_drop_time);
3462 gdk_drag_drop (info->context, info->proxy_dest->proxy_drop_time);
3464 gtk_drag_finish (info->proxy_dest->context, FALSE, FALSE, info->proxy_dest->proxy_drop_time);
3468 gdk_drag_status (info->proxy_dest->context,
3469 event->dnd.context->action,
3474 else if (info->have_grab)
3476 cursor = gtk_drag_get_cursor (gtk_widget_get_display (widget),
3477 event->dnd.context->action,
3479 if (info->cursor != cursor)
3481 gdk_pointer_grab (widget->window, FALSE,
3482 GDK_POINTER_MOTION_MASK |
3483 GDK_BUTTON_RELEASE_MASK,
3485 cursor, info->grab_time);
3486 info->cursor = cursor;
3489 gtk_drag_add_update_idle (info);
3494 case GDK_DROP_FINISHED:
3495 gtk_drag_drop_finished (info, GTK_DRAG_RESULT_SUCCESS, event->dnd.time);
3498 g_assert_not_reached ();
3502 /*************************************************************
3503 * gtk_drag_source_check_selection:
3504 * Check if we've set up handlers/claimed the selection
3505 * for a given drag. If not, add them.
3509 *************************************************************/
3512 gtk_drag_source_check_selection (GtkDragSourceInfo *info,
3518 tmp_list = info->selections;
3521 if (GDK_POINTER_TO_ATOM (tmp_list->data) == selection)
3523 tmp_list = tmp_list->next;
3526 gtk_selection_owner_set_for_display (gtk_widget_get_display (info->widget),
3530 info->selections = g_list_prepend (info->selections,
3531 GUINT_TO_POINTER (selection));
3533 tmp_list = info->target_list->list;
3536 GtkTargetPair *pair = tmp_list->data;
3538 gtk_selection_add_target (info->ipc_widget,
3542 tmp_list = tmp_list->next;
3545 if (info->context->protocol == GDK_DRAG_PROTO_MOTIF)
3547 gtk_selection_add_target (info->ipc_widget,
3549 gdk_atom_intern_static_string ("XmTRANSFER_SUCCESS"),
3550 TARGET_MOTIF_SUCCESS);
3551 gtk_selection_add_target (info->ipc_widget,
3553 gdk_atom_intern_static_string ("XmTRANSFER_FAILURE"),
3554 TARGET_MOTIF_FAILURE);
3557 gtk_selection_add_target (info->ipc_widget,
3559 gdk_atom_intern_static_string ("DELETE"),
3563 /*************************************************************
3564 * gtk_drag_drop_finished:
3565 * Clean up from the drag, and display snapback, if necessary.
3571 *************************************************************/
3574 gtk_drag_drop_finished (GtkDragSourceInfo *info,
3575 GtkDragResult result,
3580 success = (result == GTK_DRAG_RESULT_SUCCESS);
3581 gtk_drag_source_release_selections (info, time);
3583 if (info->proxy_dest)
3585 /* The time from the event isn't reliable for Xdnd drags */
3586 gtk_drag_finish (info->proxy_dest->context, success, FALSE,
3587 info->proxy_dest->proxy_drop_time);
3588 gtk_drag_source_info_destroy (info);
3593 g_signal_emit_by_name (info->widget, "drag-failed",
3594 info->context, result, &success);
3598 gtk_drag_source_info_destroy (info);
3602 GtkDragAnim *anim = g_new (GtkDragAnim, 1);
3606 anim->n_steps = MAX (info->cur_x - info->start_x,
3607 info->cur_y - info->start_y) / ANIM_STEP_LENGTH;
3608 anim->n_steps = CLAMP (anim->n_steps, ANIM_MIN_STEPS, ANIM_MAX_STEPS);
3610 info->cur_screen = gtk_widget_get_screen (info->widget);
3612 if (!info->icon_window)
3613 set_icon_stock_pixbuf (info->context, NULL, info->icon_pixbuf,
3616 gtk_drag_update_icon (info);
3618 /* Mark the context as dead, so if the destination decides
3619 * to respond really late, we still are OK.
3621 gtk_drag_clear_source_info (info->context);
3622 gdk_threads_add_timeout (ANIM_STEP_TIME, gtk_drag_anim_timeout, anim);
3628 gtk_drag_source_release_selections (GtkDragSourceInfo *info,
3631 GdkDisplay *display = gtk_widget_get_display (info->widget);
3632 GList *tmp_list = info->selections;
3636 GdkAtom selection = GDK_POINTER_TO_ATOM (tmp_list->data);
3637 if (gdk_selection_owner_get_for_display (display, selection) == info->ipc_widget->window)
3638 gtk_selection_owner_set_for_display (display, NULL, selection, time);
3640 tmp_list = tmp_list->next;
3643 g_list_free (info->selections);
3644 info->selections = NULL;
3647 /*************************************************************
3649 * Send a drop event.
3653 *************************************************************/
3656 gtk_drag_drop (GtkDragSourceInfo *info,
3659 if (info->context->protocol == GDK_DRAG_PROTO_ROOTWIN)
3661 GtkSelectionData selection_data;
3663 /* GTK+ traditionally has used application/x-rootwin-drop, but the
3664 * XDND spec specifies x-rootwindow-drop.
3666 GdkAtom target1 = gdk_atom_intern_static_string ("application/x-rootwindow-drop");
3667 GdkAtom target2 = gdk_atom_intern_static_string ("application/x-rootwin-drop");
3669 tmp_list = info->target_list->list;
3672 GtkTargetPair *pair = tmp_list->data;
3674 if (pair->target == target1 || pair->target == target2)
3676 selection_data.selection = GDK_NONE;
3677 selection_data.target = pair->target;
3678 selection_data.data = NULL;
3679 selection_data.length = -1;
3681 g_signal_emit_by_name (info->widget, "drag-data-get",
3682 info->context, &selection_data,
3686 /* FIXME: Should we check for length >= 0 here? */
3687 gtk_drag_drop_finished (info, GTK_DRAG_RESULT_SUCCESS, time);
3690 tmp_list = tmp_list->next;
3692 gtk_drag_drop_finished (info, GTK_DRAG_RESULT_NO_TARGET, time);
3696 if (info->icon_window)
3697 gtk_widget_hide (info->icon_window);
3699 gdk_drag_drop (info->context, time);
3700 info->drop_timeout = gdk_threads_add_timeout (DROP_ABORT_TIME,
3701 gtk_drag_abort_timeout,
3707 * Source side callbacks.
3711 gtk_drag_source_event_cb (GtkWidget *widget,
3715 GtkDragSourceSite *site;
3716 gboolean retval = FALSE;
3717 site = (GtkDragSourceSite *)data;
3719 switch (event->type)
3721 case GDK_BUTTON_PRESS:
3722 if ((GDK_BUTTON1_MASK << (event->button.button - 1)) & site->start_button_mask)
3724 site->state |= (GDK_BUTTON1_MASK << (event->button.button - 1));
3725 site->x = event->button.x;
3726 site->y = event->button.y;
3730 case GDK_BUTTON_RELEASE:
3731 if ((GDK_BUTTON1_MASK << (event->button.button - 1)) & site->start_button_mask)
3732 site->state &= ~(GDK_BUTTON1_MASK << (event->button.button - 1));
3735 case GDK_MOTION_NOTIFY:
3736 if (site->state & event->motion.state & site->start_button_mask)
3738 /* FIXME: This is really broken and can leave us
3744 if (site->state & event->motion.state &
3745 GDK_BUTTON1_MASK << (i - 1))
3749 if (gtk_drag_check_threshold (widget, site->x, site->y,
3750 event->motion.x, event->motion.y))
3753 gtk_drag_begin_internal (widget, site, site->target_list,
3762 default: /* hit for 2/3BUTTON_PRESS */
3770 gtk_drag_source_site_destroy (gpointer data)
3772 GtkDragSourceSite *site = data;
3774 if (site->target_list)
3775 gtk_target_list_unref (site->target_list);
3777 gtk_drag_source_unset_icon (site);
3782 gtk_drag_selection_get (GtkWidget *widget,
3783 GtkSelectionData *selection_data,
3788 GtkDragSourceInfo *info = data;
3789 static GdkAtom null_atom = GDK_NONE;
3793 null_atom = gdk_atom_intern_static_string ("NULL");
3798 g_signal_emit_by_name (info->widget,
3801 gtk_selection_data_set (selection_data, null_atom, 8, NULL, 0);
3803 case TARGET_MOTIF_SUCCESS:
3804 gtk_drag_drop_finished (info, GTK_DRAG_RESULT_SUCCESS, time);
3805 gtk_selection_data_set (selection_data, null_atom, 8, NULL, 0);
3807 case TARGET_MOTIF_FAILURE:
3808 gtk_drag_drop_finished (info, GTK_DRAG_RESULT_NO_TARGET, time);
3809 gtk_selection_data_set (selection_data, null_atom, 8, NULL, 0);
3812 if (info->proxy_dest)
3814 /* This is sort of dangerous and needs to be thought
3817 info->proxy_dest->proxy_data = selection_data;
3818 gtk_drag_get_data (info->widget,
3819 info->proxy_dest->context,
3820 selection_data->target,
3823 info->proxy_dest->proxy_data = NULL;
3827 if (gtk_target_list_find (info->target_list,
3828 selection_data->target,
3831 g_signal_emit_by_name (info->widget, "drag-data-get",
3843 gtk_drag_anim_timeout (gpointer data)
3845 GtkDragAnim *anim = data;
3849 if (anim->step == anim->n_steps)
3851 gtk_drag_source_info_destroy (anim->info);
3858 x = (anim->info->start_x * (anim->step + 1) +
3859 anim->info->cur_x * (anim->n_steps - anim->step - 1)) / anim->n_steps;
3860 y = (anim->info->start_y * (anim->step + 1) +
3861 anim->info->cur_y * (anim->n_steps - anim->step - 1)) / anim->n_steps;
3862 if (anim->info->icon_window)
3864 GtkWidget *icon_window;
3867 gtk_drag_get_icon (anim->info, &icon_window, &hot_x, &hot_y);
3868 gtk_window_move (GTK_WINDOW (icon_window),
3882 gtk_drag_remove_icon (GtkDragSourceInfo *info)
3884 if (info->icon_window)
3886 gtk_widget_hide (info->icon_window);
3887 if (info->destroy_icon)
3888 gtk_widget_destroy (info->icon_window);
3890 if (info->fallback_icon)
3892 gtk_widget_destroy (info->fallback_icon);
3893 info->fallback_icon = NULL;
3896 g_object_unref (info->icon_window);
3897 info->icon_window = NULL;
3902 gtk_drag_source_info_destroy (GtkDragSourceInfo *info)
3906 for (i = 0; i < n_drag_cursors; i++)
3908 if (info->drag_cursors[i] != NULL)
3910 gdk_cursor_unref (info->drag_cursors[i]);
3911 info->drag_cursors[i] = NULL;
3915 gtk_drag_remove_icon (info);
3917 if (info->icon_pixbuf)
3919 g_object_unref (info->icon_pixbuf);
3920 info->icon_pixbuf = NULL;
3923 g_signal_handlers_disconnect_by_func (info->ipc_widget,
3924 gtk_drag_grab_broken_event_cb,
3926 g_signal_handlers_disconnect_by_func (info->ipc_widget,
3927 gtk_drag_grab_notify_cb,
3929 g_signal_handlers_disconnect_by_func (info->ipc_widget,
3930 gtk_drag_button_release_cb,
3932 g_signal_handlers_disconnect_by_func (info->ipc_widget,
3935 g_signal_handlers_disconnect_by_func (info->ipc_widget,
3938 g_signal_handlers_disconnect_by_func (info->ipc_widget,
3939 gtk_drag_selection_get,
3942 if (!info->proxy_dest)
3943 g_signal_emit_by_name (info->widget, "drag-end", info->context);
3946 g_object_unref (info->widget);
3948 gtk_selection_remove_all (info->ipc_widget);
3949 g_object_set_data (G_OBJECT (info->ipc_widget), I_("gtk-info"), NULL);
3950 source_widgets = g_slist_remove (source_widgets, info->ipc_widget);
3951 gtk_drag_release_ipc_widget (info->ipc_widget);
3953 gtk_target_list_unref (info->target_list);
3955 gtk_drag_clear_source_info (info->context);
3956 g_object_unref (info->context);
3958 if (info->drop_timeout)
3959 g_source_remove (info->drop_timeout);
3961 if (info->update_idle)
3962 g_source_remove (info->update_idle);
3968 gtk_drag_update_idle (gpointer data)
3970 GtkDragSourceInfo *info = data;
3971 GdkWindow *dest_window;
3972 GdkDragProtocol protocol;
3975 GdkDragAction action;
3976 GdkDragAction possible_actions;
3979 info->update_idle = 0;
3981 if (info->last_event)
3983 time = gtk_drag_get_event_time (info->last_event);
3984 gtk_drag_get_event_actions (info->last_event,
3986 info->possible_actions,
3987 &action, &possible_actions);
3988 gtk_drag_update_icon (info);
3989 gdk_drag_find_window_for_screen (info->context,
3990 info->icon_window ? info->icon_window->window : NULL,
3991 info->cur_screen, info->cur_x, info->cur_y,
3992 &dest_window, &protocol);
3994 if (!gdk_drag_motion (info->context, dest_window, protocol,
3995 info->cur_x, info->cur_y, action,
3999 gdk_event_free ((GdkEvent *)info->last_event);
4000 info->last_event = NULL;
4004 g_object_unref (dest_window);
4006 selection = gdk_drag_get_selection (info->context);
4008 gtk_drag_source_check_selection (info, selection, time);
4016 gtk_drag_add_update_idle (GtkDragSourceInfo *info)
4018 /* We use an idle lower than GDK_PRIORITY_REDRAW so that exposes
4019 * from the last move can catch up before we move again.
4021 if (!info->update_idle)
4022 info->update_idle = gdk_threads_add_idle_full (GDK_PRIORITY_REDRAW + 5,
4023 gtk_drag_update_idle,
4030 * @info: DragSourceInfo for the drag
4031 * @screen: new screen
4032 * @x_root: new X position
4033 * @y_root: new y position
4034 * @event: event received requiring update
4036 * Updates the status of the drag; called when the
4037 * cursor moves or the modifier changes
4040 gtk_drag_update (GtkDragSourceInfo *info,
4046 info->cur_screen = screen;
4047 info->cur_x = x_root;
4048 info->cur_y = y_root;
4049 if (info->last_event)
4051 gdk_event_free ((GdkEvent *)info->last_event);
4052 info->last_event = NULL;
4055 info->last_event = gdk_event_copy ((GdkEvent *)event);
4057 gtk_drag_add_update_idle (info);
4060 /*************************************************************
4062 * Called when the user finishes to drag, either by
4063 * releasing the mouse, or by pressing Esc.
4065 * info: Source info for the drag
4066 * time: Timestamp for ending the drag
4068 *************************************************************/
4071 gtk_drag_end (GtkDragSourceInfo *info, guint32 time)
4073 GdkEvent *send_event;
4074 GtkWidget *source_widget = info->widget;
4075 GdkDisplay *display = gtk_widget_get_display (source_widget);
4077 if (info->update_idle)
4079 g_source_remove (info->update_idle);
4080 info->update_idle = 0;
4083 if (info->last_event)
4085 gdk_event_free (info->last_event);
4086 info->last_event = NULL;
4089 info->have_grab = FALSE;
4091 g_signal_handlers_disconnect_by_func (info->ipc_widget,
4092 gtk_drag_grab_broken_event_cb,
4094 g_signal_handlers_disconnect_by_func (info->ipc_widget,
4095 gtk_drag_grab_notify_cb,
4097 g_signal_handlers_disconnect_by_func (info->ipc_widget,
4098 gtk_drag_button_release_cb,
4100 g_signal_handlers_disconnect_by_func (info->ipc_widget,
4103 g_signal_handlers_disconnect_by_func (info->ipc_widget,
4107 gdk_display_pointer_ungrab (display, time);
4108 ungrab_dnd_keys (info->ipc_widget, time);
4109 gtk_grab_remove (info->ipc_widget);
4111 /* Send on a release pair to the original
4112 * widget to convince it to release its grab. We need to
4113 * call gtk_propagate_event() here, instead of
4114 * gtk_widget_event() because widget like GtkList may
4115 * expect propagation.
4118 send_event = gdk_event_new (GDK_BUTTON_RELEASE);
4119 send_event->button.window = g_object_ref (gtk_widget_get_root_window (source_widget));
4120 send_event->button.send_event = TRUE;
4121 send_event->button.time = time;
4122 send_event->button.x = 0;
4123 send_event->button.y = 0;
4124 send_event->button.axes = NULL;
4125 send_event->button.state = 0;
4126 send_event->button.button = info->button;
4127 send_event->button.device = gdk_display_get_core_pointer (display);
4128 send_event->button.x_root = 0;
4129 send_event->button.y_root = 0;
4131 gtk_propagate_event (source_widget, send_event);
4132 gdk_event_free (send_event);
4135 /*************************************************************
4137 * Called on cancellation of a drag, either by the user
4138 * or programmatically.
4140 * info: Source info for the drag
4141 * time: Timestamp for ending the drag
4143 *************************************************************/
4146 gtk_drag_cancel (GtkDragSourceInfo *info, GtkDragResult result, guint32 time)
4148 gtk_drag_end (info, time);
4149 gdk_drag_abort (info->context, time);
4150 gtk_drag_drop_finished (info, result, time);
4153 /*************************************************************
4154 * gtk_drag_motion_cb:
4155 * "motion-notify-event" callback during drag.
4159 *************************************************************/
4162 gtk_drag_motion_cb (GtkWidget *widget,
4163 GdkEventMotion *event,
4166 GtkDragSourceInfo *info = (GtkDragSourceInfo *)data;
4168 gint x_root, y_root;
4172 GdkDisplay *display = gtk_widget_get_display (widget);
4174 gdk_display_get_pointer (display, &screen, &x_root, &y_root, NULL);
4175 event->x_root = x_root;
4176 event->y_root = y_root;
4179 screen = gdk_event_get_screen ((GdkEvent *)event);
4181 gtk_drag_update (info, screen, event->x_root, event->y_root, (GdkEvent *)event);
4186 /*************************************************************
4188 * "key-press/release-event" callback during drag.
4192 *************************************************************/
4195 #define SMALL_STEP 1
4198 gtk_drag_key_cb (GtkWidget *widget,
4202 GtkDragSourceInfo *info = (GtkDragSourceInfo *)data;
4203 GdkModifierType state;
4204 GdkWindow *root_window;
4208 state = event->state & gtk_accelerator_get_default_mod_mask ();
4210 if (event->type == GDK_KEY_PRESS)
4212 switch (event->keyval)
4215 gtk_drag_cancel (info, GTK_DRAG_RESULT_USER_CANCELLED, event->time);
4223 gtk_drag_end (info, event->time);
4224 gtk_drag_drop (info, event->time);
4229 dy = (state & GDK_MOD1_MASK) ? -BIG_STEP : -SMALL_STEP;
4234 dy = (state & GDK_MOD1_MASK) ? BIG_STEP : SMALL_STEP;
4239 dx = (state & GDK_MOD1_MASK) ? -BIG_STEP : -SMALL_STEP;
4244 dx = (state & GDK_MOD1_MASK) ? BIG_STEP : SMALL_STEP;
4250 /* Now send a "motion" so that the modifier state is updated */
4252 /* The state is not yet updated in the event, so we need
4253 * to query it here. We could use XGetModifierMapping, but
4254 * that would be overkill.
4256 root_window = gtk_widget_get_root_window (widget);
4257 gdk_window_get_pointer (root_window, NULL, NULL, &state);
4258 event->state = state;
4260 if (dx != 0 || dy != 0)
4264 gdk_display_warp_pointer (gtk_widget_get_display (widget),
4265 gtk_widget_get_screen (widget),
4266 info->cur_x, info->cur_y);
4269 gtk_drag_update (info, info->cur_screen, info->cur_x, info->cur_y, (GdkEvent *)event);
4275 gtk_drag_grab_broken_event_cb (GtkWidget *widget,
4276 GdkEventGrabBroken *event,
4279 GtkDragSourceInfo *info = (GtkDragSourceInfo *)data;
4281 /* Don't cancel if we break the implicit grab from the initial button_press.
4282 * Also, don't cancel if we re-grab on the widget or on our IPC window, for
4283 * example, when changing the drag cursor.
4286 || event->grab_window == info->widget->window
4287 || event->grab_window == info->ipc_widget->window)
4290 gtk_drag_cancel (info, GTK_DRAG_RESULT_GRAB_BROKEN, gtk_get_current_event_time ());
4295 gtk_drag_grab_notify_cb (GtkWidget *widget,
4296 gboolean was_grabbed,
4299 GtkDragSourceInfo *info = (GtkDragSourceInfo *)data;
4303 /* We have to block callbacks to avoid recursion here, because
4304 gtk_drag_cancel calls gtk_grab_remove (via gtk_drag_end) */
4305 g_signal_handlers_block_by_func (widget, gtk_drag_grab_notify_cb, data);
4306 gtk_drag_cancel (info, GTK_DRAG_RESULT_GRAB_BROKEN, gtk_get_current_event_time ());
4307 g_signal_handlers_unblock_by_func (widget, gtk_drag_grab_notify_cb, data);
4312 /*************************************************************
4313 * gtk_drag_button_release_cb:
4314 * "button-release-event" callback during drag.
4318 *************************************************************/
4321 gtk_drag_button_release_cb (GtkWidget *widget,
4322 GdkEventButton *event,
4325 GtkDragSourceInfo *info = (GtkDragSourceInfo *)data;
4327 if (event->button != info->button)
4330 if ((info->context->action != 0) && (info->context->dest_window != NULL))
4332 gtk_drag_end (info, event->time);
4333 gtk_drag_drop (info, event->time);
4337 gtk_drag_cancel (info, GTK_DRAG_RESULT_NO_TARGET, event->time);
4344 gtk_drag_abort_timeout (gpointer data)
4346 GtkDragSourceInfo *info = data;
4347 guint32 time = GDK_CURRENT_TIME;
4349 if (info->proxy_dest)
4350 time = info->proxy_dest->proxy_drop_time;
4352 info->drop_timeout = 0;
4353 gtk_drag_drop_finished (info, GTK_DRAG_RESULT_TIMEOUT_EXPIRED, time);
4359 * gtk_drag_check_threshold:
4360 * @widget: a #GtkWidget
4361 * @start_x: X coordinate of start of drag
4362 * @start_y: Y coordinate of start of drag
4363 * @current_x: current X coordinate
4364 * @current_y: current Y coordinate
4366 * Checks to see if a mouse drag starting at (@start_x, @start_y) and ending
4367 * at (@current_x, @current_y) has passed the GTK+ drag threshold, and thus
4368 * should trigger the beginning of a drag-and-drop operation.
4370 * Return Value: %TRUE if the drag threshold has been passed.
4373 gtk_drag_check_threshold (GtkWidget *widget,
4379 gint drag_threshold;
4381 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4383 g_object_get (gtk_widget_get_settings (widget),
4384 "gtk-dnd-drag-threshold", &drag_threshold,
4387 return (ABS (current_x - start_x) > drag_threshold ||
4388 ABS (current_y - start_y) > drag_threshold);
4391 #define __GTK_DND_C__
4392 #include "gtkaliasdef.c"