Merge lp:~osomon/unity-2d/DropItem into lp:unity-2d/3.0

[Olivier Tilloy]

[launcher] Better implementation of drag’n’drop in QML.

The DropItem element has the following advantages:
 - less code
 - more re-usable

=== modified file 'launcher/Launcher.qml'
--- launcher/Launcher.qml	2011-03-01 16:40:00 +0000
+++ launcher/Launcher.qml	2011-03-02 16:04:16 +0000
@@ -2,7 +2,7 @@
 import UnityApplications 1.0
 import Unity2d 1.0 /* required for drag’n’drop handling */
 
-Item {
+DropItem {
     id: launcher
 
     Image {
@@ -13,6 +13,9 @@
         source: "artwork/background.png"
     }
 
+    onDragEnter: launcherView.onDragEnter(event)
+    onDrop: launcherView.onDrop(event)
+
     LauncherList {
         id: main
         anchors.top: parent.top
 
=== modified file 'launcher/LauncherItem.qml'
--- launcher/LauncherItem.qml	2011-03-02 10:34:42 +0000
+++ launcher/LauncherItem.qml	2011-03-02 16:04:16 +0000
@@ -27,11 +27,8 @@
    Additionally, when the tile is marked as 'urgent' it will start an animation where the
    rotation is changed so that it appears to be "shaking".
 */
-Item {
+DropItem {
     id: item
-    /* The object name is used by the launcher view to find the current
-       launcher item under the mouse cursor during a drag’n’drop event. */
-    objectName: "launcherItem"
 
     anchors.horizontalCenter: parent.horizontalCenter
     /* Manually add some padding to compensate for the spacing
 
=== modified file 'launcher/LauncherList.qml'
--- launcher/LauncherList.qml	2011-03-01 13:05:38 +0000
+++ launcher/LauncherList.qml	2011-03-02 16:04:16 +0000
@@ -68,8 +68,8 @@
         Binding { target: item.menu; property: "title"; value: item.name }
 
         /* Drag’n’drop handling */
-        function dragEnterEvent(event) { item.onDragEnter(event) }
-        function dropEvent(event) { item.onDrop(event) }
+        onDragEnter: item.onDragEnter(event)
+        onDrop: item.onDrop(event)
 
         function showMenu() {
             /* Prevent the simultaneous display of multiple menus */
 
=== modified file 'launcher/app/launcherview.cpp'
--- launcher/app/launcherview.cpp	2011-03-02 08:31:11 +0000
+++ launcher/app/launcherview.cpp	2011-03-02 16:04:16 +0000
@@ -28,24 +28,18 @@
 #include <QDeclarativeEngine>
 #include <QDeclarativeContext>
 #include <QDeclarativeImageProvider>
-#include <QGraphicsObject>
-#include <QMetaObject>
 
 #include <X11/Xlib.h>
 #include <X11/Xatom.h>
 
-#include "dragdropevent.h"
 #include <keyboardmodifiersmonitor.h>
 #include <hotkey.h>
 #include <hotkeymonitor.h>
+#include <dragdropevent.h>
 
 LauncherView::LauncherView() :
-    QDeclarativeView(),
-    m_dndCurrentLauncherItem(NULL), m_dndCurrentLauncherItemAccepted(false),
-    m_dndAccepted(false), m_superKeyPressed(false)
+    QDeclarativeView(), m_superKeyPressed(false)
 {
-    setAcceptDrops(true);
-
     m_enableSuperKey.setKey("/desktop/unity/launcher/super_key_enable");
     QObject::connect(&m_enableSuperKey, SIGNAL(valueChanged()),
                      this, SLOT(updateSuperKeyMonitoring()));
@@ -126,45 +120,8 @@
     }
 }
 
-QGraphicsObject*
-LauncherView::launcherItemAt(const QPoint& pos) const
-{
-    QGraphicsItem* item = itemAt(pos);
-    while(item != NULL) {
-        QGraphicsObject* object = qgraphicsitem_cast<QGraphicsObject*>(item);
-        if (object->objectName() == "launcherItem") {
-            return object;
-        }
-        item = item->parentItem();
-    }
-    return NULL;
-}
-
-void
-LauncherView::delegateDragEventHandlingToItem(QDropEvent* event, QGraphicsObject* item)
-{
-    if (item == NULL) {
-        return;
-    }
-    DeclarativeDragDropEvent dde(event, this);
-    QMetaObject::invokeMethod(item, "dragEnterEvent",
-                              Q_ARG(QVariant, QVariant::fromValue(&dde)));
-}
-
-bool
-LauncherView::acceptDndEvent(QDragEnterEvent* event)
-{
-    Q_FOREACH(QUrl url, getEventUrls(event)) {
-        if ((url.scheme() == "file" && url.path().endsWith(".desktop")) ||
-            url.scheme().startsWith("http")) {
-            return true;
-        }
-    }
-    return false;
-}
-
 QList<QUrl>
-LauncherView::getEventUrls(QDropEvent* event)
+LauncherView::getEventUrls(DeclarativeDragDropEvent* event)
 {
     const QMimeData* mimeData = event->mimeData();
     if (mimeData->hasUrls()) {
@@ -191,57 +148,25 @@
     return QList<QUrl>();
 }
 
-void
-LauncherView::dragEnterEvent(QDragEnterEvent* event)
-{
-    m_dndCurrentLauncherItem = NULL;
-    m_dndCurrentLauncherItemAccepted = false;
-    /* Compute whether the launcher itself accepts the event only once for this
-       given event. */
-    m_dndAccepted = acceptDndEvent(event);
-    /* Always accept the event so that subsequent move events are received. */
-    event->setAccepted(true);
-}
-
-void
-LauncherView::dragMoveEvent(QDragMoveEvent* event)
-{
-    QGraphicsObject* launcherItem = launcherItemAt(event->pos());
-    if (launcherItem == m_dndCurrentLauncherItem) {
-        if (m_dndCurrentLauncherItemAccepted || m_dndAccepted) {
+void LauncherView::onDragEnter(DeclarativeDragDropEvent* event)
+{
+    Q_FOREACH(QUrl url, getEventUrls(event)) {
+        if ((url.scheme() == "file" && url.path().endsWith(".desktop")) ||
+            url.scheme().startsWith("http")) {
             event->setAccepted(true);
-        }
-    } else {
-        m_dndCurrentLauncherItem = launcherItem;
-        m_dndCurrentLauncherItemAccepted = false;
-
-        if (m_dndCurrentLauncherItem != NULL) {
-            delegateDragEventHandlingToItem(event, m_dndCurrentLauncherItem);
-            if (event->isAccepted()) {
-                m_dndCurrentLauncherItemAccepted = true;
-            }
-        } else {
-            if (m_dndAccepted) {
-                event->setAccepted(true);
-            }
+            return;
         }
     }
 }
 
-void
-LauncherView::dropEvent(QDropEvent* event)
+void LauncherView::onDrop(DeclarativeDragDropEvent* event)
 {
-    if (m_dndCurrentLauncherItemAccepted) {
-        DeclarativeDragDropEvent dde(event, this);
-        QMetaObject::invokeMethod(m_dndCurrentLauncherItem, "dropEvent",
-                                  Q_ARG(QVariant, QVariant::fromValue(&dde)));
-    } else if (m_dndAccepted) {
-        Q_FOREACH(QUrl url, getEventUrls(event)) {
-            if (url.scheme() == "file" && url.path().endsWith(".desktop")) {
-                emit desktopFileDropped(url.path());
-            } else if (url.scheme().startsWith("http")) {
-                emit webpageUrlDropped(url);
-            }
+    foreach (QUrl url, getEventUrls(event)) {
+        if (url.scheme() == "file" && url.path().endsWith(".desktop")) {
+            emit desktopFileDropped(url.path());
+        }
+        else if (url.scheme().startsWith("http")) {
+            emit webpageUrlDropped(url);
         }
     }
 }
 
=== modified file 'launcher/app/launcherview.h'
--- launcher/app/launcherview.h	2011-03-02 08:31:11 +0000
+++ launcher/app/launcherview.h	2011-03-02 16:04:16 +0000
@@ -21,12 +21,12 @@
 #define LAUNCHERVIEW
 
 #include <QDeclarativeView>
+#include <QList>
 #include <QUrl>
-#include <QList>
-#include <QDragEnterEvent>
+
 #include "gconfitem-qml-wrapper.h"
 
-class QGraphicsObject;
+class DeclarativeDragDropEvent;
 
 class LauncherView : public QDeclarativeView
 {
@@ -37,6 +37,8 @@
 public:
     explicit LauncherView();
     Q_INVOKABLE QList<QVariant> getColorsFromIcon(QUrl source, QSize size) const;
+    Q_INVOKABLE void onDragEnter(DeclarativeDragDropEvent* event);
+    Q_INVOKABLE void onDrop(DeclarativeDragDropEvent* event);
 
     bool superKeyPressed() const { return m_superKeyPressed; }
 
@@ -52,25 +54,9 @@
     void updateSuperKeyMonitoring();
 
 private:
-    QList<QUrl> getEventUrls(QDropEvent*);
+    QList<QUrl> getEventUrls(DeclarativeDragDropEvent* event);
     void changeKeyboardShortcutsState(bool enabled);
 
-    /* Custom drag’n’drop handling */
-    void dragEnterEvent(QDragEnterEvent*);
-    void dragMoveEvent(QDragMoveEvent*);
-    void dropEvent(QDropEvent*);
-
-    QGraphicsObject* launcherItemAt(const QPoint&) const;
-    void delegateDragEventHandlingToItem(QDropEvent*, QGraphicsObject*);
-    bool acceptDndEvent(QDragEnterEvent*);
-
-    /* The launcher item currently under the mouse cursor during a dnd event */
-    QGraphicsObject* m_dndCurrentLauncherItem;
-    /* Whether it accepted the event */
-    bool m_dndCurrentLauncherItemAccepted;
-    /* Whether the launcher itself handles the current dnd event */
-    bool m_dndAccepted;
-
     GConfItemQmlWrapper m_enableSuperKey;
     bool m_superKeyPressed;
 };
 
=== modified file 'libunity-2d-private/Unity2d/CMakeLists.txt'
--- libunity-2d-private/Unity2d/CMakeLists.txt	2011-02-14 19:59:09 +0000
+++ libunity-2d-private/Unity2d/CMakeLists.txt	2011-03-02 16:04:16 +0000
@@ -15,6 +15,7 @@
     cacheeffect.cpp
     workspacesinfo.cpp
     signalwaiter.cpp
+    dropitem.cpp
     )
 
 set(unity-2d-private-qml_MOC_HDRS
@@ -26,6 +27,7 @@
     cacheeffect.h
     workspacesinfo.h
     signalwaiter.h
+    dropitem.h
     )
 
 qt4_wrap_cpp(unity-2d-private-qml_MOC_SRCS ${unity-2d-private-qml_MOC_HDRS})
 
=== added file 'libunity-2d-private/Unity2d/dropitem.cpp'
--- libunity-2d-private/Unity2d/dropitem.cpp	1970-01-01 00:00:00 +0000
+++ libunity-2d-private/Unity2d/dropitem.cpp	2011-03-02 16:04:16 +0000
@@ -0,0 +1,47 @@
+/*
+ * Copyright (C) 2011 Canonical, Ltd.
+ *
+ * Authors:
+ *  Florian Boucault <[e-mail]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "dropitem.h"
+
+#include <QGraphicsSceneDragDropEvent>
+
+#include "dragdropevent.h"
+
+DeclarativeDropItem::DeclarativeDropItem(QDeclarativeItem *parent) : QDeclarativeItem(parent)
+{
+    setAcceptDrops(true);
+}
+
+void DeclarativeDropItem::dragEnterEvent(QGraphicsSceneDragDropEvent *event)
+{
+    DeclarativeDragDropEvent dragDropEvent(event, this);
+    Q_EMIT dragEnter(&dragDropEvent);
+}
+
+void DeclarativeDropItem::dragLeaveEvent(QGraphicsSceneDragDropEvent *event)
+{
+    DeclarativeDragDropEvent dragDropEvent(event, this);
+    Q_EMIT dragLeave(&dragDropEvent);
+}
+
+void DeclarativeDropItem::dropEvent(QGraphicsSceneDragDropEvent *event)
+{
+    DeclarativeDragDropEvent dragDropEvent(event, this);
+    Q_EMIT drop(&dragDropEvent);
+}
 
=== added file 'libunity-2d-private/Unity2d/dropitem.h'
--- libunity-2d-private/Unity2d/dropitem.h	1970-01-01 00:00:00 +0000
+++ libunity-2d-private/Unity2d/dropitem.h	2011-03-02 16:04:16 +0000
@@ -0,0 +1,46 @@
+/*
+ * Copyright (C) 2011 Canonical, Ltd.
+ *
+ * Authors:
+ *  Florian Boucault <[e-mail]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef DROPITEM_H
+#define DROPITEM_H
+
+#include <QDeclarativeItem>
+
+class QGraphicsSceneDragDropEvent;
+class DeclarativeDragDropEvent;
+
+class DeclarativeDropItem : public QDeclarativeItem
+{
+    Q_OBJECT
+
+public:
+    DeclarativeDropItem(QDeclarativeItem *parent=0);
+
+Q_SIGNALS:
+    void dragEnter(DeclarativeDragDropEvent* event);
+    void dragLeave(DeclarativeDragDropEvent* event);
+    void drop(DeclarativeDragDropEvent* event);
+
+protected:
+    void dragEnterEvent(QGraphicsSceneDragDropEvent *event);
+    void dragLeaveEvent(QGraphicsSceneDragDropEvent *event);
+    void dropEvent(QGraphicsSceneDragDropEvent *event);
+};
+
+#endif // DROPITEM_H
 
=== modified file 'libunity-2d-private/Unity2d/plugin.cpp'
--- libunity-2d-private/Unity2d/plugin.cpp	2011-02-21 02:37:20 +0000
+++ libunity-2d-private/Unity2d/plugin.cpp	2011-03-02 16:04:16 +0000
@@ -34,6 +34,7 @@
 
 #include "mimedata.h"
 #include "dragdropevent.h"
+#include "dropitem.h"
 
 #include <QtDeclarative/qdeclarative.h>
 #include <QDeclarativeEngine>
@@ -75,6 +76,7 @@
     qmlRegisterType<QGraphicsDropShadowEffect>("Effects", 1, 0, "DropShadow");
 
     /* Custom drag’n’drop implementation in QML */
+    qmlRegisterType<DeclarativeDropItem>(uri, 0, 1, "DropItem");
     qmlRegisterType<DeclarativeMimeData>();
     qmlRegisterType<DeclarativeDragDropEvent>();
 }
 
=== modified file 'libunity-2d-private/src/dragdropevent.cpp'
--- libunity-2d-private/src/dragdropevent.cpp	2011-02-15 10:28:23 +0000
+++ libunity-2d-private/src/dragdropevent.cpp	2011-03-02 16:04:16 +0000
@@ -19,7 +19,9 @@
 
 #include "dragdropevent.h"
 
-DeclarativeDragDropEvent::DeclarativeDragDropEvent(QDropEvent* event, QObject* parent)
+#include <QGraphicsSceneDragDropEvent>
+
+DeclarativeDragDropEvent::DeclarativeDragDropEvent(QGraphicsSceneDragDropEvent* event, QObject* parent)
     : QObject(parent)
     , m_event(event)
     , m_mimeData(event->mimeData())
 
=== modified file 'libunity-2d-private/src/dragdropevent.h'
--- libunity-2d-private/src/dragdropevent.h	2011-02-15 10:28:23 +0000
+++ libunity-2d-private/src/dragdropevent.h	2011-03-02 16:04:16 +0000
@@ -25,9 +25,10 @@
 
 #include "mimedata.h"
 
-#include <QtGui/QDropEvent>
 #include <QtCore/Qt>
 
+class QGraphicsSceneDragDropEvent;
+
 class DeclarativeDragDropEvent : public QObject
 {
     Q_OBJECT
@@ -37,7 +38,7 @@
     Q_PROPERTY(Qt::DropAction dropAction READ dropAction WRITE setDropAction)
 
 public:
-    DeclarativeDragDropEvent(QDropEvent* event, QObject* parent=0);
+    DeclarativeDragDropEvent(QGraphicsSceneDragDropEvent* event, QObject* parent=0);
 
     /* getters */
     DeclarativeMimeData* mimeData() { return &m_mimeData; }
@@ -49,7 +50,7 @@
     void setDropAction(Qt::DropAction action);
 
 private:
-    QDropEvent* m_event;
+    QGraphicsSceneDragDropEvent* m_event;
     DeclarativeMimeData m_mimeData;
 };