feat: generalize drag and drop support (#1727)

* feat: generalize drag and drop support

* feat: disable flicking for list and grid views

* feat: implement drag and drop for some root items

* feat: add proper drag icon

* feat: add dragContent prop for list/grid items

Author: aurelleb

figura/tsapi.fig

@@ -188,7 +188,7 @@ service WindowManagement {
 struct ClipboardContent {
   text?: string;
   html?: string;
-  path?: string;
+  urls?: string[];
 };
 
 struct ClipboardOptions {

src/server/CMakeLists.txt

@@ -162,6 +162,7 @@ set(SRCS
 	src/color-formatter.cpp
 
 	src/services/clipboard/clipboard-server.hpp
+	src/services/clipboard/clipboard-content.hpp
 	src/services/clipboard/clipboard-mime.hpp
 	src/services/clipboard/clipboard-mime.cpp
 	src/services/clipboard/clipboard-db.hpp
@@ -474,6 +475,8 @@ set(SRCS
 	src/qml/root-search-model.cpp
 	src/qml/root-search-sources.hpp
 	src/qml/root-search-sources.cpp
+	src/qml/drag-utils.hpp
+	src/qml/drag-utils.cpp
 	src/qml/section-source.hpp
 	src/qml/section-list-model.hpp
 	src/qml/section-list-model.cpp
@@ -957,6 +960,7 @@ set(VICINAE_QML_FILES
 	src/qml/qml/ListAccessory.qml
 	src/qml/qml/ListAccessoryRow.qml
 	src/qml/qml/SelectableDelegate.qml
+	src/qml/qml/DraggableMouseArea.qml
 	src/qml/qml/SectionHeader.qml
 	src/qml/qml/Footer.qml
 	src/qml/qml/FooterButton.qml

src/server/src/extend/grid-model.hpp

@@ -6,6 +6,7 @@
 #include "extend/pagination-model.hpp"
 #include "extend/dropdown-model.hpp"
 #include "ui/image/url.hpp"
+#include "services/clipboard/clipboard-content.hpp"
 
 enum GridFit { GridContain, GridFill };
 
@@ -34,6 +35,7 @@ struct GridItemViewModel {
   std::optional<std::string> tooltip;
   std::vector<std::string> keywords;
   std::optional<ActionPannelModel> actionPannel;
+  std::optional<Clipboard::Content> dragContent;
 };
 
 struct GridSectionModel {

src/server/src/extend/list-model.hpp

@@ -7,6 +7,7 @@
 #include "extend/image-model.hpp"
 #include "extend/dropdown-model.hpp"
 #include "extend/pagination-model.hpp"
+#include "services/clipboard/clipboard-content.hpp"
 
 struct ListItemViewModel {
   bool changed = false;
@@ -18,6 +19,7 @@ struct ListItemViewModel {
   std::optional<ActionPannelModel> actionPannel;
   std::vector<AccessoryModel> accessories;
   std::vector<std::string> keywords;
+  std::optional<Clipboard::Content> dragContent;
 };
 
 struct ListSectionModel {

src/server/src/extend/model-deser.cpp

@@ -297,13 +297,20 @@ template <> struct glz::meta<ListItemChild> {
   static constexpr auto ids = std::array{"action-panel", "list-item-detail"};
 };
 
+struct ClipboardContentWire {
+  std::optional<std::string> text;
+  std::optional<std::string> html;
+  std::vector<std::string> urls;
+};
+
 struct ListItemViewModelWire {
   std::string id;
   FlexString title;
   FlexString subtitle;
   std::optional<ImageWrappedWire> icon;
   std::vector<AccessoryWire> accessories;
   std::vector<std::string> keywords;
+  std::optional<ClipboardContentWire> dragContent;
   std::vector<ListItemChild> children;
 };
 
@@ -357,6 +364,7 @@ struct GridItemViewModelWire {
   GridContentWire content;
   std::optional<std::string> tooltip;
   std::vector<std::string> keywords;
+  std::optional<ClipboardContentWire> dragContent;
   std::vector<SingleAPChild> children;
 };
 
@@ -769,6 +777,24 @@ static EmptyViewModel toEmptyViewModel(EmptyViewModelWire w) {
   return m;
 }
 
+static std::optional<Clipboard::Content> toClipboardContent(std::optional<ClipboardContentWire> wire) {
+  if (!wire) return std::nullopt;
+  if (wire->html) {
+    return Clipboard::Html{QString::fromStdString(std::move(*wire->html)),
+                           wire->text ? std::optional(QString::fromStdString(std::move(*wire->text)))
+                                      : std::nullopt};
+  }
+  if (!wire->urls.empty()) {
+    std::vector<QUrl> urls;
+    urls.reserve(wire->urls.size());
+    for (auto &url : wire->urls)
+      urls.emplace_back(QString::fromStdString(std::move(url)));
+    return Clipboard::Urls{std::move(urls)};
+  }
+  if (wire->text) return Clipboard::Text{QString::fromStdString(std::move(*wire->text))};
+  return std::nullopt;
+}
+
 static ListItemViewModel toListItemViewModel(ListItemViewModelWire w) {
   ListItemViewModel m;
   m.changed = true;
@@ -780,6 +806,7 @@ static ListItemViewModel toListItemViewModel(ListItemViewModelWire w) {
   for (auto &a : w.accessories)
     m.accessories.emplace_back(toAccessoryModel(std::move(a)));
   m.keywords = std::move(w.keywords);
+  m.dragContent = toClipboardContent(std::move(w.dragContent));
   for (auto &child : w.children) {
     match(
         child, [&](ActionPannelModelWire &c) { m.actionPannel = toActionPannelModel(std::move(c)); },
@@ -846,6 +873,7 @@ static GridItemViewModel toGridItemViewModel(GridItemViewModelWire w) {
   m.tooltip = std::move(w.tooltip);
   m.content = toGridContent(std::move(w.content), m.tooltip);
   m.keywords = std::move(w.keywords);
+  m.dragContent = toClipboardContent(std::move(w.dragContent));
   for (auto &child : w.children) {
     if (auto *ap = std::get_if<ActionPannelModelWire>(&child))
       m.actionPannel = toActionPannelModel(std::move(*ap));

src/server/src/extension/services/clipboard-service.hpp

@@ -31,15 +31,30 @@ class ExtClipboardService : public tsapi::AbstractClipboard {
 
     result.text = rc.text.toStdString();
     if (rc.html) result.html = rc.html->toStdString();
-    if (rc.file) result.path = rc.file->toStdString();
+    if (!rc.urls.empty()) {
+      result.urls.emplace();
+      result.urls->reserve(rc.urls.size());
+      for (const auto &url : rc.urls)
+        result.urls->emplace_back(url.toString().toStdString());
+    }
 
     return tsapi::Result<tsapi::ClipboardContent>::ok(std::move(result));
   }
 
 private:
   static Clipboard::Content parseContent(const tsapi::ClipboardContent &content) {
-    if (content.html) return Clipboard::Html({QString::fromStdString(*content.html)});
-    if (content.path) return Clipboard::File(std::string{*content.path});
+    if (content.html) {
+      return Clipboard::Html{.html = QString::fromStdString(*content.html),
+                             .text = content.text ? std::optional(QString::fromStdString(*content.text))
+                                                  : std::nullopt};
+    }
+    if (content.urls && !content.urls->empty()) {
+      std::vector<QUrl> urls;
+      urls.reserve(content.urls->size());
+      for (const auto &url : *content.urls)
+        urls.emplace_back(QString::fromStdString(url));
+      return Clipboard::Urls{std::move(urls)};
+    }
     if (content.text) return Clipboard::Text(QString::fromStdString(*content.text));
     return {};
   }

src/server/src/qml/drag-utils.cpp

@@ -0,0 +1,33 @@
+#include <QDrag>
+#include <QGuiApplication>
+#include <QPixmap>
+#include <utility>
+
+#include "drag-utils.hpp"
+#include "ui/image/image-renderer.hpp"
+#include "ui/image/url.hpp"
+
+namespace DragUtils {
+
+void startDrag(QObject *source, std::unique_ptr<QMimeData> mimeData, const QString &iconSource) {
+  if (!source || !mimeData) return;
+
+  auto *drag = new QDrag(source);
+  drag->setMimeData(mimeData.release());
+
+  if (auto frame = ImageRendering::cachedFrame(ImageURL(iconSource))) {
+    constexpr int DRAG_ICON_SIZE = 40;
+    auto const dpr = qGuiApp->devicePixelRatio();
+    auto const physicalSize = qRound(DRAG_ICON_SIZE * dpr);
+    auto image = frame->scaled(physicalSize, physicalSize, Qt::KeepAspectRatio, Qt::SmoothTransformation);
+    auto pixmap = QPixmap::fromImage(std::move(image));
+    pixmap.setDevicePixelRatio(dpr);
+    drag->setPixmap(pixmap);
+    drag->setHotSpot({DRAG_ICON_SIZE / 2, DRAG_ICON_SIZE / 2});
+  }
+
+  drag->exec(Qt::CopyAction);
+  drag->deleteLater();
+}
+
+} // namespace DragUtils

src/server/src/qml/drag-utils.hpp

@@ -0,0 +1,13 @@
+#pragma once
+#include <QMimeData>
+
+#include <memory>
+
+class QObject;
+class QString;
+
+namespace DragUtils {
+
+void startDrag(QObject *source, std::unique_ptr<QMimeData> mimeData, const QString &iconSource);
+
+}

src/server/src/qml/extension-grid-model.cpp

@@ -3,6 +3,7 @@
 #include <utility>
 #include "common/types.hpp"
 #include "fuzzy/fuzzy-searchable.hpp"
+#include "services/clipboard/clipboard-mime.hpp"
 #include "theme.hpp"
 #include "theme/theme-file.hpp"
 #include "ui/image/url.hpp"
@@ -59,6 +60,24 @@ const GridItemViewModel *ExtensionGridSection::itemAt(int i) const {
   return &m_items[i];
 }
 
+QString ExtensionGridSection::itemIconSource(int i) const {
+  if (auto *item = itemAt(i)) {
+    if (auto *image = std::get_if<ImageLikeModel>(&item->content))
+      return qml::imageSourceFor(ImageURL(*image));
+  }
+  return {};
+}
+
+bool ExtensionGridSection::isDraggable(int i) const {
+  auto *item = itemAt(i);
+  return item && item->dragContent.has_value();
+}
+
+std::unique_ptr<QMimeData> ExtensionGridSection::dragMimeData(int i) const {
+  auto *item = itemAt(i);
+  return item && item->dragContent ? Clipboard::mimeDataForContent(*item->dragContent) : nullptr;
+}
+
 std::unique_ptr<ActionPanelState> ExtensionGridSection::actionPanel(int i) const {
   if (auto *it = itemAt(i); it && it->actionPannel) {
     return ExtensionActionPanelBuilder::build(*it->actionPannel, m_notify,

src/server/src/qml/extension-grid-model.hpp

@@ -32,6 +32,9 @@ class ExtensionGridSection : public GridSource {
   const GridItemViewModel *itemAt(int i) const;
 
   std::unique_ptr<ActionPanelState> actionPanel(int i) const override;
+  QString itemIconSource(int i) const override;
+  bool isDraggable(int i) const override;
+  std::unique_ptr<QMimeData> dragMimeData(int i) const override;
 
 private:
   std::string m_name;