]> git.saurik.com Git - wxWidgets.git/blobdiff - src/gtk/dnd.cpp
Fix wrong wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK name in the docs.
[wxWidgets.git] / src / gtk / dnd.cpp
index dd9fe2745c15e9524be8bfe5f4c1596ac23db3bd..c7bdf480a8d6f1260a6c309424c8f5c07dd3ee61 100644 (file)
@@ -26,6 +26,7 @@
 #include "wx/scopeguard.h"
 
 #include <gtk/gtk.h>
+#include "wx/gtk/private/gtk2-compat.h"
 
 //----------------------------------------------------------------------------
 // global data
@@ -36,12 +37,10 @@ extern bool g_blockEventsOnDrag;
 // the flags used for the last DoDragDrop()
 static long gs_flagsForDrag = 0;
 
-#ifdef __WXDEBUG__
 // the trace mask we use with wxLogTrace() - call
 // wxLog::AddTraceMask(TRACE_DND) to enable the trace messages from here
 // (there are quite a few of them, so don't enable this by default)
-static const wxChar *TRACE_DND = _T("dnd");
-#endif
+#define TRACE_DND "dnd"
 
 // global variables because GTK+ DnD want to have the
 // mouse event that caused it
@@ -166,7 +165,7 @@ static void target_drag_leave( GtkWidget *WXUNUSED(widget),
 {
     /* inform the wxDropTarget about the current GdkDragContext.
        this is only valid for the duration of this call */
-    drop_target->GtkSetDragContext( context );
+    drop_target->GTKSetDragContext( context );
 
     /* we don't need return values. this event is just for
        information */
@@ -176,7 +175,7 @@ static void target_drag_leave( GtkWidget *WXUNUSED(widget),
     drop_target->m_firstMotion = true;
 
     /* after this, invalidate the drop_target's GdkDragContext */
-    drop_target->GtkSetDragContext( NULL );
+    drop_target->GTKSetDragContext( NULL );
 }
 }
 
@@ -206,81 +205,51 @@ static gboolean target_drag_motion( GtkWidget *WXUNUSED(widget),
     }
 #endif
 
-    /* inform the wxDropTarget about the current GdkDragContext.
-       this is only valid for the duration of this call */
-    drop_target->GtkSetDragContext( context );
-
-    // GTK+ always supposes that we want to copy the data by default while we
-    // might want to move it, so examine not only suggested_action - which is
-    // only good if we don't have our own preferences - but also the actions
-    // field
-    wxDragResult result;
-    if (drop_target->GetDefaultAction() == wxDragNone)
-    {
-        // use default action set by wxDropSource::DoDragDrop()
-        if ( (gs_flagsForDrag & wxDrag_DefaultMove) == wxDrag_DefaultMove &&
-            (context->actions & GDK_ACTION_MOVE ) )
-        {
-             // move is requested by the program and allowed by GTK+ - do it, even
-            // though suggested_action may be currently wxDragCopy
-            result = wxDragMove;
-        }
-        else // use whatever GTK+ says we should
-        {
-            result = ConvertFromGTK(context->suggested_action);
+    // Inform the wxDropTarget about the current GdkDragContext.
+    // This is only valid for the duration of this call.
+    drop_target->GTKSetDragContext( context );
 
-            if ( (result == wxDragMove) && !(gs_flagsForDrag & wxDrag_AllowMove) )
-            {
-                // we're requested to move but we can't
-                result = wxDragCopy;
-            }
-        }
-    }
-    else if (drop_target->GetDefaultAction() == wxDragMove &&
-                (context->actions & GDK_ACTION_MOVE))
+    // Does the source actually accept the data type?
+    if (drop_target->GTKGetMatchingPair() == (GdkAtom) 0)
     {
-        
-       result = wxDragMove;
-    }
-    else
-    {
-        if (context->actions & GDK_ACTION_COPY)
-            result = wxDragCopy;
-        else if (context->actions & GDK_ACTION_MOVE)
-            result = wxDragMove;
-        else
-            result = wxDragNone;
+        drop_target->GTKSetDragContext( NULL );
+        return FALSE;
     }
 
+    wxDragResult suggested_action = drop_target->GTKFigureOutSuggestedAction();
+
+    wxDragResult result = wxDragNone;
+
     if (drop_target->m_firstMotion)
     {
-        /* the first "drag_motion" event substitutes a "drag_enter" event */
-        result = drop_target->OnEnter( x, y, result );
+        // the first "drag_motion" event substitutes a "drag_enter" event
+        result = drop_target->OnEnter( x, y, suggested_action );
     }
     else
     {
-        /* give program a chance to react (i.e. to say no by returning FALSE) */
-        result = drop_target->OnDragOver( x, y, result );
+        // give program a chance to react (i.e. to say no by returning FALSE)
+        result = drop_target->OnDragOver( x, y, suggested_action );
     }
 
-    bool ret = wxIsDragResultOk( result );
-    if (ret)
-    {
-        GdkDragAction action;
-        if (result == wxDragCopy)
-            action = GDK_ACTION_COPY;
-        else if (result == wxDragLink)
-            action = GDK_ACTION_LINK;
-        else
-            action = GDK_ACTION_MOVE;
+    GdkDragAction result_action = GDK_ACTION_DEFAULT;
+    if (result == wxDragCopy)
+        result_action = GDK_ACTION_COPY;
+    else if (result == wxDragLink)
+        result_action = GDK_ACTION_LINK;
+    else
+        result_action = GDK_ACTION_MOVE;
 
-        gdk_drag_status( context, action, time );
-    }
+    // is result action actually supported
+    bool ret ((result_action != GDK_ACTION_DEFAULT) &&
+              (context->actions & result_action));
 
-    /* after this, invalidate the drop_target's GdkDragContext */
-    drop_target->GtkSetDragContext( NULL );
+    if (ret)
+        gdk_drag_status( context, result_action, time );
 
-    /* this has to be done because GDK has no "drag_enter" event */
+    // after this, invalidate the drop_target's GdkDragContext
+    drop_target->GTKSetDragContext( NULL );
+
+    // this has to be done because GDK has no "drag_enter" event
     drop_target->m_firstMotion = false;
 
     return ret;
@@ -304,26 +273,33 @@ static gboolean target_drag_drop( GtkWidget *widget,
        the drop, call gtk_drag_finish() with success == FALSE
        otherwise call gtk_drag_data_get()" */
 
-    /* this seems to make a difference between not accepting
-       due to wrong target area and due to wrong format. let
-       us hope that this is not required.. */
-
     /* inform the wxDropTarget about the current GdkDragContext.
        this is only valid for the duration of this call */
-    drop_target->GtkSetDragContext( context );
+    drop_target->GTKSetDragContext( context );
+
+    // Does the source actually accept the data type?
+    if (drop_target->GTKGetMatchingPair() == (GdkAtom) 0)
+    {
+        // cancel the whole thing
+        gtk_drag_finish( context,
+                          FALSE,        // no success
+                          FALSE,        // don't delete data on dropping side
+                          time );
+
+        drop_target->GTKSetDragContext( NULL );
+
+        drop_target->m_firstMotion = true;
+
+        return FALSE;
+    }
 
     /* inform the wxDropTarget about the current drag widget.
        this is only valid for the duration of this call */
-    drop_target->GtkSetDragWidget( widget );
+    drop_target->GTKSetDragWidget( widget );
 
     /* inform the wxDropTarget about the current drag time.
        this is only valid for the duration of this call */
-    drop_target->GtkSetDragTime( time );
-
-/*
-    wxDragResult result = wxDragMove;
-    if (context->suggested_action == GDK_ACTION_COPY) result = wxDragCopy;
-*/
+    drop_target->GTKSetDragTime( time );
 
     /* reset the block here as someone might very well
        show a dialog as a reaction to a drop and this
@@ -334,9 +310,7 @@ static gboolean target_drag_drop( GtkWidget *widget,
 
     if (!ret)
     {
-#ifdef __WXDEBUG__
         wxLogTrace(TRACE_DND, wxT( "Drop target: OnDrop returned FALSE") );
-#endif
 
         /* cancel the whole thing */
         gtk_drag_finish( context,
@@ -346,40 +320,25 @@ static gboolean target_drag_drop( GtkWidget *widget,
     }
     else
     {
-#ifdef __WXDEBUG__
         wxLogTrace(TRACE_DND, wxT( "Drop target: OnDrop returned true") );
-#endif
 
-#if wxUSE_THREADS
-        /* disable GUI threads */
-#endif
-
-        GdkAtom format = drop_target->GtkGetMatchingPair();
+        GdkAtom format = drop_target->GTKGetMatchingPair();
 
         // this does happen somehow, see bug 555111
-        wxCHECK_MSG( format, FALSE, _T("no matching GdkAtom for format?") );
+        wxCHECK_MSG( format, FALSE, wxT("no matching GdkAtom for format?") );
 
-/*
-        GdkDragAction action = GDK_ACTION_MOVE;
-        if (result == wxDragCopy) action == GDK_ACTION_COPY;
-        context->action = action;
-*/
         /* this should trigger an "drag_data_received" event */
         gtk_drag_get_data( widget,
                            context,
                            format,
                            time );
-
-#if wxUSE_THREADS
-        /* re-enable GUI threads */
-#endif
     }
 
     /* after this, invalidate the drop_target's GdkDragContext */
-    drop_target->GtkSetDragContext( NULL );
+    drop_target->GTKSetDragContext( NULL );
 
     /* after this, invalidate the drop_target's drag widget */
-    drop_target->GtkSetDragWidget( NULL );
+    drop_target->GTKSetDragWidget( NULL );
 
     /* this has to be done because GDK has no "drag_enter" event */
     drop_target->m_firstMotion = true;
@@ -405,7 +364,7 @@ static void target_drag_data_received( GtkWidget *WXUNUSED(widget),
     /* Owen Taylor: "call gtk_drag_finish() with
        success == TRUE" */
 
-    if ((data->length <= 0) || (data->format != 8))
+    if (gtk_selection_data_get_length(data) <= 0 || gtk_selection_data_get_format(data) != 8)
     {
         /* negative data length and non 8-bit data format
            qualifies for junk */
@@ -414,37 +373,31 @@ static void target_drag_data_received( GtkWidget *WXUNUSED(widget),
         return;
     }
 
-#ifdef __WXDEBUG__
     wxLogTrace(TRACE_DND, wxT( "Drop target: data received event") );
-#endif
 
     /* inform the wxDropTarget about the current GtkSelectionData.
        this is only valid for the duration of this call */
-    drop_target->GtkSetDragData( data );
+    drop_target->GTKSetDragData( data );
 
     wxDragResult result = ConvertFromGTK(context->action);
 
     if ( wxIsDragResultOk( drop_target->OnData( x, y, result ) ) )
     {
-#ifdef __WXDEBUG__
         wxLogTrace(TRACE_DND, wxT( "Drop target: OnData returned true") );
-#endif
 
         /* tell GTK that data transfer was successful */
         gtk_drag_finish( context, TRUE, FALSE, time );
     }
     else
     {
-#ifdef __WXDEBUG__
         wxLogTrace(TRACE_DND, wxT( "Drop target: OnData returned FALSE") );
-#endif
 
         /* tell GTK that data transfer was not successful */
         gtk_drag_finish( context, FALSE, FALSE, time );
     }
 
     /* after this, invalidate the drop_target's drag data */
-    drop_target->GtkSetDragData( NULL );
+    drop_target->GTKSetDragData( NULL );
 }
 }
 
@@ -466,44 +419,85 @@ wxDragResult wxDropTarget::OnDragOver( wxCoord WXUNUSED(x),
                                        wxCoord WXUNUSED(y),
                                        wxDragResult def )
 {
-    // GetMatchingPair() checks for m_dataObject too, no need to do it here
-
-    // disable the debug message from GetMatchingPair() - there are too many
-    // of them otherwise
-#ifdef __WXDEBUG__
-    wxLogNull noLog;
-#endif // Debug
-
-    return (GtkGetMatchingPair() != (GdkAtom) 0) ? def : wxDragNone;
+    return def;
 }
 
 bool wxDropTarget::OnDrop( wxCoord WXUNUSED(x), wxCoord WXUNUSED(y) )
 {
-    if (!m_dataObject)
-        return false;
-
-    return (GtkGetMatchingPair() != (GdkAtom) 0);
+    return true;
 }
 
 wxDragResult wxDropTarget::OnData( wxCoord WXUNUSED(x), wxCoord WXUNUSED(y),
                                    wxDragResult def )
 {
-    if (!m_dataObject)
-        return wxDragNone;
-
-    if (GtkGetMatchingPair() == (GdkAtom) 0)
-        return wxDragNone;
-
     return GetData() ? def : wxDragNone;
 }
 
+wxDragResult wxDropTarget::GTKFigureOutSuggestedAction()
+{
+    if (!m_dragContext)
+        return wxDragError;
+
+    // GTK+ always supposes that we want to copy the data by default while we
+    // might want to move it, so examine not only suggested_action - which is
+    // only good if we don't have our own preferences - but also the actions
+    // field
+    wxDragResult suggested_action = wxDragNone;
+    if (GetDefaultAction() == wxDragNone)
+    {
+        // use default action set by wxDropSource::DoDragDrop()
+        if ( (gs_flagsForDrag & wxDrag_DefaultMove) == wxDrag_DefaultMove &&
+            (m_dragContext->actions & GDK_ACTION_MOVE ) )
+        {
+            // move is requested by the program and allowed by GTK+ - do it, even
+            // though suggested_action may be currently wxDragCopy
+            suggested_action = wxDragMove;
+        }
+        else // use whatever GTK+ says we should
+        {
+            suggested_action = ConvertFromGTK(m_dragContext->suggested_action);
+
+#if 0
+            // RR: I don't understand the code below: if the drag comes from
+            //     a different app, the gs_flagsForDrag is invalid; if it
+            //     comes from the same wx app, then GTK+ hopefully won't
+            //     suggest something we didn't allow in the frist place
+            //     in DoDrop()
+            if ( (suggested_action == wxDragMove) && !(gs_flagsForDrag & wxDrag_AllowMove) )
+            {
+                // we're requested to move but we can't
+                suggested_action = wxDragCopy;
+            }
+#endif
+        }
+    }
+    else if (GetDefaultAction() == wxDragMove &&
+            (m_dragContext->actions & GDK_ACTION_MOVE))
+    {
+
+        suggested_action = wxDragMove;
+    }
+    else
+    {
+        if (m_dragContext->actions & GDK_ACTION_COPY)
+            suggested_action = wxDragCopy;
+        else if (m_dragContext->actions & GDK_ACTION_MOVE)
+            suggested_action = wxDragMove;
+        else if (m_dragContext->actions & GDK_ACTION_LINK)
+            suggested_action = wxDragLink;
+        else
+            suggested_action = wxDragNone;
+    }
+
+    return suggested_action;
+}
 
 wxDataFormat wxDropTarget::GetMatchingPair()
 {
-    return wxDataFormat( GtkGetMatchingPair() );
+    return wxDataFormat( GTKGetMatchingPair() );
 }
 
-GdkAtom wxDropTarget::GtkGetMatchingPair()
+GdkAtom wxDropTarget::GTKGetMatchingPair(bool quiet)
 {
     if (!m_dataObject)
         return (GdkAtom) 0;
@@ -517,10 +511,11 @@ GdkAtom wxDropTarget::GtkGetMatchingPair()
         GdkAtom formatAtom = (GdkAtom)(child->data);
         wxDataFormat format( formatAtom );
 
-#ifdef __WXDEBUG__
-        wxLogTrace(TRACE_DND, wxT("Drop target: drag has format: %s"),
-                   format.GetId().c_str());
-#endif // Debug
+        if ( !quiet )
+        {
+            wxLogTrace(TRACE_DND, wxT("Drop target: drag has format: %s"),
+                       format.GetId().c_str());
+        }
 
         if (m_dataObject->IsSupportedFormat( format ))
             return formatAtom;
@@ -539,12 +534,14 @@ bool wxDropTarget::GetData()
     if (!m_dataObject)
         return false;
 
-    wxDataFormat dragFormat( m_dragData->target );
+    wxDataFormat dragFormat(gtk_selection_data_get_target(m_dragData));
 
     if (!m_dataObject->IsSupportedFormat( dragFormat ))
         return false;
 
-    m_dataObject->SetData( dragFormat, (size_t)m_dragData->length, (const void*)m_dragData->data );
+    m_dataObject->SetData(dragFormat,
+        (size_t)gtk_selection_data_get_length(m_dragData),
+        (const void*)gtk_selection_data_get_data(m_dragData));
 
     return true;
 }
@@ -605,45 +602,37 @@ void wxDropTarget::GtkRegisterWidget( GtkWidget *widget )
 extern "C" {
 static void
 source_drag_data_get  (GtkWidget          *WXUNUSED(widget),
-                       GdkDragContext     *WXUNUSED(context),
+                       GdkDragContext     *context,
                        GtkSelectionData   *selection_data,
                        guint               WXUNUSED(info),
                        guint               WXUNUSED(time),
                        wxDropSource       *drop_source )
 {
-    wxDataFormat format( selection_data->target );
+    wxDataFormat format(gtk_selection_data_get_target(selection_data));
 
-#ifdef __WXDEBUG__
     wxLogTrace(TRACE_DND, wxT("Drop source: format requested: %s"),
                format.GetId().c_str());
-#endif
 
-    drop_source->m_retValue = wxDragCancel;
+    drop_source->m_retValue = wxDragError;
 
     wxDataObject *data = drop_source->GetDataObject();
 
     if (!data)
     {
-#ifdef __WXDEBUG__
         wxLogTrace(TRACE_DND, wxT("Drop source: no data object") );
-#endif
-       return;
+        return;
     }
 
     if (!data->IsSupportedFormat(format))
     {
-#ifdef __WXDEBUG__
         wxLogTrace(TRACE_DND, wxT("Drop source: unsupported format") );
-#endif
-       return;
+        return;
     }
 
     if (data->GetDataSize(format) == 0)
     {
-#ifdef __WXDEBUG__
         wxLogTrace(TRACE_DND, wxT("Drop source: empty data") );
-#endif
-       return;
+        return;
     }
 
     size_t size = data->GetDataSize(format);
@@ -658,20 +647,14 @@ source_drag_data_get  (GtkWidget          *WXUNUSED(widget),
         return;
     }
 
-#if wxUSE_THREADS
-    /* disable GUI threads */
-#endif
+    drop_source->m_retValue = ConvertFromGTK( context->action );
 
     gtk_selection_data_set( selection_data,
-                            selection_data->target,
+                            gtk_selection_data_get_target(selection_data),
                             8,   // 8-bit
                             d,
                             size );
 
-#if wxUSE_THREADS
-    /* enable GUI threads */
-#endif
-
     delete[] d;
 }
 }
@@ -685,8 +668,6 @@ static void source_drag_end( GtkWidget          *WXUNUSED(widget),
                              GdkDragContext     *WXUNUSED(context),
                              wxDropSource       *drop_source )
 {
-    // printf( "Drag source: drag_end.\n" );
-
     drop_source->m_waiting = false;
 }
 }
@@ -722,7 +703,7 @@ wxDropSource::wxDropSource(wxWindow *win,
     m_widget = win->m_widget;
     if (win->m_wxwindow) m_widget = win->m_wxwindow;
 
-    m_retValue = wxDragCancel;
+    m_retValue = wxDragNone;
 
     SetIcons(iconCopy, iconMove, iconNone);
 }
@@ -743,7 +724,7 @@ wxDropSource::wxDropSource(wxDataObject& data,
     m_widget = win->m_widget;
     if (win->m_wxwindow) m_widget = win->m_wxwindow;
 
-    m_retValue = wxDragCancel;
+    m_retValue = wxDragNone;
 
     SetIcons(iconCopy, iconMove, iconNone);
 }
@@ -756,11 +737,11 @@ void wxDropSource::SetIcons(const wxIcon &iconCopy,
     m_iconMove = iconMove;
     m_iconNone = iconNone;
 
-    if ( !m_iconCopy.Ok() )
+    if ( !m_iconCopy.IsOk() )
         m_iconCopy = wxIcon(page_xpm);
-    if ( !m_iconMove.Ok() )
+    if ( !m_iconMove.IsOk() )
         m_iconMove = m_iconCopy;
-    if ( !m_iconNone.Ok() )
+    if ( !m_iconNone.IsOk() )
         m_iconNone = m_iconCopy;
 }
 
@@ -805,7 +786,7 @@ void wxDropSource::PrepareIcon( int action, GdkDragContext *context )
     g_signal_connect (m_iconWindow, "configure_event",
                       G_CALLBACK (gtk_dnd_window_configure_callback), this);
 
-    gdk_window_set_back_pixmap (m_iconWindow->window, pixmap, FALSE);
+    gdk_window_set_back_pixmap(gtk_widget_get_window(m_iconWindow), pixmap, false);
 
     if (mask)
         gtk_widget_shape_combine_mask (m_iconWindow, mask, 0, 0);
@@ -843,25 +824,26 @@ wxDragResult wxDropSource::DoDragDrop(int flags)
     for (size_t i = 0; i < count; i++)
     {
         GdkAtom atom = array[i];
-#ifdef __WXDEBUG__
-        wxLogTrace(TRACE_DND, wxT("Drop source: Supported atom %s"), gdk_atom_name( atom ));
-#endif
-       gtk_target_list_add( target_list, atom, 0, 0 );
+        wxLogTrace(TRACE_DND, wxT("Drop source: Supported atom %s"),
+                   gdk_atom_name( atom ));
+        gtk_target_list_add( target_list, atom, 0, 0 );
     }
     delete[] array;
 
-    int action = GDK_ACTION_COPY;
+    int allowed_actions = GDK_ACTION_COPY;
     if ( flags & wxDrag_AllowMove )
-        action |= GDK_ACTION_MOVE;
+        allowed_actions |= GDK_ACTION_MOVE;
 
     // VZ: as we already use g_blockEventsOnDrag it shouldn't be that bad
     //     to use a global to pass the flags to the drop target but I'd
     //     surely prefer a better way to do it
     gs_flagsForDrag = flags;
 
+    m_retValue = wxDragCancel;
+
     GdkDragContext *context = gtk_drag_begin( m_widget,
                 target_list,
-                (GdkDragAction)action,
+                (GdkDragAction)allowed_actions,
                 g_lastButtonNumber,  // number of mouse button which started drag
                 (GdkEvent*) g_lastMouseEvent );
 
@@ -873,14 +855,13 @@ wxDragResult wxDropSource::DoDragDrop(int flags)
 
     m_dragContext = context;
 
-    PrepareIcon( action, context );
+    PrepareIcon( allowed_actions, context );
 
     while (m_waiting)
         gtk_main_iteration();
 
-    m_retValue = ConvertFromGTK(context->action);
-    if ( m_retValue == wxDragNone )
-         m_retValue = wxDragCancel;
+    g_signal_handlers_disconnect_by_func (m_iconWindow,
+                                          (gpointer) gtk_dnd_window_configure_callback, this);
 
     return m_retValue;
 }