Reset hover state for the items within the quick popup window

The hovered state of the item within the quick popup has not been
reset when another modal popup is placed over it. This is because,
after patch 48da34f, the overlay
filters the hover events of the quick controls which are modally
blocked.

But this can create an issue if the child item of the pop is
already in a hovered state and there is another modal popup placed
over it, as any further hover events (including the HoverLeave of
the control item) will be forwarded and handled by the modal popup
which doesn't allow the child item to resets its hovered state.

This patch allows the child item of the popup to handle hover
release event when it's already in the hovered state.

Fixes: QTBUG-126626
Pick-to: 6.5 6.2
Change-Id: Ibf7f5ad8653a8c0df9968114ab6b8228acba9d6e
Reviewed-by: Shawn Rutledge <[email protected]>
(cherry picked from commit 7712fbc)
Reviewed-by: Qt Cherry-pick Bot <[email protected]>
(cherry picked from commit 6958577)
Reviewed-by: Fabian Kosmale <[email protected]>

Author: Santhosh Kumar

src/quicktemplates/qquickoverlay.cpp

@@ -456,6 +456,13 @@ bool QQuickOverlay::childMouseEventFilter(QQuickItem *item, QEvent *event)
             case QEvent::HoverEnter:
             case QEvent::HoverMove:
             case QEvent::HoverLeave:
+                // If the control item has already been hovered, allow the hover leave event
+                // to be processed by the same item for resetting its internal hovered state
+                // instead of filtering it here.
+                if (auto *control = qobject_cast<QQuickControl *>(item)) {
+                    if (control->isHovered() && event->type() == QEvent::HoverLeave)
+                        return false;
+                }
                 handled = d->handleHoverEvent(item, static_cast<QHoverEvent *>(event), popup);
                 break;
 

tests/auto/quickcontrols/qquickpopup/data/resetHoveredForItemsWithinOverlay.qml

@@ -0,0 +1,28 @@
+import QtQuick
+import QtQuick.Controls
+
+ApplicationWindow {
+    id: root
+    width: 100
+    height: 100
+    property alias controlsPopup: _controlsPopup
+    property alias blockInputPopup: _blockInputPopup
+    Popup {
+        id: _controlsPopup
+        width: parent.width
+        height: parent.height
+        modal: true
+        Control {
+            id: controls
+            anchors.fill: parent
+            hoverEnabled: true
+            contentItem: Text { text: "Test Control" }
+        }
+    }
+    Popup {
+        id: _blockInputPopup
+        width: parent.width
+        height: parent.height
+        modal: true
+    }
+}

tests/auto/quickcontrols/qquickpopup/tst_qquickpopup.cpp

@@ -106,6 +106,7 @@ private slots:
     void fadeDimmer_data();
     void fadeDimmer();
     void noDimmer();
+    void resetHoveredStateForItemsWithinPopup();
 
 private:
     QScopedPointer<QPointingDevice> touchScreen = QScopedPointer<QPointingDevice>(QTest::createTouchDevice());
@@ -2358,6 +2359,39 @@ void tst_QQuickPopup::noDimmer()
     QTRY_VERIFY(!drawer->isModal());
 }
 
+void tst_QQuickPopup::resetHoveredStateForItemsWithinPopup()
+{
+    QQuickControlsApplicationHelper helper(this, "resetHoveredForItemsWithinOverlay.qml");
+    QVERIFY2(helper.ready, helper.failureMessage());
+
+    QQuickWindow *window = helper.window;
+    window->show();
+    QVERIFY(QTest::qWaitForWindowExposed(window));
+
+    QQuickPopup *controlsPopup = window->property("controlsPopup").value<QQuickPopup*>();
+    QVERIFY(controlsPopup);
+
+    QQuickPopup *blockInputPopup = window->property("blockInputPopup").value<QQuickPopup*>();
+    QVERIFY(controlsPopup);
+
+    controlsPopup->open();
+    QTRY_VERIFY(controlsPopup->isOpened());
+
+    QTest::mouseMove(window, QPoint(window->width() / 2, window->height() / 2));
+
+    auto *controlItem = qobject_cast<QQuickControl *>(controlsPopup->contentItem()->childItems().at(0));
+    QVERIFY(controlItem);
+    // Check hover enabled for the control item within the popup
+    QTRY_VERIFY(controlItem->isHovered());
+
+    // Open the modal popup window over the existing control item
+    blockInputPopup->open();
+    QTRY_VERIFY(blockInputPopup->isOpened());
+
+    // Control item hovered shall be disabled once we open the modal popup
+    QTRY_VERIFY(!controlItem->isHovered());
+}
+
 QTEST_QUICKCONTROLS_MAIN(tst_QQuickPopup)
 
 #include "tst_qquickpopup.moc"