Don't restore focus to contentItem when a focusless popup was closed

For example, a ToolTip shouldn't affect focus when it closes.

Task-number: QTBUG-53420
Task-number: QTBUG-53451
Change-Id: Ic945e98a2ffd86e9f9f06724b16e5f240c3f94de
Reviewed-by: Liang Qi <liang.qi@qt.io>

5 files changed, 209 insertions, 6 deletions

diff --git a/src/quicktemplates2/qquickpopup.cpp b/src/quicktemplates2/qquickpopup.cpp
index 9279b261..cb13d7b6 100644
--- a/src/quicktemplates2/qquickpopup.cpp
+++ b/src/quicktemplates2/qquickpopup.cpp
@@ -131,6 +131,7 @@ QQuickPopupPrivate::QQuickPopupPrivate()
     , hasBottomMargin(false)
     , allowVerticalFlip(false)
     , allowHorizontalFlip(false)
+    , hadActiveFocusBeforeExitTransition(false)
     , x(0)
     , y(0)
     , effectiveX(0)
@@ -208,8 +209,12 @@ void QQuickPopupPrivate::prepareExitTransition()
     Q_Q(QQuickPopup);
     if (window && !qobject_cast<QQuickApplicationWindow *>(window))
         window->removeEventFilter(q);
-    if (focus)
+    if (focus) {
+        // The setFocus(false) call below removes any active focus before we're
+        // able to check it in finalizeExitTransition.
+        hadActiveFocusBeforeExitTransition = popupItem->hasActiveFocus();
         popupItem->setFocus(false);
+    }
     emit q->aboutToHide();
 }
 
@@ -230,13 +235,16 @@ void QQuickPopupPrivate::finalizeExitTransition(bool hide)
         popupItem->setVisible(false);
     }
 
-    QQuickApplicationWindow *applicationWindow = qobject_cast<QQuickApplicationWindow*>(window);
-    if (applicationWindow)
-        applicationWindow->contentItem()->setFocus(true);
-    else if (window)
-        window->contentItem()->setFocus(true);
+    if (hadActiveFocusBeforeExitTransition) {
+        QQuickApplicationWindow *applicationWindow = qobject_cast<QQuickApplicationWindow*>(window);
+        if (applicationWindow)
+            applicationWindow->contentItem()->setFocus(true);
+        else if (window)
+            window->contentItem()->setFocus(true);
+    }
 
     visible = false;
+    hadActiveFocusBeforeExitTransition = false;
     emit q->visibleChanged();
     emit q->closed();
 }
diff --git a/src/quicktemplates2/qquickpopup_p_p.h b/src/quicktemplates2/qquickpopup_p_p.h
index 5e4e6c51..9ea5a7f0 100644
--- a/src/quicktemplates2/qquickpopup_p_p.h
+++ b/src/quicktemplates2/qquickpopup_p_p.h
@@ -190,6 +190,7 @@ public:
     bool hasBottomMargin;
     bool allowVerticalFlip;
     bool allowHorizontalFlip;
+    bool hadActiveFocusBeforeExitTransition;
     qreal x;
     qreal y;
     qreal effectiveX;
diff --git a/tests/auto/popup/data/activeFocusOnClose1.qml b/tests/auto/popup/data/activeFocusOnClose1.qml
new file mode 100644
index 00000000..e1a4cec2
--- /dev/null
+++ b/tests/auto/popup/data/activeFocusOnClose1.qml
@@ -0,0 +1,59 @@
+/****************************************************************************
+**
+** 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 focusedPopup: focusedPopup
+    property alias nonFocusedPopup: nonFocusedPopup
+
+    Popup {
+        id: focusedPopup
+        focus: true
+    }
+
+    Popup {
+        id: nonFocusedPopup
+    }
+}
diff --git a/tests/auto/popup/data/activeFocusOnClose2.qml b/tests/auto/popup/data/activeFocusOnClose2.qml
new file mode 100644
index 00000000..9418d521
--- /dev/null
+++ b/tests/auto/popup/data/activeFocusOnClose2.qml
@@ -0,0 +1,69 @@
+/****************************************************************************
+**
+** 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 popup1: popup1
+    property alias popup2: popup2
+    property alias closePopup2Button: closePopup2Button
+
+    Popup {
+        id: popup1
+        focus: true
+    }
+
+    Popup {
+        id: popup2
+        focus: true
+
+        Button {
+            id: closePopup2Button
+            onClicked: {
+                popup1.contentItem.forceActiveFocus();
+                popup2.close();
+            }
+        }
+    }
+}
diff --git a/tests/auto/popup/tst_popup.cpp b/tests/auto/popup/tst_popup.cpp
index fe0717d2..97cbb474 100644
--- a/tests/auto/popup/tst_popup.cpp
+++ b/tests/auto/popup/tst_popup.cpp
@@ -56,6 +56,8 @@ private slots:
     void windowChange();
     void closePolicy_data();
     void closePolicy();
+    void activeFocusOnClose1();
+    void activeFocusOnClose2();
 };
 
 void tst_popup::visible()
@@ -247,6 +249,70 @@ void tst_popup::closePolicy()
         QVERIFY(popup->isVisible());
 }
 
+void tst_popup::activeFocusOnClose1()
+{
+    // Test that a popup that never sets focus: true (e.g. ToolTip) doesn't affect
+    // the active focus item when it closes.
+    QQuickApplicationHelper helper(this, QStringLiteral("activeFocusOnClose1.qml"));
+    QQuickApplicationWindow *window = helper.window;
+    window->show();
+    window->requestActivate();
+    QVERIFY(QTest::qWaitForWindowActive(window));
+
+    QQuickPopup *focusedPopup = helper.window->property("focusedPopup").value<QQuickPopup*>();
+    QVERIFY(focusedPopup);
+
+    QQuickPopup *nonFocusedPopup = helper.window->property("nonFocusedPopup").value<QQuickPopup*>();
+    QVERIFY(nonFocusedPopup);
+
+    focusedPopup->open();
+    QVERIFY(focusedPopup->isVisible());
+    QVERIFY(focusedPopup->hasActiveFocus());
+
+    nonFocusedPopup->open();
+    QVERIFY(nonFocusedPopup->isVisible());
+    QVERIFY(focusedPopup->hasActiveFocus());
+
+    nonFocusedPopup->close();
+    QVERIFY(!nonFocusedPopup->isVisible());
+    QVERIFY(focusedPopup->hasActiveFocus());
+}
+
+void tst_popup::activeFocusOnClose2()
+{
+    // Test that a popup that sets focus: true but relinquishes focus (e.g. by
+    // calling forceActiveFocus() on another item) before it closes doesn't
+    // affect the active focus item when it closes.
+    QQuickApplicationHelper helper(this, QStringLiteral("activeFocusOnClose2.qml"));
+    QQuickApplicationWindow *window = helper.window;
+    window->show();
+    window->requestActivate();
+    QVERIFY(QTest::qWaitForWindowActive(window));
+
+    QQuickPopup *popup1 = helper.window->property("popup1").value<QQuickPopup*>();
+    QVERIFY(popup1);
+
+    QQuickPopup *popup2 = helper.window->property("popup2").value<QQuickPopup*>();
+    QVERIFY(popup2);
+
+    QQuickButton *closePopup2Button = helper.window->property("closePopup2Button").value<QQuickButton*>();
+    QVERIFY(closePopup2Button);
+
+    popup1->open();
+    QVERIFY(popup1->isVisible());
+    QVERIFY(popup1->hasActiveFocus());
+
+    popup2->open();
+    QVERIFY(popup2->isVisible());
+    QVERIFY(popup2->hasActiveFocus());
+
+    // Causes popup1.contentItem.forceActiveFocus() to be called, then closes popup2.
+    QTest::mouseClick(window, Qt::LeftButton, Qt::NoModifier,
+        closePopup2Button->mapToScene(QPointF(closePopup2Button->width() / 2, closePopup2Button->height() / 2)).toPoint());
+    QVERIFY(!popup2->isVisible());
+    QVERIFY(popup1->hasActiveFocus());
+}
+
 QTEST_MAIN(tst_popup)
 
 #include "tst_popup.moc"