Add imageSourceSize property to QQuickDrag

Currently we can only assign an image URL to QQuickDrag to represent
the data during the drag and drop operation. We made it easier to
load arbitrary images in ac78bf7074c4aa2414b4da38db5b574bec9e4b71 :
it does not have to come from Item.grabToImage(). But the image size
depended only on the image provider's default behavior. Now we give
developers the ability to set a preferred image size when needed.

The revision of this new property and its signal is omitted because
of QTBUG-33179.

[ChangeLog][Qt Quick][Drag] The attaching type Drag has a new
imageSourceSize property, which can be used like Image.sourceSize to
scale the drag image during loading.

Fixes: QTBUG-122705
Task-number: QTBUG-120489
Task-number: QTBUG-33179
Change-Id: I92996b8f70b7ca1c9ab783d7ed9f21649d512ab9
Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>

3 files changed, 100 insertions, 1 deletions

diff --git a/tests/auto/quick/qquickdragattached/CMakeLists.txt b/tests/auto/quick/qquickdragattached/CMakeLists.txt
index 4ef06f5197..822e38861e 100644
--- a/tests/auto/quick/qquickdragattached/CMakeLists.txt
+++ b/tests/auto/quick/qquickdragattached/CMakeLists.txt
@@ -4,6 +4,12 @@ if(NOT QT_BUILD_STANDALONE_TESTS AND NOT QT_BUILDING_QT)
     find_package(Qt6BuildInternals REQUIRED COMPONENTS STANDALONE_TEST)
 endif()
 
+# Collect test data
+file(GLOB_RECURSE test_data_glob
+    RELATIVE ${CMAKE_CURRENT_SOURCE_DIR}
+    data/*)
+list(APPEND test_data ${test_data_glob})
+
 qt_internal_add_test(tst_qquickdragattached
     SOURCES
         tst_qquickdragattached.cpp
@@ -14,4 +20,19 @@ qt_internal_add_test(tst_qquickdragattached
         Qt::Network
         Qt::QmlPrivate
         Qt::QuickPrivate
+        Qt::QuickTestUtilsPrivate
+    TESTDATA ${test_data}
+)
+
+## Scopes:
+#####################################################################
+
+qt_internal_extend_target(tst_qquickdragattached CONDITION ANDROID OR IOS
+    DEFINES
+        QT_QMLTEST_DATADIR=":/data"
+)
+
+qt_internal_extend_target(tst_qquickdragattached CONDITION NOT ANDROID AND NOT IOS
+    DEFINES
+        QT_QMLTEST_DATADIR="${CMAKE_CURRENT_SOURCE_DIR}/data"
 )
diff --git a/tests/auto/quick/qquickdragattached/data/qt_logo.svg b/tests/auto/quick/qquickdragattached/data/qt_logo.svg
new file mode 100644
index 0000000000..062daff3e9
--- /dev/null
+++ b/tests/auto/quick/qquickdragattached/data/qt_logo.svg
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+        xmlns="http://www.w3.org/2000/svg"
+        width="462pt"
+        height="339pt"
+        viewBox="0 0 462 339"
+        version="1.1"
+        id="svg2"
+>
+    <path
+            fill="#41cd52"
+            d=" M 63.50 0.00 L 462.00 0.00 L 462.00 274.79 C 440.60 296.26 419.13 317.66 397.61 339.00 L 0.00 339.00 L 0.00 63.39 C 21.08 42.18 42.34 21.13 63.50 0.00 Z"
+            id="path6"/>
+    <path
+            d=" M 122.37 71.33 C 137.50 61.32 156.21 58.79 174.00 58.95 C 190.94 59.16 208.72 62.13 222.76 72.24 C 232.96 79.41 239.59 90.48 244.01 101.93 C 251.16 120.73 253.26 141.03 253.50 161.01 C 253.53 181.13 252.62 201.69 245.96 220.86 C 241.50 233.90 233.01 245.48 221.81 253.52 C 229.87 266.58 238.09 279.54 246.15 292.60 C 236.02 297.27 225.92 301.97 215.78 306.62 C 207.15 292.38 198.56 278.11 189.90 263.89 C 178.19 265.81 166.21 265.66 154.44 264.36 C 140.34 262.67 125.97 258.37 115.09 248.88 C 106.73 241.64 101.48 231.51 97.89 221.21 C 92.01 203.79 90.43 185.25 90.16 166.97 C 90.02 147.21 91.28 127.14 97.24 108.18 C 101.85 93.92 109.48 79.69 122.37 71.33 Z"
+            id="path8"
+            fill="#ffffff"/>
+    <path
+            d=" M 294.13 70.69 C 304.73 70.68 315.33 70.68 325.93 70.69 C 325.96 84.71 325.92 98.72 325.95 112.74 C 339.50 112.76 353.05 112.74 366.60 112.75 C 366.37 121.85 366.12 130.95 365.86 140.05 C 352.32 140.08 338.79 140.04 325.25 140.07 C 325.28 163.05 325.18 186.03 325.30 209.01 C 325.56 215.30 325.42 221.94 328.19 227.75 C 330.21 232.23 335.65 233.38 340.08 233.53 C 348.43 233.50 356.77 233.01 365.12 232.86 C 365.63 241.22 366.12 249.59 366.60 257.95 C 349.99 260.74 332.56 264.08 316.06 258.86 C 309.11 256.80 302.63 252.19 299.81 245.32 C 294.76 233.63 294.35 220.62 294.13 208.07 C 294.11 185.40 294.13 162.74 294.12 140.07 C 286.73 140.05 279.34 140.08 271.95 140.05 C 271.93 130.96 271.93 121.86 271.95 112.76 C 279.34 112.73 286.72 112.77 294.11 112.74 C 294.14 98.72 294.10 84.71 294.13 70.69 Z"
+            id="path10"
+            fill="#ffffff"/>
+    <path
+            fill="#41cd52"
+            d=" M 160.51 87.70 C 170.80 86.36 181.60 86.72 191.34 90.61 C 199.23 93.73 205.93 99.84 209.47 107.58 C 214.90 119.31 216.98 132.26 218.03 145.05 C 219.17 162.07 219.01 179.25 216.66 196.17 C 215.01 206.24 212.66 216.85 205.84 224.79 C 198.92 232.76 188.25 236.18 178.01 236.98 C 167.21 237.77 155.82 236.98 146.07 231.87 C 140.38 228.84 135.55 224.09 132.73 218.27 C 129.31 211.30 127.43 203.69 126.11 196.07 C 122.13 171.91 121.17 146.91 126.61 122.89 C 128.85 113.83 132.11 104.53 138.73 97.70 C 144.49 91.85 152.51 88.83 160.51 87.70 Z"
+            id="path12"/>
+</svg>
diff --git a/tests/auto/quick/qquickdragattached/tst_qquickdragattached.cpp b/tests/auto/quick/qquickdragattached/tst_qquickdragattached.cpp
index 5ce72a747f..6132fbf6b3 100644
--- a/tests/auto/quick/qquickdragattached/tst_qquickdragattached.cpp
+++ b/tests/auto/quick/qquickdragattached/tst_qquickdragattached.cpp
@@ -6,17 +6,30 @@
 #include <QtQuick/qquickwindow.h>
 #include <QtQuick/private/qquickdrag_p_p.h>
 
-class tst_QQuickDragAttached: public QObject
+#include <QtQuickTestUtils/private/qmlutils_p.h>
+
+class tst_QQuickDragAttached: public QQmlDataTest
 {
     Q_OBJECT
+public:
+    tst_QQuickDragAttached();
+
 private slots:
     void setMimeData_data();
     void setMimeData();
 
+    void imageSourceSize_data();
+    void imageSourceSize();
+
     void startDrag_data();
     void startDrag();
 };
 
+tst_QQuickDragAttached::tst_QQuickDragAttached()
+    : QQmlDataTest(QT_QMLTEST_DATADIR)
+{
+}
+
 void tst_QQuickDragAttached::setMimeData_data()
 {
     QTest::addColumn<QVariantMap>("mimeData");
@@ -91,6 +104,45 @@ void tst_QQuickDragAttached::setMimeData()
     QCOMPARE(spy.count(), expectedCount);
 }
 
+void tst_QQuickDragAttached::imageSourceSize_data()
+{
+    QTest::addColumn<bool>("sizeFirst");
+    QTest::addColumn<QSize>("imageSourceSize");
+    QTest::addColumn<QSize>("expectedSourceSize");
+    QTest::addColumn<QSize>("expectedImageSize");
+
+    QTest::addRow("default size") << false << QSize() << QSize(462, 339) << QSize(462, 339);
+    QTest::addRow("shrunken elongated") << false << QSize(214, 114) << QSize(214, 114) << QSize(214, 114);
+    QTest::addRow("width, neg height") << false << QSize(154, -1) << QSize(154, 339) << QSize(154, 339);
+    QTest::addRow("width, zero height") << false << QSize(154, 0) << QSize(154, 0) << QSize(154, 113);
+
+    QTest::addRow("size first: default size") << true << QSize() << QSize(462, 339) << QSize(462, 339);
+    QTest::addRow("size first: shrunken elongated") << true << QSize(214, 114) << QSize(214, 114) << QSize(214, 114);
+    QTest::addRow("size first: width, neg height") << true << QSize(154, -1) << QSize(154, 113) << QSize(154, 113);
+    QTest::addRow("size first: width, zero height") << true << QSize(154, 0) << QSize(154, 0) << QSize(154, 113);
+}
+
+void tst_QQuickDragAttached::imageSourceSize()
+{
+    QFETCH(bool, sizeFirst);
+    QFETCH(QSize, imageSourceSize);
+    QFETCH(QSize, expectedSourceSize);
+    QFETCH(QSize, expectedImageSize);
+
+    QQuickDragAttached attached(nullptr);
+    QSignalSpy spy(&attached, &QQuickDragAttached::imageSourceSizeChanged);
+
+    if (sizeFirst)
+        attached.setImageSourceSize(imageSourceSize);
+    attached.setImageSource(testFileUrl("qt_logo.svg"));
+    attached.setImageSourceSize(imageSourceSize);
+
+    const int expectedCount = imageSourceSize.width() >= 0 || imageSourceSize.height() >= 0 ? 1 : 0;
+    QCOMPARE(spy.count(), expectedCount);
+    QCOMPARE(attached.imageSourceSize(), expectedSourceSize);
+    QCOMPARE(QQuickDragAttachedPrivate::get(&attached)->pixmapLoader.image().size(), expectedImageSize);
+}
+
 void tst_QQuickDragAttached::startDrag_data()
 {
     setMimeData_data();