When stealing a touchpoint as synth. mouse, ungrab touch

If you use MultiPointTouchArea to make a button component, or if you
do something similar by subclassing QQuickItem and handling touch events,
and you place such a component inside a Flickable, when the user presses
on the button and then drags far enough that the Flickable steals the grab,
the MPTA or custom item did not receive the touchUngrabEvent() callback.
Now it does, so now the button will go back to released state as a result
of having the grab stolen.

The situation here is special in that it's the only place where a touch
event is transformed to be treated as mouse in the future, usually it's
either treated as touch or mouse from the start.
When this happens, it's not enough to call setMouseGrabber because that
doesn't send touch cancel to the previous grabber. Instead we need to
explicitly call touchUngrabEvent to notify the touch handling item.

The explicit setting of the grabber which was there previously is not
needed, since grabMouse will update the grab based on touchMouseId.

tst_QQuickMultiPointTouchArea::inFlickable2 was already testing the
pressed state of the touchpoint when the grab is stolen, but it was
changed in 468626e99a90d6ac21cb311cde05c658ccb3b781; now that can be
restored, and we can also un-blacklist inFlickable, which was deemed
unstable in 6d163779711d4601931ae0f82910794fb2498136

[ChangeLog][QtQuick] MultiPointTouchArea, and any custom Item, will now
properly receive touchUngrabEvent() when the touch grab is stolen by
a filtering parent Item, such as a Flickable.

Task-number: QTBUG-57910
Change-Id: I4e1b23ed099f01e7eca2e8a0e7ab4c652ef00cfa
Reviewed-by: Frederik Gladhorn <frederik.gladhorn@qt.io>
Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>

1 files changed, 72 insertions, 4 deletions

diff --git a/tests/auto/quick/touchmouse/tst_touchmouse.cpp b/tests/auto/quick/touchmouse/tst_touchmouse.cpp
index 032e682137..671cefd6f5 100644
--- a/tests/auto/quick/touchmouse/tst_touchmouse.cpp
+++ b/tests/auto/quick/touchmouse/tst_touchmouse.cpp
@@ -71,7 +71,7 @@ Q_SIGNALS:
 
 public:
     EventItem(QQuickItem *parent = 0)
-        : QQuickItem(parent), acceptMouse(false), acceptTouch(false), filterTouch(false), point0(-1)
+        : QQuickItem(parent), touchUngrabCount(0), acceptMouse(false), acceptTouch(false), filterTouch(false), point0(-1)
     {
         setAcceptedMouseButtons(Qt::LeftButton);
     }
@@ -111,11 +111,17 @@ public:
         eventList.append(Event(QEvent::UngrabMouse, QPoint(0,0), QPoint(0,0)));
     }
 
+    void touchUngrabEvent()
+    {
+        ++touchUngrabCount;
+    }
+
     bool event(QEvent *event) {
         return QQuickItem::event(event);
     }
 
     QList<Event> eventList;
+    int touchUngrabCount;
     bool acceptMouse;
     bool acceptTouch;
     bool filterTouch; // when used as event filter
@@ -158,6 +164,7 @@ private slots:
     void mouseOverTouch();
 
     void buttonOnFlickable();
+    void touchButtonOnFlickable();
     void buttonOnDelayedPressFlickable_data();
     void buttonOnDelayedPressFlickable();
     void buttonOnTouch();
@@ -568,9 +575,10 @@ void tst_TouchMouse::buttonOnFlickable()
     QCOMPARE(pointerEvent->point(0)->grabber(), eventItem1);
     QCOMPARE(window->mouseGrabberItem(), eventItem1);
 
-    p1 += QPoint(0, -10);
-    QPoint p2 = p1 + QPoint(0, -10);
-    QPoint p3 = p2 + QPoint(0, -10);
+    int dragDelta = -qApp->styleHints()->startDragDistance();
+    p1 += QPoint(0, dragDelta);
+    QPoint p2 = p1 + QPoint(0, dragDelta);
+    QPoint p3 = p2 + QPoint(0, dragDelta);
     QQuickTouchUtils::flush(window.data());
     QTest::touchEvent(window.data(), device).move(0, p1, window.data());
     QQuickTouchUtils::flush(window.data());
@@ -593,6 +601,66 @@ void tst_TouchMouse::buttonOnFlickable()
     QQuickTouchUtils::flush(window.data());
 }
 
+void tst_TouchMouse::touchButtonOnFlickable()
+{
+    // flickable - height 500 / 1000
+    //   - eventItem1 y: 100, height 100
+    //   - eventItem2 y: 300, height 100
+
+    QScopedPointer<QQuickView> window(createView());
+    window->setSource(testFileUrl("buttononflickable.qml"));
+    window->show();
+    QQuickViewTestUtil::centerOnScreen(window.data());
+    QVERIFY(QTest::qWaitForWindowActive(window.data()));
+    QVERIFY(window->rootObject() != 0);
+
+    QQuickFlickable *flickable = window->rootObject()->findChild<QQuickFlickable*>("flickable");
+    QVERIFY(flickable);
+
+    EventItem *eventItem2 = window->rootObject()->findChild<EventItem*>("eventItem2");
+    QVERIFY(eventItem2);
+    QCOMPARE(eventItem2->eventList.size(), 0);
+    eventItem2->acceptTouch = true;
+
+    // press via touch, then drag: check that flickable moves and that the button gets ungrabbed
+    QCOMPARE(eventItem2->eventList.size(), 0);
+    QPoint p1 = QPoint(10, 310);
+    QTest::touchEvent(window.data(), device).press(0, p1, window.data());
+    QQuickTouchUtils::flush(window.data());
+    QCOMPARE(eventItem2->eventList.size(), 1);
+    QCOMPARE(eventItem2->eventList.at(0).type, QEvent::TouchBegin);
+
+    QQuickWindowPrivate *windowPriv = QQuickWindowPrivate::get(window.data());
+    QVERIFY(windowPriv->touchMouseId == -1);
+    auto pointerEvent = QQuickPointerDevice::touchDevices().at(0)->pointerEvent();
+    QCOMPARE(pointerEvent->point(0)->grabber(), eventItem2);
+    QCOMPARE(window->mouseGrabberItem(), nullptr);
+
+    int dragDelta = qApp->styleHints()->startDragDistance() * -0.7;
+    p1 += QPoint(0, dragDelta);
+    QPoint p2 = p1 + QPoint(0, dragDelta);
+    QPoint p3 = p2 + QPoint(0, dragDelta);
+
+    QQuickTouchUtils::flush(window.data());
+    QTest::touchEvent(window.data(), device).move(0, p1, window.data());
+    QQuickTouchUtils::flush(window.data());
+    QTest::touchEvent(window.data(), device).move(0, p2, window.data());
+    QQuickTouchUtils::flush(window.data());
+    QTest::touchEvent(window.data(), device).move(0, p3, window.data());
+    QQuickTouchUtils::flush(window.data());
+
+    QVERIFY(eventItem2->eventList.size() > 2);
+    QCOMPARE(eventItem2->eventList.at(1).type, QEvent::TouchUpdate);
+    QCOMPARE(eventItem2->touchUngrabCount, 1);
+    QCOMPARE(window->mouseGrabberItem(), flickable);
+    QVERIFY(windowPriv->touchMouseId != -1);
+    QCOMPARE(pointerEvent->point(0)->grabber(), flickable);
+    QVERIFY(flickable->isMovingVertically());
+
+    QTest::touchEvent(window.data(), device).release(0, p3, window.data());
+    QQuickTouchUtils::flush(window.data());
+}
+
 void tst_TouchMouse::buttonOnDelayedPressFlickable_data()
 {
     QTest::addColumn<bool>("scrollBeforeDelayIsOver");