QQuickControl: implement focus handling on touch

QQuickControl::focusPolicy was only managed in mousePressEvent() and
mouseReleaseEvent(). All controls call the base class implementations
of these event handlers to get the focus policy handling "for free".
Move focus policy handling to handlePress() and handleRelease() that
can be re-used for touch events, and make sure that various controls
call the base class implementation of touch event handlers.

There's still a bit of duplication in QQuickControl::touchEvent() and
the overridden handlers in sub-classes, but this will be improved step
by step. QQuickControlPrivate::handlePress/Move/Release/Ungrab() are
planned to be made virtual, overridden in subclasses, and only called
from QQuickControl event handlers. Most mouse and touch event handlers
in QQuickControl subclasses can be removed later when we get there.

Task-number: QTBUG-58389
Change-Id: I7e82dc2ef49762a005c482ce1353e03cc841659f
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>

11 files changed, 119 insertions, 41 deletions

diff --git a/src/quicktemplates2/qquickabstractbutton.cpp b/src/quicktemplates2/qquickabstractbutton.cpp
index 7c2ced6652..de95457079 100644
--- a/src/quicktemplates2/qquickabstractbutton.cpp
+++ b/src/quicktemplates2/qquickabstractbutton.cpp
@@ -121,7 +121,6 @@ QQuickAbstractButtonPrivate::QQuickAbstractButtonPrivate()
       autoExclusive(false),
       autoRepeat(false),
       wasHeld(false),
-      touchId(-1),
       holdTimer(0),
       delayTimer(0),
       repeatTimer(0),
@@ -165,7 +164,6 @@ void QQuickAbstractButtonPrivate::handleRelease(const QPointF &point)
     Q_Q(QQuickAbstractButton);
     bool wasPressed = pressed;
     q->setPressed(false);
-    touchId = -1;
 
     if (!wasHeld && (keepPressed || q->contains(point)))
         q->nextCheckState();
@@ -191,7 +189,6 @@ void QQuickAbstractButtonPrivate::handleCancel()
         return;
 
     q->setPressed(false);
-    touchId = -1;
     stopPressRepeat();
     stopPressAndHold();
     emit q->canceled();
@@ -579,7 +576,8 @@ void QQuickAbstractButton::focusOutEvent(QFocusEvent *event)
 {
     Q_D(QQuickAbstractButton);
     QQuickControl::focusOutEvent(event);
-    d->handleCancel();
+    if (d->touchId == -1) // don't ungrab on multi-touch if another control gets focused
+        d->handleCancel();
 }
 
 void QQuickAbstractButton::keyPressEvent(QKeyEvent *event)
@@ -713,9 +711,10 @@ void QQuickAbstractButton::touchEvent(QTouchEvent *event)
         break;
 
     default:
-        QQuickControl::touchEvent(event);
         break;
     }
+
+    QQuickControl::touchEvent(event);
 }
 
 void QQuickAbstractButton::touchUngrabEvent()
diff --git a/src/quicktemplates2/qquickabstractbutton_p_p.h b/src/quicktemplates2/qquickabstractbutton_p_p.h
index e27f5c82bf..6d149b4f94 100644
--- a/src/quicktemplates2/qquickabstractbutton_p_p.h
+++ b/src/quicktemplates2/qquickabstractbutton_p_p.h
@@ -95,7 +95,6 @@ public:
     bool autoExclusive;
     bool autoRepeat;
     bool wasHeld;
-    int touchId;
     int holdTimer;
     int delayTimer;
     int repeatTimer;
diff --git a/src/quicktemplates2/qquickcombobox.cpp b/src/quicktemplates2/qquickcombobox.cpp
index 09a5eede2a..5c763d21f7 100644
--- a/src/quicktemplates2/qquickcombobox.cpp
+++ b/src/quicktemplates2/qquickcombobox.cpp
@@ -257,7 +257,6 @@ public:
     bool hasCurrentIndex;
     int highlightedIndex;
     int currentIndex;
-    int touchId;
     QVariant model;
     QString textRole;
     QString currentText;
@@ -296,7 +295,6 @@ QQuickComboBoxPrivate::QQuickComboBoxPrivate()
       hasCurrentIndex(false),
       highlightedIndex(-1),
       currentIndex(-1),
-      touchId(-1),
       delegateModel(nullptr),
       delegate(nullptr),
       indicator(nullptr),
@@ -648,14 +646,12 @@ void QQuickComboBoxPrivate::handleRelease(const QPointF &)
         q->setPressed(false);
         togglePopup(false);
     }
-    touchId = -1;
 }
 
 void QQuickComboBoxPrivate::handleUngrab()
 {
     Q_Q(QQuickComboBox);
     q->setPressed(false);
-    touchId = -1;
 }
 
 QQuickComboBox::QQuickComboBox(QQuickItem *parent)
@@ -1580,9 +1576,10 @@ void QQuickComboBox::touchEvent(QTouchEvent *event)
         break;
 
     default:
-        QQuickControl::touchEvent(event);
         break;
     }
+
+    QQuickControl::touchEvent(event);
 }
 
 void QQuickComboBox::touchUngrabEvent()
diff --git a/src/quicktemplates2/qquickcontrol.cpp b/src/quicktemplates2/qquickcontrol.cpp
index eb66f3136e..b086f3eea9 100644
--- a/src/quicktemplates2/qquickcontrol.cpp
+++ b/src/quicktemplates2/qquickcontrol.cpp
@@ -120,6 +120,7 @@ QQuickControlPrivate::QQuickControlPrivate()
       hovered(false),
       explicitHoverEnabled(false),
 #endif
+      touchId(-1),
       padding(0),
       topPadding(0),
       leftPadding(0),
@@ -144,6 +145,36 @@ QQuickControlPrivate::~QQuickControlPrivate()
 #endif
 }
 
+void QQuickControlPrivate::handlePress(const QPointF &)
+{
+    Q_Q(QQuickControl);
+    if ((focusPolicy & Qt::ClickFocus) == Qt::ClickFocus && !QGuiApplication::styleHints()->setFocusOnTouchRelease())
+        q->forceActiveFocus(Qt::MouseFocusReason);
+}
+
+void QQuickControlPrivate::handleMove(const QPointF &point)
+{
+#if QT_CONFIG(quicktemplates2_hover)
+    Q_Q(QQuickControl);
+    q->setHovered(hoverEnabled && q->contains(point));
+#else
+    Q_UNUSED(point);
+#endif
+}
+
+void QQuickControlPrivate::handleRelease(const QPointF &)
+{
+    Q_Q(QQuickControl);
+    if ((focusPolicy & Qt::ClickFocus) == Qt::ClickFocus && QGuiApplication::styleHints()->setFocusOnTouchRelease())
+        q->forceActiveFocus(Qt::MouseFocusReason);
+    touchId = -1;
+}
+
+void QQuickControlPrivate::handleUngrab()
+{
+    touchId = -1;
+}
+
 void QQuickControlPrivate::mirrorChange()
 {
     Q_Q(QQuickControl);
@@ -1287,30 +1318,85 @@ void QQuickControl::hoverLeaveEvent(QHoverEvent *event)
 void QQuickControl::mousePressEvent(QMouseEvent *event)
 {
     Q_D(QQuickControl);
-    if ((d->focusPolicy & Qt::ClickFocus) == Qt::ClickFocus && !QGuiApplication::styleHints()->setFocusOnTouchRelease())
-        forceActiveFocus(Qt::MouseFocusReason);
-
+    d->handlePress(event->localPos());
     event->accept();
 }
 
 void QQuickControl::mouseMoveEvent(QMouseEvent *event)
 {
-#if QT_CONFIG(quicktemplates2_hover)
     Q_D(QQuickControl);
-    setHovered(d->hoverEnabled && contains(event->pos()));
-#endif
+    d->handleMove(event->localPos());
     event->accept();
 }
 
 void QQuickControl::mouseReleaseEvent(QMouseEvent *event)
 {
     Q_D(QQuickControl);
-    if ((d->focusPolicy & Qt::ClickFocus) == Qt::ClickFocus && QGuiApplication::styleHints()->setFocusOnTouchRelease())
-        forceActiveFocus(Qt::MouseFocusReason);
-
+    d->handleRelease(event->localPos());
     event->accept();
 }
 
+void QQuickControl::mouseUngrabEvent()
+{
+    Q_D(QQuickControl);
+    d->handleUngrab();
+}
+
+void QQuickControl::touchEvent(QTouchEvent *event)
+{
+    Q_D(QQuickControl);
+    switch (event->type()) {
+    case QEvent::TouchBegin:
+        for (const QTouchEvent::TouchPoint &point : event->touchPoints()) {
+            if (point.id() == d->touchId)
+                d->handlePress(point.pos());
+        }
+        break;
+
+    case QEvent::TouchUpdate:
+        for (const QTouchEvent::TouchPoint &point : event->touchPoints()) {
+            if (point.id() != d->touchId)
+                continue;
+
+            switch (point.state()) {
+            case Qt::TouchPointPressed:
+                d->handlePress(point.pos());
+                break;
+            case Qt::TouchPointMoved:
+                d->handleMove(point.pos());
+                break;
+            case Qt::TouchPointReleased:
+                d->handleRelease(point.pos());
+                break;
+            default:
+                break;
+            }
+        }
+        break;
+
+    case QEvent::TouchEnd:
+        for (const QTouchEvent::TouchPoint &point : event->touchPoints()) {
+            if (point.id() == d->touchId)
+                d->handleRelease(point.pos());
+        }
+        break;
+
+    case QEvent::TouchCancel:
+        d->handleUngrab();
+        break;
+
+    default:
+        QQuickItem::touchEvent(event);
+        break;
+    }
+}
+
+void QQuickControl::touchUngrabEvent()
+{
+    Q_D(QQuickControl);
+    d->handleUngrab();
+}
+
 #if QT_CONFIG(wheelevent)
 void QQuickControl::wheelEvent(QWheelEvent *event)
 {
diff --git a/src/quicktemplates2/qquickcontrol_p.h b/src/quicktemplates2/qquickcontrol_p.h
index a94ef01da2..6ad8937673 100644
--- a/src/quicktemplates2/qquickcontrol_p.h
+++ b/src/quicktemplates2/qquickcontrol_p.h
@@ -184,6 +184,9 @@ protected:
     void mousePressEvent(QMouseEvent *event) override;
     void mouseMoveEvent(QMouseEvent *event) override;
     void mouseReleaseEvent(QMouseEvent *event) override;
+    void mouseUngrabEvent() override;
+    void touchEvent(QTouchEvent *event) override;
+    void touchUngrabEvent() override;
 #if QT_CONFIG(wheelevent)
     void wheelEvent(QWheelEvent *event) override;
 #endif
diff --git a/src/quicktemplates2/qquickcontrol_p_p.h b/src/quicktemplates2/qquickcontrol_p_p.h
index 14a468f3e1..2c79c88780 100644
--- a/src/quicktemplates2/qquickcontrol_p_p.h
+++ b/src/quicktemplates2/qquickcontrol_p_p.h
@@ -78,6 +78,11 @@ public:
         return control->d_func();
     }
 
+    void handlePress(const QPointF &point);
+    void handleMove(const QPointF &point);
+    void handleRelease(const QPointF &point);
+    void handleUngrab();
+
     void mirrorChange() override;
 
     void setTopPadding(qreal value, bool reset = false);
@@ -136,6 +141,7 @@ public:
     bool hovered;
     bool explicitHoverEnabled;
 #endif
+    int touchId;
     qreal padding;
     qreal topPadding;
     qreal leftPadding;
diff --git a/src/quicktemplates2/qquickdial.cpp b/src/quicktemplates2/qquickdial.cpp
index 5b98992b59..285dda4955 100644
--- a/src/quicktemplates2/qquickdial.cpp
+++ b/src/quicktemplates2/qquickdial.cpp
@@ -96,8 +96,7 @@ class QQuickDialPrivate : public QQuickControlPrivate
 
 public:
     QQuickDialPrivate()
-        : touchId(-1),
-          from(0),
+        : from(0),
           to(1),
           value(0),
           position(0),
@@ -123,7 +122,6 @@ public:
     void handleRelease(const QPointF &point);
     void handleUngrab();
 
-    int touchId;
     qreal from;
     qreal to;
     qreal value;
@@ -242,14 +240,12 @@ void QQuickDialPrivate::handleRelease(const QPointF &point)
 
     q->setPressed(false);
     pressPoint = QPointF();
-    touchId = -1;
 }
 
 void QQuickDialPrivate::handleUngrab()
 {
     Q_Q(QQuickDial);
     pressPoint = QPointF();
-    touchId = -1;
     q->setPressed(false);
 }
 
@@ -729,9 +725,10 @@ void QQuickDial::touchEvent(QTouchEvent *event)
         break;
 
     default:
-        QQuickControl::touchEvent(event);
         break;
     }
+
+    QQuickControl::touchEvent(event);
 }
 
 void QQuickDial::touchUngrabEvent()
diff --git a/src/quicktemplates2/qquickscrollbar.cpp b/src/quicktemplates2/qquickscrollbar.cpp
index b0d55dfbe3..be97f07150 100644
--- a/src/quicktemplates2/qquickscrollbar.cpp
+++ b/src/quicktemplates2/qquickscrollbar.cpp
@@ -165,7 +165,6 @@ QQuickScrollBarPrivate::QQuickScrollBarPrivate()
       moving(false),
       interactive(true),
       explicitInteractive(false),
-      touchId(-1),
       orientation(Qt::Vertical),
       snapMode(QQuickScrollBar::NoSnap),
       policy(QQuickScrollBar::AsNeeded)
@@ -269,7 +268,6 @@ void QQuickScrollBarPrivate::handleRelease(const QPointF &point)
         pos = snapPosition(pos);
     q->setPosition(pos);
     offset = 0.0;
-    touchId = -1;
     q->setPressed(false);
 }
 
@@ -277,7 +275,6 @@ void QQuickScrollBarPrivate::handleUngrab()
 {
     Q_Q(QQuickScrollBar);
     offset = 0.0;
-    touchId = -1;
     q->setPressed(false);
 }
 
@@ -657,9 +654,10 @@ void QQuickScrollBar::touchEvent(QTouchEvent *event)
         break;
 
     default:
-        QQuickControl::touchEvent(event);
         break;
     }
+
+    QQuickControl::touchEvent(event);
 }
 
 void QQuickScrollBar::touchUngrabEvent()
diff --git a/src/quicktemplates2/qquickscrollbar_p_p.h b/src/quicktemplates2/qquickscrollbar_p_p.h
index 409b952b0c..cbbef2c861 100644
--- a/src/quicktemplates2/qquickscrollbar_p_p.h
+++ b/src/quicktemplates2/qquickscrollbar_p_p.h
@@ -88,7 +88,6 @@ public:
     bool moving;
     bool interactive;
     bool explicitInteractive;
-    int touchId;
     Qt::Orientation orientation;
     QQuickScrollBar::SnapMode snapMode;
     QQuickScrollBar::Policy policy;
diff --git a/src/quicktemplates2/qquickslider.cpp b/src/quicktemplates2/qquickslider.cpp
index 77e5856c88..ef074c7380 100644
--- a/src/quicktemplates2/qquickslider.cpp
+++ b/src/quicktemplates2/qquickslider.cpp
@@ -96,7 +96,6 @@ public:
           stepSize(0),
           live(true),
           pressed(false),
-          touchId(-1),
           orientation(Qt::Horizontal),
           snapMode(QQuickSlider::NoSnap),
           handle(nullptr)
@@ -120,7 +119,6 @@ public:
     qreal stepSize;
     bool live;
     bool pressed;
-    int touchId;
     QPointF pressPoint;
     Qt::Orientation orientation;
     QQuickSlider::SnapMode snapMode;
@@ -209,7 +207,6 @@ void QQuickSliderPrivate::handleMove(const QPointF &point)
 void QQuickSliderPrivate::handleRelease(const QPointF &point)
 {
     Q_Q(QQuickSlider);
-    touchId = -1;
     pressPoint = QPointF();
     const qreal oldPos = position;
     qreal pos = positionAt(point);
@@ -230,7 +227,6 @@ void QQuickSliderPrivate::handleRelease(const QPointF &point)
 void QQuickSliderPrivate::handleUngrab()
 {
     Q_Q(QQuickSlider);
-    touchId = -1;
     pressPoint = QPointF();
     q->setPressed(false);
 }
@@ -693,9 +689,10 @@ void QQuickSlider::touchEvent(QTouchEvent *event)
         break;
 
     default:
-        QQuickControl::touchEvent(event);
         break;
     }
+
+    QQuickControl::touchEvent(event);
 }
 
 void QQuickSlider::touchUngrabEvent()
diff --git a/src/quicktemplates2/qquickspinbox.cpp b/src/quicktemplates2/qquickspinbox.cpp
index b70366eac1..9558cfc5e7 100644
--- a/src/quicktemplates2/qquickspinbox.cpp
+++ b/src/quicktemplates2/qquickspinbox.cpp
@@ -114,7 +114,6 @@ public:
           stepSize(1),
           delayTimer(0),
           repeatTimer(0),
-          touchId(-1),
           up(nullptr),
           down(nullptr),
           validator(nullptr),
@@ -150,7 +149,6 @@ public:
     int stepSize;
     int delayTimer;
     int repeatTimer;
-    int touchId;
     QQuickSpinButton *up;
     QQuickSpinButton *down;
     QValidator *validator;
@@ -323,7 +321,6 @@ bool QQuickSpinBoxPrivate::handleRelease(const QPointF &point)
     if (value != oldValue)
         emit q->valueModified();
 
-    touchId = -1;
     q->setAccessibleProperty("pressed", false);
     stopPressRepeat();
     return wasPressed;
@@ -335,7 +332,6 @@ bool QQuickSpinBoxPrivate::handleUngrab()
     up->setPressed(false);
     down->setPressed(false);
 
-    touchId = -1;
     q->setAccessibleProperty("pressed", false);
     stopPressRepeat();
     return false;
@@ -870,9 +866,10 @@ void QQuickSpinBox::touchEvent(QTouchEvent *event)
         break;
 
     default:
-        QQuickControl::touchEvent(event);
         break;
     }
+
+    QQuickControl::touchEvent(event);
 }
 
 void QQuickSpinBox::touchUngrabEvent()