1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/gtk/dnd.cpp
3 // Purpose: wxDropTarget class
4 // Author: Robert Roebling
6 // Copyright: (c) 1998 Robert Roebling
7 // Licence: wxWindows licence
8 ///////////////////////////////////////////////////////////////////////////////
10 // For compilers that support precompilation, includes "wx.h".
11 #include "wx/wxprec.h"
13 #if wxUSE_DRAG_AND_DROP
22 #include "wx/window.h"
23 #include "wx/gdicmn.h"
26 #include "wx/scopeguard.h"
29 #include "wx/gtk/private/gtk2-compat.h"
31 //----------------------------------------------------------------------------
33 //----------------------------------------------------------------------------
35 extern bool g_blockEventsOnDrag
;
37 // the flags used for the last DoDragDrop()
38 static long gs_flagsForDrag
= 0;
40 // the trace mask we use with wxLogTrace() - call
41 // wxLog::AddTraceMask(TRACE_DND) to enable the trace messages from here
42 // (there are quite a few of them, so don't enable this by default)
43 #define TRACE_DND "dnd"
45 // global variables because GTK+ DnD want to have the
46 // mouse event that caused it
47 extern GdkEvent
*g_lastMouseEvent
;
48 extern int g_lastButtonNumber
;
50 //----------------------------------------------------------------------------
52 //----------------------------------------------------------------------------
54 /* Copyright (c) Julian Smart */
55 static const char * page_xpm
[] = {
56 /* columns rows colors chars-per-pixel */
105 " 56477<<<<8<<9&:X ",
106 " 59642%&*=-;<09&:5 ",
107 " 5q9642%&*=-<<<<<# ",
108 " 5qqw777<<<<<88:>+ ",
109 " erqq9642%&*=t;::+ ",
110 " eyrqq9642%&*=t;:O ",
111 " eyywwww777<<<<t;O ",
112 " e0yyrqq9642%&*=to ",
113 " e00yyrqq9642%&*=o ",
114 " eu0wwwwwww777<&*X ",
115 " euu00yyrqq9642%&X ",
116 " eiuu00yyrqq9642%X ",
117 " eiiwwwwwwwwww742$ ",
118 " eiiiuu00yyrqq964$ ",
119 " eiiiiuu00yyrqq96$ ",
120 " eiiiiiuu00yyrqq95 ",
121 " eiiiiiiuu00yyrqq5 ",
122 " eeeeeeeeeeeeee55e ",
131 // ============================================================================
133 // ============================================================================
135 // ----------------------------------------------------------------------------
136 // convert between GTK+ and wxWidgets DND constants
137 // ----------------------------------------------------------------------------
139 static wxDragResult
ConvertFromGTK(long action
)
143 case GDK_ACTION_COPY
:
146 case GDK_ACTION_LINK
:
149 case GDK_ACTION_MOVE
:
156 // ----------------------------------------------------------------------------
158 // ----------------------------------------------------------------------------
161 static void target_drag_leave( GtkWidget
*WXUNUSED(widget
),
162 GdkDragContext
*context
,
163 guint
WXUNUSED(time
),
164 wxDropTarget
*drop_target
)
166 /* inform the wxDropTarget about the current GdkDragContext.
167 this is only valid for the duration of this call */
168 drop_target
->GTKSetDragContext( context
);
170 /* we don't need return values. this event is just for
172 drop_target
->OnLeave();
174 /* this has to be done because GDK has no "drag_enter" event */
175 drop_target
->m_firstMotion
= true;
177 /* after this, invalidate the drop_target's GdkDragContext */
178 drop_target
->GTKSetDragContext( NULL
);
182 // ----------------------------------------------------------------------------
184 // ----------------------------------------------------------------------------
187 static gboolean
target_drag_motion( GtkWidget
*WXUNUSED(widget
),
188 GdkDragContext
*context
,
192 wxDropTarget
*drop_target
)
194 /* Owen Taylor: "if the coordinates not in a drop zone,
195 return FALSE, otherwise call gtk_drag_status() and
199 wxPrintf( "motion\n" );
201 for (tmp_list
= context
->targets
; tmp_list
; tmp_list
= tmp_list
->next
)
203 wxString atom
= wxString::FromAscii( gdk_atom_name (GDK_POINTER_TO_ATOM (tmp_list
->data
)) );
204 wxPrintf( "Atom: %s\n", atom
);
208 // Inform the wxDropTarget about the current GdkDragContext.
209 // This is only valid for the duration of this call.
210 drop_target
->GTKSetDragContext( context
);
212 // Does the source actually accept the data type?
213 if (drop_target
->GTKGetMatchingPair() == (GdkAtom
) 0)
215 drop_target
->GTKSetDragContext( NULL
);
219 wxDragResult suggested_action
= drop_target
->GTKFigureOutSuggestedAction();
221 wxDragResult result
= wxDragNone
;
223 if (drop_target
->m_firstMotion
)
225 // the first "drag_motion" event substitutes a "drag_enter" event
226 result
= drop_target
->OnEnter( x
, y
, suggested_action
);
230 // give program a chance to react (i.e. to say no by returning FALSE)
231 result
= drop_target
->OnDragOver( x
, y
, suggested_action
);
234 GdkDragAction result_action
= GDK_ACTION_DEFAULT
;
235 if (result
== wxDragCopy
)
236 result_action
= GDK_ACTION_COPY
;
237 else if (result
== wxDragLink
)
238 result_action
= GDK_ACTION_LINK
;
240 result_action
= GDK_ACTION_MOVE
;
242 // is result action actually supported
243 bool ret
= (result_action
!= GDK_ACTION_DEFAULT
) &&
244 (gdk_drag_context_get_actions(context
) & result_action
);
247 gdk_drag_status( context
, result_action
, time
);
249 // after this, invalidate the drop_target's GdkDragContext
250 drop_target
->GTKSetDragContext( NULL
);
252 // this has to be done because GDK has no "drag_enter" event
253 drop_target
->m_firstMotion
= false;
259 // ----------------------------------------------------------------------------
261 // ----------------------------------------------------------------------------
264 static gboolean
target_drag_drop( GtkWidget
*widget
,
265 GdkDragContext
*context
,
269 wxDropTarget
*drop_target
)
271 /* Owen Taylor: "if the drop is not in a drop zone,
272 return FALSE, otherwise, if you aren't accepting
273 the drop, call gtk_drag_finish() with success == FALSE
274 otherwise call gtk_drag_data_get()" */
276 /* inform the wxDropTarget about the current GdkDragContext.
277 this is only valid for the duration of this call */
278 drop_target
->GTKSetDragContext( context
);
280 // Does the source actually accept the data type?
281 if (drop_target
->GTKGetMatchingPair() == (GdkAtom
) 0)
283 // cancel the whole thing
284 gtk_drag_finish( context
,
286 FALSE
, // don't delete data on dropping side
289 drop_target
->GTKSetDragContext( NULL
);
291 drop_target
->m_firstMotion
= true;
296 /* inform the wxDropTarget about the current drag widget.
297 this is only valid for the duration of this call */
298 drop_target
->GTKSetDragWidget( widget
);
300 /* inform the wxDropTarget about the current drag time.
301 this is only valid for the duration of this call */
302 drop_target
->GTKSetDragTime( time
);
304 /* reset the block here as someone might very well
305 show a dialog as a reaction to a drop and this
306 wouldn't work without events */
307 g_blockEventsOnDrag
= false;
309 bool ret
= drop_target
->OnDrop( x
, y
);
313 wxLogTrace(TRACE_DND
, wxT( "Drop target: OnDrop returned FALSE") );
315 /* cancel the whole thing */
316 gtk_drag_finish( context
,
317 FALSE
, /* no success */
318 FALSE
, /* don't delete data on dropping side */
323 wxLogTrace(TRACE_DND
, wxT( "Drop target: OnDrop returned true") );
325 GdkAtom format
= drop_target
->GTKGetMatchingPair();
327 // this does happen somehow, see bug 555111
328 wxCHECK_MSG( format
, FALSE
, wxT("no matching GdkAtom for format?") );
330 /* this should trigger an "drag_data_received" event */
331 gtk_drag_get_data( widget
,
337 /* after this, invalidate the drop_target's GdkDragContext */
338 drop_target
->GTKSetDragContext( NULL
);
340 /* after this, invalidate the drop_target's drag widget */
341 drop_target
->GTKSetDragWidget( NULL
);
343 /* this has to be done because GDK has no "drag_enter" event */
344 drop_target
->m_firstMotion
= true;
350 // ----------------------------------------------------------------------------
351 // "drag_data_received"
352 // ----------------------------------------------------------------------------
355 static void target_drag_data_received( GtkWidget
*WXUNUSED(widget
),
356 GdkDragContext
*context
,
359 GtkSelectionData
*data
,
360 guint
WXUNUSED(info
),
362 wxDropTarget
*drop_target
)
364 /* Owen Taylor: "call gtk_drag_finish() with
367 if (gtk_selection_data_get_length(data
) <= 0 || gtk_selection_data_get_format(data
) != 8)
369 /* negative data length and non 8-bit data format
370 qualifies for junk */
371 gtk_drag_finish (context
, FALSE
, FALSE
, time
);
376 wxLogTrace(TRACE_DND
, wxT( "Drop target: data received event") );
378 /* inform the wxDropTarget about the current GtkSelectionData.
379 this is only valid for the duration of this call */
380 drop_target
->GTKSetDragData( data
);
382 wxDragResult result
= ConvertFromGTK(gdk_drag_context_get_selected_action(context
));
384 if ( wxIsDragResultOk( drop_target
->OnData( x
, y
, result
) ) )
386 wxLogTrace(TRACE_DND
, wxT( "Drop target: OnData returned true") );
388 /* tell GTK that data transfer was successful */
389 gtk_drag_finish( context
, TRUE
, FALSE
, time
);
393 wxLogTrace(TRACE_DND
, wxT( "Drop target: OnData returned FALSE") );
395 /* tell GTK that data transfer was not successful */
396 gtk_drag_finish( context
, FALSE
, FALSE
, time
);
399 /* after this, invalidate the drop_target's drag data */
400 drop_target
->GTKSetDragData( NULL
);
404 //----------------------------------------------------------------------------
406 //----------------------------------------------------------------------------
408 wxDropTarget::wxDropTarget( wxDataObject
*data
)
409 : wxDropTargetBase( data
)
411 m_firstMotion
= true;
412 m_dragContext
= NULL
;
418 wxDragResult
wxDropTarget::OnDragOver( wxCoord
WXUNUSED(x
),
425 bool wxDropTarget::OnDrop( wxCoord
WXUNUSED(x
), wxCoord
WXUNUSED(y
) )
430 wxDragResult
wxDropTarget::OnData( wxCoord
WXUNUSED(x
), wxCoord
WXUNUSED(y
),
433 return GetData() ? def
: wxDragNone
;
436 wxDragResult
wxDropTarget::GTKFigureOutSuggestedAction()
441 // GTK+ always supposes that we want to copy the data by default while we
442 // might want to move it, so examine not only suggested_action - which is
443 // only good if we don't have our own preferences - but also the actions
445 wxDragResult suggested_action
= wxDragNone
;
446 const GdkDragAction actions
= gdk_drag_context_get_actions(m_dragContext
);
447 if (GetDefaultAction() == wxDragNone
)
449 // use default action set by wxDropSource::DoDragDrop()
450 if ( (gs_flagsForDrag
& wxDrag_DefaultMove
) == wxDrag_DefaultMove
&&
451 (actions
& GDK_ACTION_MOVE
))
453 // move is requested by the program and allowed by GTK+ - do it, even
454 // though suggested_action may be currently wxDragCopy
455 suggested_action
= wxDragMove
;
457 else // use whatever GTK+ says we should
459 suggested_action
= ConvertFromGTK(gdk_drag_context_get_suggested_action(m_dragContext
));
462 // RR: I don't understand the code below: if the drag comes from
463 // a different app, the gs_flagsForDrag is invalid; if it
464 // comes from the same wx app, then GTK+ hopefully won't
465 // suggest something we didn't allow in the frist place
467 if ( (suggested_action
== wxDragMove
) && !(gs_flagsForDrag
& wxDrag_AllowMove
) )
469 // we're requested to move but we can't
470 suggested_action
= wxDragCopy
;
475 else if (GetDefaultAction() == wxDragMove
&&
476 (actions
& GDK_ACTION_MOVE
))
479 suggested_action
= wxDragMove
;
483 if (actions
& GDK_ACTION_COPY
)
484 suggested_action
= wxDragCopy
;
485 else if (actions
& GDK_ACTION_MOVE
)
486 suggested_action
= wxDragMove
;
487 else if (actions
& GDK_ACTION_LINK
)
488 suggested_action
= wxDragLink
;
490 suggested_action
= wxDragNone
;
493 return suggested_action
;
496 wxDataFormat
wxDropTarget::GetMatchingPair()
498 return wxDataFormat( GTKGetMatchingPair() );
501 GdkAtom
wxDropTarget::GTKGetMatchingPair(bool quiet
)
509 const GList
* child
= gdk_drag_context_list_targets(m_dragContext
);
512 GdkAtom formatAtom
= (GdkAtom
)(child
->data
);
513 wxDataFormat
format( formatAtom
);
517 wxLogTrace(TRACE_DND
, wxT("Drop target: drag has format: %s"),
518 format
.GetId().c_str());
521 if (m_dataObject
->IsSupportedFormat( format
))
530 bool wxDropTarget::GetData()
538 wxDataFormat
dragFormat(gtk_selection_data_get_target(m_dragData
));
540 if (!m_dataObject
->IsSupportedFormat( dragFormat
))
543 m_dataObject
->SetData(dragFormat
,
544 (size_t)gtk_selection_data_get_length(m_dragData
),
545 (const void*)gtk_selection_data_get_data(m_dragData
));
550 void wxDropTarget::GtkUnregisterWidget( GtkWidget
*widget
)
552 wxCHECK_RET( widget
!= NULL
, wxT("unregister widget is NULL") );
554 gtk_drag_dest_unset( widget
);
556 g_signal_handlers_disconnect_by_func (widget
,
557 (gpointer
) target_drag_leave
, this);
558 g_signal_handlers_disconnect_by_func (widget
,
559 (gpointer
) target_drag_motion
, this);
560 g_signal_handlers_disconnect_by_func (widget
,
561 (gpointer
) target_drag_drop
, this);
562 g_signal_handlers_disconnect_by_func (widget
,
563 (gpointer
) target_drag_data_received
, this);
566 void wxDropTarget::GtkRegisterWidget( GtkWidget
*widget
)
568 wxCHECK_RET( widget
!= NULL
, wxT("register widget is NULL") );
570 /* gtk_drag_dest_set() determines what default behaviour we'd like
571 GTK to supply. we don't want to specify out targets (=formats)
572 or actions in advance (i.e. not GTK_DEST_DEFAULT_MOTION and
573 not GTK_DEST_DEFAULT_DROP). instead we react individually to
574 "drag_motion" and "drag_drop" events. this makes it possible
575 to allow dropping on only a small area. we should set
576 GTK_DEST_DEFAULT_HIGHLIGHT as this will switch on the nice
577 highlighting if dragging over standard controls, but this
578 seems to be broken without the other two. */
580 gtk_drag_dest_set( widget
,
581 (GtkDestDefaults
) 0, /* no default behaviour */
582 NULL
, /* we don't supply any formats here */
583 0, /* number of targets = 0 */
584 (GdkDragAction
) 0 ); /* we don't supply any actions here */
586 g_signal_connect (widget
, "drag_leave",
587 G_CALLBACK (target_drag_leave
), this);
589 g_signal_connect (widget
, "drag_motion",
590 G_CALLBACK (target_drag_motion
), this);
592 g_signal_connect (widget
, "drag_drop",
593 G_CALLBACK (target_drag_drop
), this);
595 g_signal_connect (widget
, "drag_data_received",
596 G_CALLBACK (target_drag_data_received
), this);
599 //----------------------------------------------------------------------------
601 //----------------------------------------------------------------------------
605 source_drag_data_get (GtkWidget
*WXUNUSED(widget
),
606 GdkDragContext
*context
,
607 GtkSelectionData
*selection_data
,
608 guint
WXUNUSED(info
),
609 guint
WXUNUSED(time
),
610 wxDropSource
*drop_source
)
612 wxDataFormat
format(gtk_selection_data_get_target(selection_data
));
614 wxLogTrace(TRACE_DND
, wxT("Drop source: format requested: %s"),
615 format
.GetId().c_str());
617 drop_source
->m_retValue
= wxDragError
;
619 wxDataObject
*data
= drop_source
->GetDataObject();
623 wxLogTrace(TRACE_DND
, wxT("Drop source: no data object") );
627 if (!data
->IsSupportedFormat(format
))
629 wxLogTrace(TRACE_DND
, wxT("Drop source: unsupported format") );
633 if (data
->GetDataSize(format
) == 0)
635 wxLogTrace(TRACE_DND
, wxT("Drop source: empty data") );
639 size_t size
= data
->GetDataSize(format
);
641 // printf( "data size: %d.\n", (int)data_size );
643 guchar
*d
= new guchar
[size
];
645 if (!data
->GetDataHere( format
, (void*)d
))
651 drop_source
->m_retValue
= ConvertFromGTK(gdk_drag_context_get_selected_action(context
));
653 gtk_selection_data_set( selection_data
,
654 gtk_selection_data_get_target(selection_data
),
663 //----------------------------------------------------------------------------
665 //----------------------------------------------------------------------------
668 static void source_drag_end( GtkWidget
*WXUNUSED(widget
),
669 GdkDragContext
*WXUNUSED(context
),
670 wxDropSource
*drop_source
)
672 drop_source
->m_waiting
= false;
676 //-----------------------------------------------------------------------------
677 // "configure_event" from m_iconWindow
678 //-----------------------------------------------------------------------------
682 gtk_dnd_window_configure_callback( GtkWidget
*WXUNUSED(widget
), GdkEventConfigure
*WXUNUSED(event
), wxDropSource
*source
)
684 source
->GiveFeedback(ConvertFromGTK(gdk_drag_context_get_selected_action(source
->m_dragContext
)));
690 //---------------------------------------------------------------------------
692 //---------------------------------------------------------------------------
694 wxDropSource::wxDropSource(wxWindow
*win
,
695 const wxIcon
&iconCopy
,
696 const wxIcon
&iconMove
,
697 const wxIcon
&iconNone
)
704 m_widget
= win
->m_widget
;
705 if (win
->m_wxwindow
) m_widget
= win
->m_wxwindow
;
707 m_retValue
= wxDragNone
;
709 SetIcons(iconCopy
, iconMove
, iconNone
);
712 wxDropSource::wxDropSource(wxDataObject
& data
,
714 const wxIcon
&iconCopy
,
715 const wxIcon
&iconMove
,
716 const wxIcon
&iconNone
)
725 m_widget
= win
->m_widget
;
726 if (win
->m_wxwindow
) m_widget
= win
->m_wxwindow
;
728 m_retValue
= wxDragNone
;
730 SetIcons(iconCopy
, iconMove
, iconNone
);
733 void wxDropSource::SetIcons(const wxIcon
&iconCopy
,
734 const wxIcon
&iconMove
,
735 const wxIcon
&iconNone
)
737 m_iconCopy
= iconCopy
;
738 m_iconMove
= iconMove
;
739 m_iconNone
= iconNone
;
741 if ( !m_iconCopy
.IsOk() )
742 m_iconCopy
= wxIcon(page_xpm
);
743 if ( !m_iconMove
.IsOk() )
744 m_iconMove
= m_iconCopy
;
745 if ( !m_iconNone
.IsOk() )
746 m_iconNone
= m_iconCopy
;
749 wxDropSource::~wxDropSource()
753 void wxDropSource::PrepareIcon( int action
, GdkDragContext
*context
)
755 // get the right icon to display
757 if ( action
& GDK_ACTION_MOVE
)
759 else if ( action
& GDK_ACTION_COPY
)
766 if ( icon
->GetMask() )
767 mask
= *icon
->GetMask();
771 GdkPixmap
*pixmap
= icon
->GetPixmap();
773 GdkColormap
*colormap
= gtk_widget_get_colormap( m_widget
);
774 gtk_widget_push_colormap (colormap
);
777 m_iconWindow
= gtk_window_new (GTK_WINDOW_POPUP
);
778 gtk_widget_set_events (m_iconWindow
, GDK_BUTTON_PRESS_MASK
| GDK_BUTTON_RELEASE_MASK
);
779 gtk_widget_set_app_paintable (m_iconWindow
, TRUE
);
782 gtk_widget_set_visual(m_iconWindow
, gtk_widget_get_visual(m_widget
));
784 gtk_widget_pop_colormap ();
787 gtk_widget_set_size_request (m_iconWindow
, icon
->GetWidth(), icon
->GetHeight());
788 gtk_widget_realize (m_iconWindow
);
790 g_signal_connect (m_iconWindow
, "configure_event",
791 G_CALLBACK (gtk_dnd_window_configure_callback
), this);
794 cairo_t
* cr
= gdk_cairo_create(gtk_widget_get_window(m_iconWindow
));
795 icon
->SetSourceSurface(cr
, 0, 0);
796 cairo_pattern_t
* pattern
= cairo_get_source(cr
);
797 gdk_window_set_background_pattern(gtk_widget_get_window(m_iconWindow
), pattern
);
799 cairo_surface_t
* mask
= NULL
;
801 mask
= *icon
->GetMask();
804 cairo_region_t
* region
= gdk_cairo_region_create_from_surface(mask
);
805 gtk_widget_shape_combine_region(m_iconWindow
, region
);
806 cairo_region_destroy(region
);
809 gdk_window_set_back_pixmap(gtk_widget_get_window(m_iconWindow
), pixmap
, false);
812 gtk_widget_shape_combine_mask (m_iconWindow
, mask
, 0, 0);
815 gtk_drag_set_icon_widget( context
, m_iconWindow
, 0, 0 );
818 wxDragResult
wxDropSource::DoDragDrop(int flags
)
820 wxCHECK_MSG( m_data
&& m_data
->GetFormatCount(), wxDragNone
,
821 wxT("Drop source: no data") );
824 if (g_blockEventsOnDrag
)
827 // don't start dragging if no button is down
828 if (g_lastButtonNumber
== 0)
831 // we can only start a drag after a mouse event
832 if (g_lastMouseEvent
== NULL
)
835 GTKConnectDragSignals();
836 wxON_BLOCK_EXIT_OBJ0(*this, wxDropSource::GTKDisconnectDragSignals
);
840 GtkTargetList
*target_list
= gtk_target_list_new( NULL
, 0 );
842 wxDataFormat
*array
= new wxDataFormat
[ m_data
->GetFormatCount() ];
843 m_data
->GetAllFormats( array
);
844 size_t count
= m_data
->GetFormatCount();
845 for (size_t i
= 0; i
< count
; i
++)
847 GdkAtom atom
= array
[i
];
848 wxLogTrace(TRACE_DND
, wxT("Drop source: Supported atom %s"),
849 gdk_atom_name( atom
));
850 gtk_target_list_add( target_list
, atom
, 0, 0 );
854 int allowed_actions
= GDK_ACTION_COPY
;
855 if ( flags
& wxDrag_AllowMove
)
856 allowed_actions
|= GDK_ACTION_MOVE
;
858 // VZ: as we already use g_blockEventsOnDrag it shouldn't be that bad
859 // to use a global to pass the flags to the drop target but I'd
860 // surely prefer a better way to do it
861 gs_flagsForDrag
= flags
;
863 m_retValue
= wxDragCancel
;
865 GdkDragContext
*context
= gtk_drag_begin( m_widget
,
867 (GdkDragAction
)allowed_actions
,
868 g_lastButtonNumber
, // number of mouse button which started drag
869 (GdkEvent
*) g_lastMouseEvent
);
873 // this can happen e.g. if gdk_pointer_grab() failed
877 m_dragContext
= context
;
879 PrepareIcon( allowed_actions
, context
);
882 gtk_main_iteration();
884 g_signal_handlers_disconnect_by_func (m_iconWindow
,
885 (gpointer
) gtk_dnd_window_configure_callback
, this);
890 void wxDropSource::GTKConnectDragSignals()
895 g_blockEventsOnDrag
= true;
897 g_signal_connect (m_widget
, "drag_data_get",
898 G_CALLBACK (source_drag_data_get
), this);
899 g_signal_connect (m_widget
, "drag_end",
900 G_CALLBACK (source_drag_end
), this);
904 void wxDropSource::GTKDisconnectDragSignals()
909 g_blockEventsOnDrag
= false;
911 g_signal_handlers_disconnect_by_func (m_widget
,
912 (gpointer
) source_drag_data_get
,
914 g_signal_handlers_disconnect_by_func (m_widget
,
915 (gpointer
) source_drag_end
,
920 // wxUSE_DRAG_AND_DROP