Merge pull request #13208 from daschuer/gh13206

Handle not supported files when dragging to waveforms and spinnies
mixxxdj · May 19, 2024 · 0907188 · 0907188
2 parents cc9beb6 + a2b1867
commit 0907188
Show file tree

Hide file tree

Showing 9 changed files with 67 additions and 38 deletions.
diff --git a/src/util/dnd.cpp b/src/util/dnd.cpp
@@ -256,38 +256,38 @@ QDrag* DragAndDropHelper::dragTrackLocations(
 
 //static
 void DragAndDropHelper::handleTrackDragEnterEvent(
-        QDragEnterEvent* event,
+        QDragEnterEvent* pEvent,
         const QString& group,
         UserSettingsPointer pConfig) {
     if (allowLoadToPlayer(group, pConfig) &&
-            dragEnterAccept(*event->mimeData(), group, true, false)) {
-        event->acceptProposedAction();
+            dragEnterAccept(*pEvent->mimeData(), group, true, false)) {
+        pEvent->acceptProposedAction();
     } else {
         qDebug() << "Ignoring drag enter event, loading not allowed";
-        event->ignore();
+        pEvent->ignore();
     }
 }
 
 //static
 void DragAndDropHelper::handleTrackDropEvent(
-        QDropEvent* event,
+        QDropEvent* pEvent,
         TrackDropTarget& target,
         const QString& group,
         UserSettingsPointer pConfig) {
     if (allowLoadToPlayer(group, pConfig)) {
-        if (allowDeckCloneAttempt(*event, group)) {
-            event->accept();
-            target.emitCloneDeck(event->mimeData()->text(), group);
+        if (allowDeckCloneAttempt(*pEvent, group)) {
+            pEvent->accept();
+            target.emitCloneDeck(pEvent->mimeData()->text(), group);
             return;
         } else {
             const QList<mixxx::FileInfo> files = dropEventFiles(
-                    *event->mimeData(), group, true, false);
+                    *pEvent->mimeData(), group, true, false);
             if (!files.isEmpty()) {
-                event->accept();
+                pEvent->accept();
                 target.emitTrackDropped(files.at(0).location(), group);
                 return;
             }
         }
     }
-    event->ignore();
+    pEvent->ignore();
 }
diff --git a/src/util/dnd.h b/src/util/dnd.h
@@ -42,12 +42,12 @@ class DragAndDropHelper final {
             const QString& sourceIdentifier);
 
     static void handleTrackDragEnterEvent(
-            QDragEnterEvent* event,
+            QDragEnterEvent* pEvent,
             const QString& group,
             UserSettingsPointer pConfig);
 
     static void handleTrackDropEvent(
-            QDropEvent* event,
+            QDropEvent* pEvent,
             TrackDropTarget& target,
             const QString& group,
             UserSettingsPointer pConfig);

diff --git a/src/widget/openglwindow.cpp b/src/widget/openglwindow.cpp
@@ -10,7 +10,8 @@
 #include "widget/wglwidget.h"
 
 OpenGLWindow::OpenGLWindow(WGLWidget* pWidget)
-        : m_pWidget(pWidget) {
+        : m_pWidget(pWidget),
+          m_pTrackDropTarget(nullptr) {
     setFormat(WaveformWidgetFactory::getSurfaceFormat());
     // Prevent this window/widget from getting keyboard focus on click.
     setFlag(Qt::WindowDoesNotAcceptFocus);
@@ -68,19 +69,46 @@ bool OpenGLWindow::event(QEvent* pEv) {
         if (t == QEvent::MouseMove) {
             ToolTipQOpenGL::singleton().start(
                     m_pWidget, dynamic_cast<QMouseEvent*>(pEv)->globalPos());
+            return result;
         }
+
         if (t == QEvent::Leave) {
             ToolTipQOpenGL::singleton().stop();
+            return result;
+        }
+
+        // Drag & Drop events are not delivered correctly when using QApplication::sendEvent
+        // and even result in a recursive call to this method, so we use our own mechanism.
+
+        if (t == QEvent::DragEnter) {
+            DEBUG_ASSERT(!m_pTrackDropTarget);
+            TrackDropTarget* pTrackDropTarget = m_pWidget->trackDropTarget();
+            if (pTrackDropTarget) {
+                bool ret = pTrackDropTarget->handleDragAndDropEventFromWindow(pEv);
+                if (pEv->isAccepted()) {
+                    m_pTrackDropTarget = pTrackDropTarget;
+                }
+                return ret;
+            }
+            pEv->ignore();
+            return false; // clazy:exclude=base-class-event
         }
 
-        if (t == QEvent::DragEnter || t == QEvent::DragMove ||
-                t == QEvent::DragLeave || t == QEvent::Drop) {
-            // Drag & Drop events are not delivered correctly when using QApplication::sendEvent
-            // and even result in a recursive call to this method, so we use our own mechanism.
-            if (m_pWidget->trackDropTarget()) {
-                return m_pWidget->trackDropTarget()->handleDragAndDropEventFromWindow(pEv);
+        if (t == QEvent::DragMove) {
+            if (m_pTrackDropTarget) {
+                bool ret = m_pTrackDropTarget->handleDragAndDropEventFromWindow(pEv);
+                return ret;
             }
+            pEv->ignore();
+            return false; // clazy:exclude=base-class-event
+        }
 
+        if (t == QEvent::DragLeave || t == QEvent::Drop) {
+            if (m_pTrackDropTarget) {
+                bool ret = m_pTrackDropTarget->handleDragAndDropEventFromWindow(pEv);
+                m_pTrackDropTarget = nullptr;
+                return ret;
+            }
             pEv->ignore();
             return false; // clazy:exclude=base-class-event
         }

diff --git a/src/widget/openglwindow.h b/src/widget/openglwindow.h
@@ -3,6 +3,7 @@
 #include <QOpenGLWindow>
 
 class WGLWidget;
+class TrackDropTarget;
 
 /// Helper class used by wglwidgetqopengl
 
@@ -22,4 +23,5 @@ class OpenGLWindow : public QOpenGLWindow {
     bool event(QEvent* pEv) override;
 
     WGLWidget* m_pWidget;
+    TrackDropTarget* m_pTrackDropTarget;
 };
diff --git a/src/widget/trackdroptarget.h b/src/widget/trackdroptarget.h
@@ -1,9 +1,8 @@
 #pragma once
 
+#include <QEvent>
 #include <QString>
 
-class QEvent;
-
 /// Mixin to mark a widget as a drop target for tracks.
 ///
 /// This class is *not* derived from QObject (inheriting from 2 QObject classes
@@ -22,8 +21,8 @@ class TrackDropTarget {
         emit trackDropped(filename, group); // clazy:exclude=incorrect-emit
     }
 
-    virtual bool handleDragAndDropEventFromWindow(QEvent* event) {
-        Q_UNUSED(event);
+    virtual bool handleDragAndDropEventFromWindow(QEvent* pEvent) {
+        pEvent->ignore();
         return false;
     }
 

diff --git a/src/widget/wspinnybase.cpp b/src/widget/wspinnybase.cpp
@@ -647,14 +647,14 @@ bool WSpinnyBase::event(QEvent* pEvent) {
     return WGLWidget::event(pEvent);
 }
 
-bool WSpinnyBase::handleDragAndDropEventFromWindow(QEvent* ev) {
-    return event(ev);
+bool WSpinnyBase::handleDragAndDropEventFromWindow(QEvent* pEvent) {
+    return event(pEvent);
 }
 
-void WSpinnyBase::dragEnterEvent(QDragEnterEvent* event) {
-    DragAndDropHelper::handleTrackDragEnterEvent(event, m_group, m_pConfig);
+void WSpinnyBase::dragEnterEvent(QDragEnterEvent* pEvent) {
+    DragAndDropHelper::handleTrackDragEnterEvent(pEvent, m_group, m_pConfig);
 }
 
-void WSpinnyBase::dropEvent(QDropEvent* event) {
-    DragAndDropHelper::handleTrackDropEvent(event, *this, m_group, m_pConfig);
+void WSpinnyBase::dropEvent(QDropEvent* pEvent) {
+    DragAndDropHelper::handleTrackDropEvent(pEvent, *this, m_group, m_pConfig);
 }
diff --git a/src/widget/wspinnybase.h b/src/widget/wspinnybase.h
@@ -78,7 +78,7 @@ class WSpinnyBase : public WGLWidget,
     bool event(QEvent* pEvent) override;
 
     // TrackDropTarget:
-    bool handleDragAndDropEventFromWindow(QEvent* ev) override;
+    bool handleDragAndDropEventFromWindow(QEvent* pEvent) override;
 
     double calculateAngle(double playpos);
     int calculateFullRotations(double playpos);

diff --git a/src/widget/wwaveformviewer.cpp b/src/widget/wwaveformviewer.cpp
@@ -202,16 +202,16 @@ void WWaveformViewer::wheelEvent(QWheelEvent* event) {
     }
 }
 
-void WWaveformViewer::dragEnterEvent(QDragEnterEvent* event) {
-    DragAndDropHelper::handleTrackDragEnterEvent(event, m_group, m_pConfig);
+void WWaveformViewer::dragEnterEvent(QDragEnterEvent* pEvent) {
+    DragAndDropHelper::handleTrackDragEnterEvent(pEvent, m_group, m_pConfig);
 }
 
-void WWaveformViewer::dropEvent(QDropEvent* event) {
-    DragAndDropHelper::handleTrackDropEvent(event, *this, m_group, m_pConfig);
+void WWaveformViewer::dropEvent(QDropEvent* pEvent) {
+    DragAndDropHelper::handleTrackDropEvent(pEvent, *this, m_group, m_pConfig);
 }
 
-bool WWaveformViewer::handleDragAndDropEventFromWindow(QEvent* ev) {
-    return event(ev);
+bool WWaveformViewer::handleDragAndDropEventFromWindow(QEvent* pEvent) {
+    return event(pEvent);
 }
 
 void WWaveformViewer::leaveEvent(QEvent*) {

diff --git a/src/widget/wwaveformviewer.h b/src/widget/wwaveformviewer.h
@@ -26,7 +26,7 @@ class WWaveformViewer : public WWidget, public TrackDropTarget {
     }
     void setup(const QDomNode& node, const SkinContext& context);
 
-    bool handleDragAndDropEventFromWindow(QEvent* ev) override;
+    bool handleDragAndDropEventFromWindow(QEvent* pEvent) override;
 
     void dragEnterEvent(QDragEnterEvent *event) override;
     void dropEvent(QDropEvent *event) override;