Fix nested popups

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

3 files changed, 104 insertions, 3 deletions

diff --git a/src/quicktemplates2/qquickoverlay.cpp b/src/quicktemplates2/qquickoverlay.cpp
index 2855ba8b..ba0dfc46 100644
--- a/src/quicktemplates2/qquickoverlay.cpp
+++ b/src/quicktemplates2/qquickoverlay.cpp
@@ -388,9 +388,19 @@ void QQuickOverlay::wheelEvent(QWheelEvent *event)
 bool QQuickOverlay::childMouseEventFilter(QQuickItem *item, QEvent *event)
 {
     Q_D(QQuickOverlay);
-    for (QQuickPopup *popup : qAsConst(d->allPopups)) {
-        QQuickItem *dimmer = QQuickPopupPrivate::get(popup)->dimmer;
-        if (item == dimmer) {
+    const auto popups = d->stackingOrderPopups();
+    for (QQuickPopup *popup : popups) {
+        QQuickPopupPrivate *p = QQuickPopupPrivate::get(popup);
+
+        // Stop filtering overlay events when reaching a popup item or an item
+        // that is inside the popup. Let the popup content handle its events.
+        if (item == p->popupItem || p->popupItem->isAncestorOf(item))
+            break;
+
+        // Let the popup try closing itself when pressing or releasing over its
+        // background dimming OR over another popup underneath, in case the popup
+        // does not have background dimming.
+        if (item == p->dimmer || !p->popupItem->isAncestorOf(item)) {
             switch (event->type()) {
             case QEvent::MouseButtonPress:
                 emit pressed();
diff --git a/tests/auto/popup/data/nested.qml b/tests/auto/popup/data/nested.qml
new file mode 100644
index 00000000..bf9e86c5
--- /dev/null
+++ b/tests/auto/popup/data/nested.qml
@@ -0,0 +1,64 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the test suite of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** You may use this file under the terms of the BSD license as follows:
+**
+** "Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions are
+** met:
+**   * Redistributions of source code must retain the above copyright
+**     notice, this list of conditions and the following disclaimer.
+**   * Redistributions in binary form must reproduce the above copyright
+**     notice, this list of conditions and the following disclaimer in
+**     the documentation and/or other materials provided with the
+**     distribution.
+**   * Neither the name of The Qt Company Ltd nor the names of its
+**     contributors may be used to endorse or promote products derived
+**     from this software without specific prior written permission.
+**
+**
+** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import QtQuick 2.6
+import QtQuick.Controls 2.0
+
+ApplicationWindow {
+    width: 400
+    height: 400
+
+    property alias modalPopup: modalPopup
+    property alias modelessPopup: modelessPopup
+
+    Popup {
+        id: modalPopup
+        modal: true
+        width: 200
+        height: 200
+    }
+
+    Popup {
+        id: modelessPopup
+        modal: false
+        width: 100
+        height: 100
+    }
+}
diff --git a/tests/auto/popup/tst_popup.cpp b/tests/auto/popup/tst_popup.cpp
index 298328de..6d1e1e3c 100644
--- a/tests/auto/popup/tst_popup.cpp
+++ b/tests/auto/popup/tst_popup.cpp
@@ -69,6 +69,7 @@ private slots:
     void wheel_data();
     void wheel();
     void parentDestroyed();
+    void nested();
 };
 
 void tst_popup::visible_data()
@@ -609,6 +610,32 @@ void tst_popup::parentDestroyed()
     QVERIFY(!popup.parentItem());
 }
 
+void tst_popup::nested()
+{
+    QQuickApplicationHelper helper(this, QStringLiteral("nested.qml"));
+    QQuickWindow *window = helper.window;
+    window->show();
+    QVERIFY(QTest::qWaitForWindowExposed(window));
+
+    QQuickPopup *modalPopup = window->property("modalPopup").value<QQuickPopup *>();
+    QVERIFY(modalPopup);
+
+    QQuickPopup *modelessPopup = window->property("modelessPopup").value<QQuickPopup *>();
+    QVERIFY(modelessPopup);
+
+    modalPopup->open();
+    QCOMPARE(modalPopup->isVisible(), true);
+
+    modelessPopup->open();
+    QCOMPARE(modelessPopup->isVisible(), true);
+
+    // click outside the modeless popup on the top, but inside the modal popup below
+    QTest::mouseClick(window, Qt::LeftButton, Qt::NoModifier, QPoint(150, 150));
+
+    QTRY_COMPARE(modelessPopup->isVisible(), false);
+    QCOMPARE(modalPopup->isVisible(), true);
+}
+
 QTEST_MAIN(tst_popup)
 
 #include "tst_popup.moc"