Improve Mac OS X touch event enabling.

Previously, the Qt Quick touch interaction items would
enable touch events on window change. On app startup
this would typically happen before the platform window
was created, and the call to registerTouchWindow would
then create the platform window.

registerTouchWindow in QtBase has now been changed
to not create the platform window since this has
unwanted side effects. Calling it at window change
time will then have no effect for the initial window
change.

Enable and disable touch events on hoverEnter/Leave
instead. This is similar to what QtWidgets does and
has an additional benefit: touch events can now be
enabled when the mouse cursor is hovering over a touch
item, reducing the chances of it interfering with
scroll events for other items.

Task-number: QTBUG-32988
Change-Id: Ic48dbec910f52299d5068f5ca7508be73cdc6f36
Reviewed-by: Shawn Rutledge <shawn.rutledge@digia.com>

4 files changed, 54 insertions, 49 deletions

diff --git a/src/quick/items/qquickmultipointtoucharea.cpp b/src/quick/items/qquickmultipointtoucharea.cpp
index 8fe306b006..e0eb641528 100644
--- a/src/quick/items/qquickmultipointtoucharea.cpp
+++ b/src/quick/items/qquickmultipointtoucharea.cpp
@@ -323,7 +323,6 @@ void QQuickTouchPoint::setSceneY(qreal sceneY)
 
 QQuickMultiPointTouchArea::QQuickMultiPointTouchArea(QQuickItem *parent)
     : QQuickItem(parent),
-      _currentWindow(0),
       _minimumTouchPoints(0),
       _maximumTouchPoints(INT_MAX),
       _stealMouse(false)
@@ -333,8 +332,8 @@ QQuickMultiPointTouchArea::QQuickMultiPointTouchArea(QQuickItem *parent)
     if (qmlVisualTouchDebugging()) {
         setFlag(QQuickItem::ItemHasContents);
     }
-#ifdef Q_OS_MAC
-    connect(this, &QQuickItem::windowChanged, this, &QQuickMultiPointTouchArea::setTouchEventsEnabledForWindow);
+#ifdef Q_OS_OSX
+    setAcceptHoverEvents(true); // needed to enable touch events on mouse hover.
 #endif
 }
 
@@ -547,28 +546,31 @@ void QQuickMultiPointTouchArea::addTouchPoint(const QTouchEvent::TouchPoint *p)
     _pressedTouchPoints.append(dtp);
 }
 
-void QQuickMultiPointTouchArea::setTouchEventsEnabledForWindow(QWindow *window)
+#ifdef Q_OS_OSX
+void QQuickMultiPointTouchArea::hoverEnterEvent(QHoverEvent *event)
+{
+    Q_UNUSED(event);
+    setTouchEventsEnabled(true);
+}
+
+void QQuickMultiPointTouchArea::hoverLeaveEvent(QHoverEvent *event)
+{
+    Q_UNUSED(event);
+    setTouchEventsEnabled(false);
+}
+
+void QQuickMultiPointTouchArea::setTouchEventsEnabled(bool enable)
 {
-#ifdef Q_OS_MAC
     // Resolve function for enabling touch events from the (cocoa) platform plugin.
     typedef void (*RegisterTouchWindowFunction)(QWindow *, bool);
     RegisterTouchWindowFunction registerTouchWindow = reinterpret_cast<RegisterTouchWindowFunction>(
         QGuiApplication::platformNativeInterface()->nativeResourceFunctionForIntegration("registertouchwindow"));
     if (!registerTouchWindow)
-        return; // Not necessarily an error, Qt migh be using a different platform plugin.
-
-    // Disable touch on the old window, enable on the new window.
-    if (_currentWindow)
-        registerTouchWindow(_currentWindow, false);
-    if (window)
-        registerTouchWindow(window, true);
-    // Save the current window, setTouchEventsEnabledForWindow will be called
-    // with a null window on disable.
-    _currentWindow = window;
-#else // Q_OS_MAC
-    Q_UNUSED(window)
-#endif
+        return; // Not necessarily an error, Qt might be using a different platform plugin.
+
+    registerTouchWindow(window(), enable);
 }
+#endif // Q_OS_OSX
 
 void QQuickMultiPointTouchArea::addTouchPrototype(QQuickTouchPoint *prototype)
 {
diff --git a/src/quick/items/qquickmultipointtoucharea_p.h b/src/quick/items/qquickmultipointtoucharea_p.h
index 2e1f2a98fb..83cc407401 100644
--- a/src/quick/items/qquickmultipointtoucharea_p.h
+++ b/src/quick/items/qquickmultipointtoucharea_p.h
@@ -250,9 +250,11 @@ protected:
     bool shouldFilter(QEvent *event);
     void grabGesture();
     virtual QSGNode *updatePaintNode(QSGNode *, UpdatePaintNodeData *);
-
-protected Q_SLOTS:
-    void setTouchEventsEnabledForWindow(QWindow *window);
+#ifdef Q_OS_OSX
+    void hoverEnterEvent(QHoverEvent *event);
+    void hoverLeaveEvent(QHoverEvent *event);
+    void setTouchEventsEnabled(bool enable);
+#endif
 
 private:
     void ungrab();
@@ -261,7 +263,6 @@ private:
     QList<QObject*> _releasedTouchPoints;
     QList<QObject*> _pressedTouchPoints;
     QList<QObject*> _movedTouchPoints;
-    QWindow *_currentWindow;
     int _minimumTouchPoints;
     int _maximumTouchPoints;
     bool _stealMouse;
diff --git a/src/quick/items/qquickpincharea.cpp b/src/quick/items/qquickpincharea.cpp
index 419792aaa5..f741a08512 100644
--- a/src/quick/items/qquickpincharea.cpp
+++ b/src/quick/items/qquickpincharea.cpp
@@ -248,14 +248,13 @@ QQuickPinchAreaPrivate::~QQuickPinchAreaPrivate()
 
 QQuickPinchArea::QQuickPinchArea(QQuickItem *parent)
   : QQuickItem(*(new QQuickPinchAreaPrivate), parent)
-  , _currentWindow(0)
 {
     Q_D(QQuickPinchArea);
     d->init();
     setAcceptedMouseButtons(Qt::LeftButton);
     setFiltersChildMouseEvents(true);
-#ifdef Q_OS_MAC
-    connect(this, &QQuickItem::windowChanged, this, &QQuickPinchArea::setTouchEventsEnabledForWindow);
+#ifdef Q_OS_OSX
+    setAcceptHoverEvents(true); // needed to enable touch events on mouse hover.
 #endif
 }
 
@@ -537,37 +536,39 @@ void QQuickPinchArea::itemChange(ItemChange change, const ItemChangeData &value)
     QQuickItem::itemChange(change, value);
 }
 
-QQuickPinch *QQuickPinchArea::pinch()
+#ifdef Q_OS_OSX
+void QQuickPinchArea::hoverEnterEvent(QHoverEvent *event)
 {
-    Q_D(QQuickPinchArea);
-    if (!d->pinch)
-        d->pinch = new QQuickPinch;
-    return d->pinch;
+    Q_UNUSED(event);
+    setTouchEventsEnabled(true);
 }
 
-void QQuickPinchArea::setTouchEventsEnabledForWindow(QWindow *window)
+void QQuickPinchArea::hoverLeaveEvent(QHoverEvent *event)
+{
+    Q_UNUSED(event);
+    setTouchEventsEnabled(false);
+}
+
+void QQuickPinchArea::setTouchEventsEnabled(bool enable)
 {
-#ifdef Q_OS_MAC
     // Resolve function for enabling touch events from the (cocoa) platform plugin.
     typedef void (*RegisterTouchWindowFunction)(QWindow *, bool);
     RegisterTouchWindowFunction registerTouchWindow = reinterpret_cast<RegisterTouchWindowFunction>(
         QGuiApplication::platformNativeInterface()->nativeResourceFunctionForIntegration("registertouchwindow"));
     if (!registerTouchWindow)
-        return; // Not necessarily an error, Qt migh be using a different platform plugin.
-
-    // Disable touch on the old window, enable on the new window.
-    if (_currentWindow)
-        registerTouchWindow(_currentWindow, false);
-    if (window)
-        registerTouchWindow(window, true);
-    // Save the current window, setTouchEventsEnabledForWindow will be called
-    // with a null window on disable.
-    _currentWindow = window;
-#else // Q_OS_MAC
-    Q_UNUSED(window)
-#endif
+        return; // Not necessarily an error, Qt might be using a different platform plugin.
+
+    registerTouchWindow(window(), enable);
 }
+#endif // Q_OS_OSX
 
+QQuickPinch *QQuickPinchArea::pinch()
+{
+    Q_D(QQuickPinchArea);
+    if (!d->pinch)
+        d->pinch = new QQuickPinch;
+    return d->pinch;
+}
 
 QT_END_NAMESPACE
 
diff --git a/src/quick/items/qquickpincharea_p.h b/src/quick/items/qquickpincharea_p.h
index c991145fc7..81bdbda3a1 100644
--- a/src/quick/items/qquickpincharea_p.h
+++ b/src/quick/items/qquickpincharea_p.h
@@ -282,9 +282,11 @@ protected:
     virtual void geometryChanged(const QRectF &newGeometry,
                                  const QRectF &oldGeometry);
     virtual void itemChange(ItemChange change, const ItemChangeData& value);
-
-private Q_SLOTS:
-    void setTouchEventsEnabledForWindow(QWindow *window);
+#ifdef Q_OS_OSX
+    void hoverEnterEvent(QHoverEvent *event);
+    void hoverLeaveEvent(QHoverEvent *event);
+    void setTouchEventsEnabled(bool enable);
+#endif
 
 private:
     void updatePinch();
@@ -292,7 +294,6 @@ private:
     void handleRelease();
 
 private:
-    QWindow *_currentWindow;
     Q_DISABLE_COPY(QQuickPinchArea)
     Q_DECLARE_PRIVATE(QQuickPinchArea)
 };