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"
30 //----------------------------------------------------------------------------
32 //----------------------------------------------------------------------------
34 extern bool g_blockEventsOnDrag
;
36 // the flags used for the last DoDragDrop()
37 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 static const wxChar
*TRACE_DND
= _T("dnd");
46 // global variables because GTK+ DnD want to have the
47 // mouse event that caused it
48 extern GdkEvent
*g_lastMouseEvent
;
49 extern int g_lastButtonNumber
;
51 //----------------------------------------------------------------------------
53 //----------------------------------------------------------------------------
55 /* Copyright (c) Julian Smart */
56 static const char * page_xpm
[] = {
57 /* columns rows colors chars-per-pixel */
106 " 56477<<<<8<<9&:X ",
107 " 59642%&*=-;<09&:5 ",
108 " 5q9642%&*=-<<<<<# ",
109 " 5qqw777<<<<<88:>+ ",
110 " erqq9642%&*=t;::+ ",
111 " eyrqq9642%&*=t;:O ",
112 " eyywwww777<<<<t;O ",
113 " e0yyrqq9642%&*=to ",
114 " e00yyrqq9642%&*=o ",
115 " eu0wwwwwww777<&*X ",
116 " euu00yyrqq9642%&X ",
117 " eiuu00yyrqq9642%X ",
118 " eiiwwwwwwwwww742$ ",
119 " eiiiuu00yyrqq964$ ",
120 " eiiiiuu00yyrqq96$ ",
121 " eiiiiiuu00yyrqq95 ",
122 " eiiiiiiuu00yyrqq5 ",
123 " eeeeeeeeeeeeee55e ",
132 // ============================================================================
134 // ============================================================================
136 // ----------------------------------------------------------------------------
137 // convert between GTK+ and wxWidgets DND constants
138 // ----------------------------------------------------------------------------
140 static wxDragResult
ConvertFromGTK(long action
)
144 case GDK_ACTION_COPY
:
147 case GDK_ACTION_LINK
:
150 case GDK_ACTION_MOVE
:
157 // ----------------------------------------------------------------------------
159 // ----------------------------------------------------------------------------
162 static void target_drag_leave( GtkWidget
*WXUNUSED(widget
),
163 GdkDragContext
*context
,
164 guint
WXUNUSED(time
),
165 wxDropTarget
*drop_target
)
167 /* inform the wxDropTarget about the current GdkDragContext.
168 this is only valid for the duration of this call */
169 drop_target
->SetDragContext( context
);
171 /* we don't need return values. this event is just for
173 drop_target
->OnLeave();
175 /* this has to be done because GDK has no "drag_enter" event */
176 drop_target
->m_firstMotion
= true;
178 /* after this, invalidate the drop_target's GdkDragContext */
179 drop_target
->SetDragContext( (GdkDragContext
*) NULL
);
183 // ----------------------------------------------------------------------------
185 // ----------------------------------------------------------------------------
188 static gboolean
target_drag_motion( GtkWidget
*WXUNUSED(widget
),
189 GdkDragContext
*context
,
193 wxDropTarget
*drop_target
)
195 /* Owen Taylor: "if the coordinates not in a drop zone,
196 return FALSE, otherwise call gtk_drag_status() and
200 wxPrintf( "motion\n" );
202 for (tmp_list
= context
->targets
; tmp_list
; tmp_list
= tmp_list
->next
)
204 wxString atom
= wxString::FromAscii( gdk_atom_name (GDK_POINTER_TO_ATOM (tmp_list
->data
)) );
205 wxPrintf( "Atom: %s\n", atom
);
209 /* inform the wxDropTarget about the current GdkDragContext.
210 this is only valid for the duration of this call */
211 drop_target
->SetDragContext( context
);
213 // GTK+ always supposes that we want to copy the data by default while we
214 // might want to move it, so examine not only suggested_action - which is
215 // only good if we don't have our own preferences - but also the actions
218 if (drop_target
->GetDefaultAction() == wxDragNone
)
220 // use default action set by wxDropSource::DoDragDrop()
221 if ( (gs_flagsForDrag
& wxDrag_DefaultMove
) == wxDrag_DefaultMove
&&
222 (context
->actions
& GDK_ACTION_MOVE
) )
224 // move is requested by the program and allowed by GTK+ - do it, even
225 // though suggested_action may be currently wxDragCopy
228 else // use whatever GTK+ says we should
230 result
= ConvertFromGTK(context
->suggested_action
);
232 if ( (result
== wxDragMove
) && !(gs_flagsForDrag
& wxDrag_AllowMove
) )
234 // we're requested to move but we can't
239 else if (drop_target
->GetDefaultAction() == wxDragMove
&&
240 (context
->actions
& GDK_ACTION_MOVE
))
247 if (context
->actions
& GDK_ACTION_COPY
)
249 else if (context
->actions
& GDK_ACTION_MOVE
)
255 if (drop_target
->m_firstMotion
)
257 /* the first "drag_motion" event substitutes a "drag_enter" event */
258 result
= drop_target
->OnEnter( x
, y
, result
);
262 /* give program a chance to react (i.e. to say no by returning FALSE) */
263 result
= drop_target
->OnDragOver( x
, y
, result
);
266 bool ret
= wxIsDragResultOk( result
);
269 GdkDragAction action
;
270 if (result
== wxDragCopy
)
271 action
= GDK_ACTION_COPY
;
272 else if (result
== wxDragLink
)
273 action
= GDK_ACTION_LINK
;
275 action
= GDK_ACTION_MOVE
;
277 gdk_drag_status( context
, action
, time
);
280 /* after this, invalidate the drop_target's GdkDragContext */
281 drop_target
->SetDragContext( (GdkDragContext
*) NULL
);
283 /* this has to be done because GDK has no "drag_enter" event */
284 drop_target
->m_firstMotion
= false;
290 // ----------------------------------------------------------------------------
292 // ----------------------------------------------------------------------------
295 static gboolean
target_drag_drop( GtkWidget
*widget
,
296 GdkDragContext
*context
,
300 wxDropTarget
*drop_target
)
302 /* Owen Taylor: "if the drop is not in a drop zone,
303 return FALSE, otherwise, if you aren't accepting
304 the drop, call gtk_drag_finish() with success == FALSE
305 otherwise call gtk_drag_data_get()" */
307 /* this seems to make a difference between not accepting
308 due to wrong target area and due to wrong format. let
309 us hope that this is not required.. */
311 /* inform the wxDropTarget about the current GdkDragContext.
312 this is only valid for the duration of this call */
313 drop_target
->SetDragContext( context
);
315 /* inform the wxDropTarget about the current drag widget.
316 this is only valid for the duration of this call */
317 drop_target
->SetDragWidget( widget
);
319 /* inform the wxDropTarget about the current drag time.
320 this is only valid for the duration of this call */
321 drop_target
->SetDragTime( time
);
324 wxDragResult result = wxDragMove;
325 if (context->suggested_action == GDK_ACTION_COPY) result = wxDragCopy;
328 /* reset the block here as someone might very well
329 show a dialog as a reaction to a drop and this
330 wouldn't work without events */
331 g_blockEventsOnDrag
= false;
333 bool ret
= drop_target
->OnDrop( x
, y
);
338 wxLogTrace(TRACE_DND
, wxT( "Drop target: OnDrop returned FALSE") );
341 /* cancel the whole thing */
342 gtk_drag_finish( context
,
343 FALSE
, /* no success */
344 FALSE
, /* don't delete data on dropping side */
350 wxLogTrace(TRACE_DND
, wxT( "Drop target: OnDrop returned true") );
354 /* disable GUI threads */
357 GdkAtom format
= drop_target
->GetMatchingPair();
359 // this does happen somehow, see bug 555111
360 wxCHECK_MSG( format
, FALSE
, _T("no matching GdkAtom for format?") );
363 GdkDragAction action = GDK_ACTION_MOVE;
364 if (result == wxDragCopy) action == GDK_ACTION_COPY;
365 context->action = action;
367 /* this should trigger an "drag_data_received" event */
368 gtk_drag_get_data( widget
,
374 /* re-enable GUI threads */
378 /* after this, invalidate the drop_target's GdkDragContext */
379 drop_target
->SetDragContext( (GdkDragContext
*) NULL
);
381 /* after this, invalidate the drop_target's drag widget */
382 drop_target
->SetDragWidget( (GtkWidget
*) NULL
);
384 /* this has to be done because GDK has no "drag_enter" event */
385 drop_target
->m_firstMotion
= true;
391 // ----------------------------------------------------------------------------
392 // "drag_data_received"
393 // ----------------------------------------------------------------------------
396 static void target_drag_data_received( GtkWidget
*WXUNUSED(widget
),
397 GdkDragContext
*context
,
400 GtkSelectionData
*data
,
401 guint
WXUNUSED(info
),
403 wxDropTarget
*drop_target
)
405 /* Owen Taylor: "call gtk_drag_finish() with
408 if ((data
->length
<= 0) || (data
->format
!= 8))
410 /* negative data length and non 8-bit data format
411 qualifies for junk */
412 gtk_drag_finish (context
, FALSE
, FALSE
, time
);
418 wxLogTrace(TRACE_DND
, wxT( "Drop target: data received event") );
421 /* inform the wxDropTarget about the current GtkSelectionData.
422 this is only valid for the duration of this call */
423 drop_target
->SetDragData( data
);
425 wxDragResult result
= ConvertFromGTK(context
->action
);
427 if ( wxIsDragResultOk( drop_target
->OnData( x
, y
, result
) ) )
430 wxLogTrace(TRACE_DND
, wxT( "Drop target: OnData returned true") );
433 /* tell GTK that data transfer was successful */
434 gtk_drag_finish( context
, TRUE
, FALSE
, time
);
439 wxLogTrace(TRACE_DND
, wxT( "Drop target: OnData returned FALSE") );
442 /* tell GTK that data transfer was not successful */
443 gtk_drag_finish( context
, FALSE
, FALSE
, time
);
446 /* after this, invalidate the drop_target's drag data */
447 drop_target
->SetDragData( (GtkSelectionData
*) NULL
);
451 //----------------------------------------------------------------------------
453 //----------------------------------------------------------------------------
455 wxDropTarget::wxDropTarget( wxDataObject
*data
)
456 : wxDropTargetBase( data
)
458 m_firstMotion
= true;
459 m_dragContext
= (GdkDragContext
*) NULL
;
460 m_dragWidget
= (GtkWidget
*) NULL
;
461 m_dragData
= (GtkSelectionData
*) NULL
;
465 wxDragResult
wxDropTarget::OnDragOver( wxCoord
WXUNUSED(x
),
469 // GetMatchingPair() checks for m_dataObject too, no need to do it here
471 // disable the debug message from GetMatchingPair() - there are too many
477 return (GetMatchingPair() != (GdkAtom
) 0) ? def
: wxDragNone
;
480 bool wxDropTarget::OnDrop( wxCoord
WXUNUSED(x
), wxCoord
WXUNUSED(y
) )
485 return (GetMatchingPair() != (GdkAtom
) 0);
488 wxDragResult
wxDropTarget::OnData( wxCoord
WXUNUSED(x
), wxCoord
WXUNUSED(y
),
494 if (GetMatchingPair() == (GdkAtom
) 0)
497 return GetData() ? def
: wxDragNone
;
500 GdkAtom
wxDropTarget::GetMatchingPair()
508 GList
*child
= m_dragContext
->targets
;
511 GdkAtom formatAtom
= (GdkAtom
)(child
->data
);
512 wxDataFormat
format( formatAtom
);
515 wxLogTrace(TRACE_DND
, wxT("Drop target: drag has format: %s"),
516 format
.GetId().c_str());
519 if (m_dataObject
->IsSupportedFormat( format
))
528 bool wxDropTarget::GetData()
536 wxDataFormat
dragFormat( m_dragData
->target
);
538 if (!m_dataObject
->IsSupportedFormat( dragFormat
))
541 m_dataObject
->SetData( dragFormat
, (size_t)m_dragData
->length
, (const void*)m_dragData
->data
);
546 void wxDropTarget::UnregisterWidget( GtkWidget
*widget
)
548 wxCHECK_RET( widget
!= NULL
, wxT("unregister widget is NULL") );
550 gtk_drag_dest_unset( widget
);
552 g_signal_handlers_disconnect_by_func (widget
,
553 (gpointer
) target_drag_leave
, this);
554 g_signal_handlers_disconnect_by_func (widget
,
555 (gpointer
) target_drag_motion
, this);
556 g_signal_handlers_disconnect_by_func (widget
,
557 (gpointer
) target_drag_drop
, this);
558 g_signal_handlers_disconnect_by_func (widget
,
559 (gpointer
) target_drag_data_received
, this);
562 void wxDropTarget::RegisterWidget( GtkWidget
*widget
)
564 wxCHECK_RET( widget
!= NULL
, wxT("register widget is NULL") );
566 /* gtk_drag_dest_set() determines what default behaviour we'd like
567 GTK to supply. we don't want to specify out targets (=formats)
568 or actions in advance (i.e. not GTK_DEST_DEFAULT_MOTION and
569 not GTK_DEST_DEFAULT_DROP). instead we react individually to
570 "drag_motion" and "drag_drop" events. this makes it possible
571 to allow dropping on only a small area. we should set
572 GTK_DEST_DEFAULT_HIGHLIGHT as this will switch on the nice
573 highlighting if dragging over standard controls, but this
574 seems to be broken without the other two. */
576 gtk_drag_dest_set( widget
,
577 (GtkDestDefaults
) 0, /* no default behaviour */
578 (GtkTargetEntry
*) NULL
, /* we don't supply any formats here */
579 0, /* number of targets = 0 */
580 (GdkDragAction
) 0 ); /* we don't supply any actions here */
582 g_signal_connect (widget
, "drag_leave",
583 G_CALLBACK (target_drag_leave
), this);
585 g_signal_connect (widget
, "drag_motion",
586 G_CALLBACK (target_drag_motion
), this);
588 g_signal_connect (widget
, "drag_drop",
589 G_CALLBACK (target_drag_drop
), this);
591 g_signal_connect (widget
, "drag_data_received",
592 G_CALLBACK (target_drag_data_received
), this);
595 //----------------------------------------------------------------------------
597 //----------------------------------------------------------------------------
601 source_drag_data_get (GtkWidget
*WXUNUSED(widget
),
602 GdkDragContext
*WXUNUSED(context
),
603 GtkSelectionData
*selection_data
,
604 guint
WXUNUSED(info
),
605 guint
WXUNUSED(time
),
606 wxDropSource
*drop_source
)
608 wxDataFormat
format( selection_data
->target
);
611 wxLogTrace(TRACE_DND
, wxT("Drop source: format requested: %s"),
612 format
.GetId().c_str());
615 drop_source
->m_retValue
= wxDragCancel
;
617 wxDataObject
*data
= drop_source
->GetDataObject();
622 wxLogTrace(TRACE_DND
, wxT("Drop source: no data object") );
627 if (!data
->IsSupportedFormat(format
))
630 wxLogTrace(TRACE_DND
, wxT("Drop source: unsupported format") );
635 if (data
->GetDataSize(format
) == 0)
638 wxLogTrace(TRACE_DND
, wxT("Drop source: empty data") );
643 size_t size
= data
->GetDataSize(format
);
645 // printf( "data size: %d.\n", (int)data_size );
647 guchar
*d
= new guchar
[size
];
649 if (!data
->GetDataHere( format
, (void*)d
))
656 /* disable GUI threads */
659 gtk_selection_data_set( selection_data
,
660 selection_data
->target
,
666 /* enable GUI threads */
673 //----------------------------------------------------------------------------
675 //----------------------------------------------------------------------------
678 static void source_drag_end( GtkWidget
*WXUNUSED(widget
),
679 GdkDragContext
*WXUNUSED(context
),
680 wxDropSource
*drop_source
)
682 // printf( "Drag source: drag_end.\n" );
684 drop_source
->m_waiting
= false;
688 //-----------------------------------------------------------------------------
689 // "configure_event" from m_iconWindow
690 //-----------------------------------------------------------------------------
694 gtk_dnd_window_configure_callback( GtkWidget
*WXUNUSED(widget
), GdkEventConfigure
*WXUNUSED(event
), wxDropSource
*source
)
696 source
->GiveFeedback( ConvertFromGTK(source
->m_dragContext
->action
) );
702 //---------------------------------------------------------------------------
704 //---------------------------------------------------------------------------
706 wxDropSource::wxDropSource(wxWindow
*win
,
707 const wxIcon
&iconCopy
,
708 const wxIcon
&iconMove
,
709 const wxIcon
&iconNone
)
713 m_iconWindow
= (GtkWidget
*) NULL
;
716 m_widget
= win
->m_widget
;
717 if (win
->m_wxwindow
) m_widget
= win
->m_wxwindow
;
719 m_retValue
= wxDragCancel
;
721 SetIcons(iconCopy
, iconMove
, iconNone
);
724 wxDropSource::wxDropSource(wxDataObject
& data
,
726 const wxIcon
&iconCopy
,
727 const wxIcon
&iconMove
,
728 const wxIcon
&iconNone
)
734 m_iconWindow
= (GtkWidget
*) NULL
;
737 m_widget
= win
->m_widget
;
738 if (win
->m_wxwindow
) m_widget
= win
->m_wxwindow
;
740 m_retValue
= wxDragCancel
;
742 SetIcons(iconCopy
, iconMove
, iconNone
);
745 void wxDropSource::SetIcons(const wxIcon
&iconCopy
,
746 const wxIcon
&iconMove
,
747 const wxIcon
&iconNone
)
749 m_iconCopy
= iconCopy
;
750 m_iconMove
= iconMove
;
751 m_iconNone
= iconNone
;
753 if ( !m_iconCopy
.Ok() )
754 m_iconCopy
= wxIcon(page_xpm
);
755 if ( !m_iconMove
.Ok() )
756 m_iconMove
= m_iconCopy
;
757 if ( !m_iconNone
.Ok() )
758 m_iconNone
= m_iconCopy
;
761 wxDropSource::~wxDropSource()
765 void wxDropSource::PrepareIcon( int action
, GdkDragContext
*context
)
767 // get the right icon to display
769 if ( action
& GDK_ACTION_MOVE
)
771 else if ( action
& GDK_ACTION_COPY
)
777 if ( icon
->GetMask() )
778 mask
= icon
->GetMask()->GetBitmap();
780 mask
= (GdkBitmap
*)NULL
;
782 GdkPixmap
*pixmap
= icon
->GetPixmap();
785 gdk_drawable_get_size (pixmap
, &width
, &height
);
787 GdkColormap
*colormap
= gtk_widget_get_colormap( m_widget
);
788 gtk_widget_push_colormap (colormap
);
790 m_iconWindow
= gtk_window_new (GTK_WINDOW_POPUP
);
791 gtk_widget_set_events (m_iconWindow
, GDK_BUTTON_PRESS_MASK
| GDK_BUTTON_RELEASE_MASK
);
792 gtk_widget_set_app_paintable (m_iconWindow
, TRUE
);
794 gtk_widget_pop_colormap ();
796 gtk_widget_set_size_request (m_iconWindow
, width
, height
);
797 gtk_widget_realize (m_iconWindow
);
799 g_signal_connect (m_iconWindow
, "configure_event",
800 G_CALLBACK (gtk_dnd_window_configure_callback
), this);
802 gdk_window_set_back_pixmap (m_iconWindow
->window
, pixmap
, FALSE
);
805 gtk_widget_shape_combine_mask (m_iconWindow
, mask
, 0, 0);
807 gtk_drag_set_icon_widget( context
, m_iconWindow
, 0, 0 );
810 wxDragResult
wxDropSource::DoDragDrop(int flags
)
812 wxCHECK_MSG( m_data
&& m_data
->GetFormatCount(), wxDragNone
,
813 wxT("Drop source: no data") );
816 if (g_blockEventsOnDrag
)
819 // don't start dragging if no button is down
820 if (g_lastButtonNumber
== 0)
823 // we can only start a drag after a mouse event
824 if (g_lastMouseEvent
== NULL
)
827 GTKConnectDragSignals();
828 wxON_BLOCK_EXIT_OBJ0(*this, wxDropSource::GTKDisconnectDragSignals
);
832 GtkTargetList
*target_list
= gtk_target_list_new( (GtkTargetEntry
*) NULL
, 0 );
834 wxDataFormat
*array
= new wxDataFormat
[ m_data
->GetFormatCount() ];
835 m_data
->GetAllFormats( array
);
836 size_t count
= m_data
->GetFormatCount();
837 for (size_t i
= 0; i
< count
; i
++)
839 GdkAtom atom
= array
[i
];
841 wxLogTrace(TRACE_DND
, wxT("Drop source: Supported atom %s"), gdk_atom_name( atom
));
843 gtk_target_list_add( target_list
, atom
, 0, 0 );
847 int action
= GDK_ACTION_COPY
;
848 if ( flags
& wxDrag_AllowMove
)
849 action
|= GDK_ACTION_MOVE
;
851 // VZ: as we already use g_blockEventsOnDrag it shouldn't be that bad
852 // to use a global to pass the flags to the drop target but I'd
853 // surely prefer a better way to do it
854 gs_flagsForDrag
= flags
;
856 GdkDragContext
*context
= gtk_drag_begin( m_widget
,
858 (GdkDragAction
)action
,
859 g_lastButtonNumber
, // number of mouse button which started drag
860 (GdkEvent
*) g_lastMouseEvent
);
864 // this can happen e.g. if gdk_pointer_grab() failed
868 m_dragContext
= context
;
870 PrepareIcon( action
, context
);
873 gtk_main_iteration();
875 m_retValue
= ConvertFromGTK(context
->action
);
876 if ( m_retValue
== wxDragNone
)
877 m_retValue
= wxDragCancel
;
882 void wxDropSource::GTKConnectDragSignals()
887 g_blockEventsOnDrag
= true;
889 g_signal_connect (m_widget
, "drag_data_get",
890 G_CALLBACK (source_drag_data_get
), this);
891 g_signal_connect (m_widget
, "drag_end",
892 G_CALLBACK (source_drag_end
), this);
896 void wxDropSource::GTKDisconnectDragSignals()
901 g_blockEventsOnDrag
= false;
903 g_signal_handlers_disconnect_by_func (m_widget
,
904 (gpointer
) source_drag_data_get
,
906 g_signal_handlers_disconnect_by_func (m_widget
,
907 (gpointer
) source_drag_end
,
912 // wxUSE_DRAG_AND_DROP