1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/gtk/dnd.cpp
3 // Purpose: wxDropTarget class
4 // Author: Robert Roebling
5 // Copyright: (c) 1998 Robert Roebling
6 // Licence: wxWindows licence
7 ///////////////////////////////////////////////////////////////////////////////
9 // For compilers that support precompilation, includes "wx.h".
10 #include "wx/wxprec.h"
12 #if wxUSE_DRAG_AND_DROP
21 #include "wx/window.h"
22 #include "wx/gdicmn.h"
25 #include "wx/scopeguard.h"
28 #include "wx/gtk/private/gtk2-compat.h"
30 //----------------------------------------------------------------------------
32 //----------------------------------------------------------------------------
34 extern bool g_blockEventsOnDrag
;
36 // the flags used for the last DoDragDrop()
37 static long gs_flagsForDrag
= 0;
39 // the trace mask we use with wxLogTrace() - call
40 // wxLog::AddTraceMask(TRACE_DND) to enable the trace messages from here
41 // (there are quite a few of them, so don't enable this by default)
42 #define TRACE_DND "dnd"
44 // global variables because GTK+ DnD want to have the
45 // mouse event that caused it
46 extern GdkEvent
*g_lastMouseEvent
;
47 extern int g_lastButtonNumber
;
49 //----------------------------------------------------------------------------
51 //----------------------------------------------------------------------------
53 /* Copyright (c) Julian Smart */
54 static const char * page_xpm
[] = {
55 /* columns rows colors chars-per-pixel */
104 " 56477<<<<8<<9&:X ",
105 " 59642%&*=-;<09&:5 ",
106 " 5q9642%&*=-<<<<<# ",
107 " 5qqw777<<<<<88:>+ ",
108 " erqq9642%&*=t;::+ ",
109 " eyrqq9642%&*=t;:O ",
110 " eyywwww777<<<<t;O ",
111 " e0yyrqq9642%&*=to ",
112 " e00yyrqq9642%&*=o ",
113 " eu0wwwwwww777<&*X ",
114 " euu00yyrqq9642%&X ",
115 " eiuu00yyrqq9642%X ",
116 " eiiwwwwwwwwww742$ ",
117 " eiiiuu00yyrqq964$ ",
118 " eiiiiuu00yyrqq96$ ",
119 " eiiiiiuu00yyrqq95 ",
120 " eiiiiiiuu00yyrqq5 ",
121 " eeeeeeeeeeeeee55e ",
130 // ============================================================================
132 // ============================================================================
134 // ----------------------------------------------------------------------------
135 // convert between GTK+ and wxWidgets DND constants
136 // ----------------------------------------------------------------------------
138 static wxDragResult
ConvertFromGTK(long action
)
142 case GDK_ACTION_COPY
:
145 case GDK_ACTION_LINK
:
148 case GDK_ACTION_MOVE
:
155 // ----------------------------------------------------------------------------
157 // ----------------------------------------------------------------------------
160 static void target_drag_leave( GtkWidget
*WXUNUSED(widget
),
161 GdkDragContext
*context
,
162 guint
WXUNUSED(time
),
163 wxDropTarget
*drop_target
)
165 /* inform the wxDropTarget about the current GdkDragContext.
166 this is only valid for the duration of this call */
167 drop_target
->GTKSetDragContext( context
);
169 /* we don't need return values. this event is just for
171 drop_target
->OnLeave();
173 /* this has to be done because GDK has no "drag_enter" event */
174 drop_target
->m_firstMotion
= true;
176 /* after this, invalidate the drop_target's GdkDragContext */
177 drop_target
->GTKSetDragContext( NULL
);
181 // ----------------------------------------------------------------------------
183 // ----------------------------------------------------------------------------
186 static gboolean
target_drag_motion( GtkWidget
*WXUNUSED(widget
),
187 GdkDragContext
*context
,
191 wxDropTarget
*drop_target
)
193 /* Owen Taylor: "if the coordinates not in a drop zone,
194 return FALSE, otherwise call gtk_drag_status() and
198 wxPrintf( "motion\n" );
200 for (tmp_list
= context
->targets
; tmp_list
; tmp_list
= tmp_list
->next
)
202 wxString atom
= wxString::FromAscii( gdk_atom_name (GDK_POINTER_TO_ATOM (tmp_list
->data
)) );
203 wxPrintf( "Atom: %s\n", atom
);
207 // Inform the wxDropTarget about the current GdkDragContext.
208 // This is only valid for the duration of this call.
209 drop_target
->GTKSetDragContext( context
);
211 // Does the source actually accept the data type?
212 if (drop_target
->GTKGetMatchingPair() == (GdkAtom
) 0)
214 drop_target
->GTKSetDragContext( NULL
);
218 wxDragResult suggested_action
= drop_target
->GTKFigureOutSuggestedAction();
220 wxDragResult result
= wxDragNone
;
222 if (drop_target
->m_firstMotion
)
224 // the first "drag_motion" event substitutes a "drag_enter" event
225 result
= drop_target
->OnEnter( x
, y
, suggested_action
);
229 // give program a chance to react (i.e. to say no by returning FALSE)
230 result
= drop_target
->OnDragOver( x
, y
, suggested_action
);
233 GdkDragAction result_action
= GDK_ACTION_DEFAULT
;
234 if (result
== wxDragCopy
)
235 result_action
= GDK_ACTION_COPY
;
236 else if (result
== wxDragLink
)
237 result_action
= GDK_ACTION_LINK
;
239 result_action
= GDK_ACTION_MOVE
;
241 // is result action actually supported
242 bool ret
= (result_action
!= GDK_ACTION_DEFAULT
) &&
243 (gdk_drag_context_get_actions(context
) & result_action
);
246 gdk_drag_status( context
, result_action
, time
);
248 // after this, invalidate the drop_target's GdkDragContext
249 drop_target
->GTKSetDragContext( NULL
);
251 // this has to be done because GDK has no "drag_enter" event
252 drop_target
->m_firstMotion
= false;
258 // ----------------------------------------------------------------------------
260 // ----------------------------------------------------------------------------
263 static gboolean
target_drag_drop( GtkWidget
*widget
,
264 GdkDragContext
*context
,
268 wxDropTarget
*drop_target
)
270 /* Owen Taylor: "if the drop is not in a drop zone,
271 return FALSE, otherwise, if you aren't accepting
272 the drop, call gtk_drag_finish() with success == FALSE
273 otherwise call gtk_drag_data_get()" */
275 /* inform the wxDropTarget about the current GdkDragContext.
276 this is only valid for the duration of this call */
277 drop_target
->GTKSetDragContext( context
);
279 // Does the source actually accept the data type?
280 if (drop_target
->GTKGetMatchingPair() == (GdkAtom
) 0)
282 // cancel the whole thing
283 gtk_drag_finish( context
,
285 FALSE
, // don't delete data on dropping side
288 drop_target
->GTKSetDragContext( NULL
);
290 drop_target
->m_firstMotion
= true;
295 /* inform the wxDropTarget about the current drag widget.
296 this is only valid for the duration of this call */
297 drop_target
->GTKSetDragWidget( widget
);
299 /* inform the wxDropTarget about the current drag time.
300 this is only valid for the duration of this call */
301 drop_target
->GTKSetDragTime( time
);
303 /* reset the block here as someone might very well
304 show a dialog as a reaction to a drop and this
305 wouldn't work without events */
306 g_blockEventsOnDrag
= false;
308 bool ret
= drop_target
->OnDrop( x
, y
);
312 wxLogTrace(TRACE_DND
, wxT( "Drop target: OnDrop returned FALSE") );
314 /* cancel the whole thing */
315 gtk_drag_finish( context
,
316 FALSE
, /* no success */
317 FALSE
, /* don't delete data on dropping side */
322 wxLogTrace(TRACE_DND
, wxT( "Drop target: OnDrop returned true") );
324 GdkAtom format
= drop_target
->GTKGetMatchingPair();
326 // this does happen somehow, see bug 555111
327 wxCHECK_MSG( format
, FALSE
, wxT("no matching GdkAtom for format?") );
329 /* this should trigger an "drag_data_received" event */
330 gtk_drag_get_data( widget
,
336 /* after this, invalidate the drop_target's GdkDragContext */
337 drop_target
->GTKSetDragContext( NULL
);
339 /* after this, invalidate the drop_target's drag widget */
340 drop_target
->GTKSetDragWidget( NULL
);
342 /* this has to be done because GDK has no "drag_enter" event */
343 drop_target
->m_firstMotion
= true;
349 // ----------------------------------------------------------------------------
350 // "drag_data_received"
351 // ----------------------------------------------------------------------------
354 static void target_drag_data_received( GtkWidget
*WXUNUSED(widget
),
355 GdkDragContext
*context
,
358 GtkSelectionData
*data
,
359 guint
WXUNUSED(info
),
361 wxDropTarget
*drop_target
)
363 /* Owen Taylor: "call gtk_drag_finish() with
366 if (gtk_selection_data_get_length(data
) <= 0 || gtk_selection_data_get_format(data
) != 8)
368 /* negative data length and non 8-bit data format
369 qualifies for junk */
370 gtk_drag_finish (context
, FALSE
, FALSE
, time
);
375 wxLogTrace(TRACE_DND
, wxT( "Drop target: data received event") );
377 /* inform the wxDropTarget about the current GtkSelectionData.
378 this is only valid for the duration of this call */
379 drop_target
->GTKSetDragData( data
);
381 wxDragResult result
= ConvertFromGTK(gdk_drag_context_get_selected_action(context
));
383 if ( wxIsDragResultOk( drop_target
->OnData( x
, y
, result
) ) )
385 wxLogTrace(TRACE_DND
, wxT( "Drop target: OnData returned true") );
387 /* tell GTK that data transfer was successful */
388 gtk_drag_finish( context
, TRUE
, FALSE
, time
);
392 wxLogTrace(TRACE_DND
, wxT( "Drop target: OnData returned FALSE") );
394 /* tell GTK that data transfer was not successful */
395 gtk_drag_finish( context
, FALSE
, FALSE
, time
);
398 /* after this, invalidate the drop_target's drag data */
399 drop_target
->GTKSetDragData( NULL
);
403 //----------------------------------------------------------------------------
405 //----------------------------------------------------------------------------
407 wxDropTarget::wxDropTarget( wxDataObject
*data
)
408 : wxDropTargetBase( data
)
410 m_firstMotion
= true;
411 m_dragContext
= NULL
;
417 wxDragResult
wxDropTarget::OnDragOver( wxCoord
WXUNUSED(x
),
424 bool wxDropTarget::OnDrop( wxCoord
WXUNUSED(x
), wxCoord
WXUNUSED(y
) )
429 wxDragResult
wxDropTarget::OnData( wxCoord
WXUNUSED(x
), wxCoord
WXUNUSED(y
),
432 return GetData() ? def
: wxDragNone
;
435 wxDragResult
wxDropTarget::GTKFigureOutSuggestedAction()
440 // GTK+ always supposes that we want to copy the data by default while we
441 // might want to move it, so examine not only suggested_action - which is
442 // only good if we don't have our own preferences - but also the actions
444 wxDragResult suggested_action
= wxDragNone
;
445 const GdkDragAction actions
= gdk_drag_context_get_actions(m_dragContext
);
446 if (GetDefaultAction() == wxDragNone
)
448 // use default action set by wxDropSource::DoDragDrop()
449 if ( (gs_flagsForDrag
& wxDrag_DefaultMove
) == wxDrag_DefaultMove
&&
450 (actions
& GDK_ACTION_MOVE
))
452 // move is requested by the program and allowed by GTK+ - do it, even
453 // though suggested_action may be currently wxDragCopy
454 suggested_action
= wxDragMove
;
456 else // use whatever GTK+ says we should
458 suggested_action
= ConvertFromGTK(gdk_drag_context_get_suggested_action(m_dragContext
));
461 // RR: I don't understand the code below: if the drag comes from
462 // a different app, the gs_flagsForDrag is invalid; if it
463 // comes from the same wx app, then GTK+ hopefully won't
464 // suggest something we didn't allow in the frist place
466 if ( (suggested_action
== wxDragMove
) && !(gs_flagsForDrag
& wxDrag_AllowMove
) )
468 // we're requested to move but we can't
469 suggested_action
= wxDragCopy
;
474 else if (GetDefaultAction() == wxDragMove
&&
475 (actions
& GDK_ACTION_MOVE
))
478 suggested_action
= wxDragMove
;
482 if (actions
& GDK_ACTION_COPY
)
483 suggested_action
= wxDragCopy
;
484 else if (actions
& GDK_ACTION_MOVE
)
485 suggested_action
= wxDragMove
;
486 else if (actions
& GDK_ACTION_LINK
)
487 suggested_action
= wxDragLink
;
489 suggested_action
= wxDragNone
;
492 return suggested_action
;
495 wxDataFormat
wxDropTarget::GetMatchingPair()
497 return wxDataFormat( GTKGetMatchingPair() );
500 GdkAtom
wxDropTarget::GTKGetMatchingPair(bool quiet
)
508 const GList
* child
= gdk_drag_context_list_targets(m_dragContext
);
511 GdkAtom formatAtom
= (GdkAtom
)(child
->data
);
512 wxDataFormat
format( formatAtom
);
516 wxLogTrace(TRACE_DND
, wxT("Drop target: drag has format: %s"),
517 format
.GetId().c_str());
520 if (m_dataObject
->IsSupportedFormat( format
))
529 bool wxDropTarget::GetData()
537 wxDataFormat
dragFormat(gtk_selection_data_get_target(m_dragData
));
539 if (!m_dataObject
->IsSupportedFormat( dragFormat
))
542 m_dataObject
->SetData(dragFormat
,
543 (size_t)gtk_selection_data_get_length(m_dragData
),
544 (const void*)gtk_selection_data_get_data(m_dragData
));
549 void wxDropTarget::GtkUnregisterWidget( GtkWidget
*widget
)
551 wxCHECK_RET( widget
!= NULL
, wxT("unregister widget is NULL") );
553 gtk_drag_dest_unset( widget
);
555 g_signal_handlers_disconnect_by_func (widget
,
556 (gpointer
) target_drag_leave
, this);
557 g_signal_handlers_disconnect_by_func (widget
,
558 (gpointer
) target_drag_motion
, this);
559 g_signal_handlers_disconnect_by_func (widget
,
560 (gpointer
) target_drag_drop
, this);
561 g_signal_handlers_disconnect_by_func (widget
,
562 (gpointer
) target_drag_data_received
, this);
565 void wxDropTarget::GtkRegisterWidget( GtkWidget
*widget
)
567 wxCHECK_RET( widget
!= NULL
, wxT("register widget is NULL") );
569 /* gtk_drag_dest_set() determines what default behaviour we'd like
570 GTK to supply. we don't want to specify out targets (=formats)
571 or actions in advance (i.e. not GTK_DEST_DEFAULT_MOTION and
572 not GTK_DEST_DEFAULT_DROP). instead we react individually to
573 "drag_motion" and "drag_drop" events. this makes it possible
574 to allow dropping on only a small area. we should set
575 GTK_DEST_DEFAULT_HIGHLIGHT as this will switch on the nice
576 highlighting if dragging over standard controls, but this
577 seems to be broken without the other two. */
579 gtk_drag_dest_set( widget
,
580 (GtkDestDefaults
) 0, /* no default behaviour */
581 NULL
, /* we don't supply any formats here */
582 0, /* number of targets = 0 */
583 (GdkDragAction
) 0 ); /* we don't supply any actions here */
585 g_signal_connect (widget
, "drag_leave",
586 G_CALLBACK (target_drag_leave
), this);
588 g_signal_connect (widget
, "drag_motion",
589 G_CALLBACK (target_drag_motion
), this);
591 g_signal_connect (widget
, "drag_drop",
592 G_CALLBACK (target_drag_drop
), this);
594 g_signal_connect (widget
, "drag_data_received",
595 G_CALLBACK (target_drag_data_received
), this);
598 //----------------------------------------------------------------------------
600 //----------------------------------------------------------------------------
604 source_drag_data_get (GtkWidget
*WXUNUSED(widget
),
605 GdkDragContext
*context
,
606 GtkSelectionData
*selection_data
,
607 guint
WXUNUSED(info
),
608 guint
WXUNUSED(time
),
609 wxDropSource
*drop_source
)
611 wxDataFormat
format(gtk_selection_data_get_target(selection_data
));
613 wxLogTrace(TRACE_DND
, wxT("Drop source: format requested: %s"),
614 format
.GetId().c_str());
616 drop_source
->m_retValue
= wxDragError
;
618 wxDataObject
*data
= drop_source
->GetDataObject();
622 wxLogTrace(TRACE_DND
, wxT("Drop source: no data object") );
626 if (!data
->IsSupportedFormat(format
))
628 wxLogTrace(TRACE_DND
, wxT("Drop source: unsupported format") );
632 if (data
->GetDataSize(format
) == 0)
634 wxLogTrace(TRACE_DND
, wxT("Drop source: empty data") );
638 size_t size
= data
->GetDataSize(format
);
640 // printf( "data size: %d.\n", (int)data_size );
642 guchar
*d
= new guchar
[size
];
644 if (!data
->GetDataHere( format
, (void*)d
))
650 drop_source
->m_retValue
= ConvertFromGTK(gdk_drag_context_get_selected_action(context
));
652 gtk_selection_data_set( selection_data
,
653 gtk_selection_data_get_target(selection_data
),
662 //----------------------------------------------------------------------------
664 //----------------------------------------------------------------------------
667 static void source_drag_end( GtkWidget
*WXUNUSED(widget
),
668 GdkDragContext
*WXUNUSED(context
),
669 wxDropSource
*drop_source
)
671 drop_source
->m_waiting
= false;
675 //-----------------------------------------------------------------------------
676 // "configure_event" from m_iconWindow
677 //-----------------------------------------------------------------------------
681 gtk_dnd_window_configure_callback( GtkWidget
*WXUNUSED(widget
), GdkEventConfigure
*WXUNUSED(event
), wxDropSource
*source
)
683 source
->GiveFeedback(ConvertFromGTK(gdk_drag_context_get_selected_action(source
->m_dragContext
)));
689 //---------------------------------------------------------------------------
691 //---------------------------------------------------------------------------
693 wxDropSource::wxDropSource(wxWindow
*win
,
694 const wxIcon
&iconCopy
,
695 const wxIcon
&iconMove
,
696 const wxIcon
&iconNone
)
703 m_widget
= win
->m_widget
;
704 if (win
->m_wxwindow
) m_widget
= win
->m_wxwindow
;
706 m_retValue
= wxDragNone
;
708 SetIcons(iconCopy
, iconMove
, iconNone
);
711 wxDropSource::wxDropSource(wxDataObject
& data
,
713 const wxIcon
&iconCopy
,
714 const wxIcon
&iconMove
,
715 const wxIcon
&iconNone
)
724 m_widget
= win
->m_widget
;
725 if (win
->m_wxwindow
) m_widget
= win
->m_wxwindow
;
727 m_retValue
= wxDragNone
;
729 SetIcons(iconCopy
, iconMove
, iconNone
);
732 void wxDropSource::SetIcons(const wxIcon
&iconCopy
,
733 const wxIcon
&iconMove
,
734 const wxIcon
&iconNone
)
736 m_iconCopy
= iconCopy
;
737 m_iconMove
= iconMove
;
738 m_iconNone
= iconNone
;
740 if ( !m_iconCopy
.IsOk() )
741 m_iconCopy
= wxIcon(page_xpm
);
742 if ( !m_iconMove
.IsOk() )
743 m_iconMove
= m_iconCopy
;
744 if ( !m_iconNone
.IsOk() )
745 m_iconNone
= m_iconCopy
;
748 wxDropSource::~wxDropSource()
752 void wxDropSource::PrepareIcon( int action
, GdkDragContext
*context
)
754 // get the right icon to display
756 if ( action
& GDK_ACTION_MOVE
)
758 else if ( action
& GDK_ACTION_COPY
)
765 if ( icon
->GetMask() )
766 mask
= *icon
->GetMask();
770 GdkPixmap
*pixmap
= icon
->GetPixmap();
772 GdkColormap
*colormap
= gtk_widget_get_colormap( m_widget
);
773 gtk_widget_push_colormap (colormap
);
776 m_iconWindow
= gtk_window_new (GTK_WINDOW_POPUP
);
777 gtk_widget_set_events (m_iconWindow
, GDK_BUTTON_PRESS_MASK
| GDK_BUTTON_RELEASE_MASK
);
778 gtk_widget_set_app_paintable (m_iconWindow
, TRUE
);
781 gtk_widget_set_visual(m_iconWindow
, gtk_widget_get_visual(m_widget
));
783 gtk_widget_pop_colormap ();
786 gtk_widget_set_size_request (m_iconWindow
, icon
->GetWidth(), icon
->GetHeight());
787 gtk_widget_realize (m_iconWindow
);
789 g_signal_connect (m_iconWindow
, "configure_event",
790 G_CALLBACK (gtk_dnd_window_configure_callback
), this);
793 cairo_t
* cr
= gdk_cairo_create(gtk_widget_get_window(m_iconWindow
));
794 icon
->SetSourceSurface(cr
, 0, 0);
795 cairo_pattern_t
* pattern
= cairo_get_source(cr
);
796 gdk_window_set_background_pattern(gtk_widget_get_window(m_iconWindow
), pattern
);
798 cairo_surface_t
* mask
= NULL
;
800 mask
= *icon
->GetMask();
803 cairo_region_t
* region
= gdk_cairo_region_create_from_surface(mask
);
804 gtk_widget_shape_combine_region(m_iconWindow
, region
);
805 cairo_region_destroy(region
);
808 gdk_window_set_back_pixmap(gtk_widget_get_window(m_iconWindow
), pixmap
, false);
811 gtk_widget_shape_combine_mask (m_iconWindow
, mask
, 0, 0);
814 gtk_drag_set_icon_widget( context
, m_iconWindow
, 0, 0 );
817 wxDragResult
wxDropSource::DoDragDrop(int flags
)
819 wxCHECK_MSG( m_data
&& m_data
->GetFormatCount(), wxDragNone
,
820 wxT("Drop source: no data") );
823 if (g_blockEventsOnDrag
)
826 // don't start dragging if no button is down
827 if (g_lastButtonNumber
== 0)
830 // we can only start a drag after a mouse event
831 if (g_lastMouseEvent
== NULL
)
834 GTKConnectDragSignals();
835 wxON_BLOCK_EXIT_OBJ0(*this, wxDropSource::GTKDisconnectDragSignals
);
839 GtkTargetList
*target_list
= gtk_target_list_new( NULL
, 0 );
841 wxDataFormat
*array
= new wxDataFormat
[ m_data
->GetFormatCount() ];
842 m_data
->GetAllFormats( array
);
843 size_t count
= m_data
->GetFormatCount();
844 for (size_t i
= 0; i
< count
; i
++)
846 GdkAtom atom
= array
[i
];
847 wxLogTrace(TRACE_DND
, wxT("Drop source: Supported atom %s"),
848 gdk_atom_name( atom
));
849 gtk_target_list_add( target_list
, atom
, 0, 0 );
853 int allowed_actions
= GDK_ACTION_COPY
;
854 if ( flags
& wxDrag_AllowMove
)
855 allowed_actions
|= GDK_ACTION_MOVE
;
857 // VZ: as we already use g_blockEventsOnDrag it shouldn't be that bad
858 // to use a global to pass the flags to the drop target but I'd
859 // surely prefer a better way to do it
860 gs_flagsForDrag
= flags
;
862 m_retValue
= wxDragCancel
;
864 GdkDragContext
*context
= gtk_drag_begin( m_widget
,
866 (GdkDragAction
)allowed_actions
,
867 g_lastButtonNumber
, // number of mouse button which started drag
868 (GdkEvent
*) g_lastMouseEvent
);
872 // this can happen e.g. if gdk_pointer_grab() failed
876 m_dragContext
= context
;
878 PrepareIcon( allowed_actions
, context
);
881 gtk_main_iteration();
883 g_signal_handlers_disconnect_by_func (m_iconWindow
,
884 (gpointer
) gtk_dnd_window_configure_callback
, this);
889 void wxDropSource::GTKConnectDragSignals()
894 g_blockEventsOnDrag
= true;
896 g_signal_connect (m_widget
, "drag_data_get",
897 G_CALLBACK (source_drag_data_get
), this);
898 g_signal_connect (m_widget
, "drag_end",
899 G_CALLBACK (source_drag_end
), this);
903 void wxDropSource::GTKDisconnectDragSignals()
908 g_blockEventsOnDrag
= false;
910 g_signal_handlers_disconnect_by_func (m_widget
,
911 (gpointer
) source_drag_data_get
,
913 g_signal_handlers_disconnect_by_func (m_widget
,
914 (gpointer
) source_drag_end
,
919 // wxUSE_DRAG_AND_DROP