Drawer: reparent to the overlay by default

Drawer is a special type of popup that always resides at one of the
window edges. Therefore it makes sense for drawers to operate on window
coordinates. Re-parenting drawers to the window overlay achieves that.

Now that the window overlay is guaranteed to always exist and the
ApplicationWindow.overlay attached property works even with plain QML
Window, we can reliably use it as a parent for Drawer.

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

7 files changed, 118 insertions, 0 deletions

diff --git a/src/imports/controls/Drawer.qml b/src/imports/controls/Drawer.qml
index 8cf4e5e5..9791bf0c 100644
--- a/src/imports/controls/Drawer.qml
+++ b/src/imports/controls/Drawer.qml
@@ -40,6 +40,8 @@ import QtQuick.Templates 2.0 as T
 T.Drawer {
     id: control
 
+    parent: T.ApplicationWindow.overlay
+
     implicitWidth: Math.max(background ? background.implicitWidth : 0, contentWidth + leftPadding + rightPadding)
     implicitHeight: Math.max(background ? background.implicitHeight : 0, contentHeight + topPadding + bottomPadding)
 
diff --git a/src/imports/controls/material/Drawer.qml b/src/imports/controls/material/Drawer.qml
index b3ee94f7..1c15e689 100644
--- a/src/imports/controls/material/Drawer.qml
+++ b/src/imports/controls/material/Drawer.qml
@@ -42,6 +42,8 @@ import QtQuick.Controls.Material.impl 2.0
 T.Drawer {
     id: control
 
+    parent: T.ApplicationWindow.overlay
+
     implicitWidth: Math.max(background ? background.implicitWidth : 0, contentWidth + leftPadding + rightPadding)
     implicitHeight: Math.max(background ? background.implicitHeight : 0, contentHeight + topPadding + bottomPadding)
 
diff --git a/src/imports/controls/universal/Drawer.qml b/src/imports/controls/universal/Drawer.qml
index 95fef8d1..84831323 100644
--- a/src/imports/controls/universal/Drawer.qml
+++ b/src/imports/controls/universal/Drawer.qml
@@ -41,6 +41,8 @@ import QtQuick.Controls.Universal 2.0
 T.Drawer {
     id: control
 
+    parent: T.ApplicationWindow.overlay
+
     implicitWidth: Math.max(background ? background.implicitWidth : 0, contentWidth + leftPadding + rightPadding)
     implicitHeight: Math.max(background ? background.implicitHeight : 0, contentHeight + topPadding + bottomPadding)
 
diff --git a/src/quicktemplates2/qquickdrawer.cpp b/src/quicktemplates2/qquickdrawer.cpp
index 0f5e5824..4c850473 100644
--- a/src/quicktemplates2/qquickdrawer.cpp
+++ b/src/quicktemplates2/qquickdrawer.cpp
@@ -69,6 +69,28 @@ QT_BEGIN_NAMESPACE
             of the window.
     \endtable
 
+    \code
+    import QtQuick 2.7
+    import QtQuick.Controls 2.0
+
+    ApplicationWindow {
+        id: window
+        visible: true
+
+        Drawer {
+            id: drawer
+            width: 0.66 * window.width
+            height: window.height
+        }
+    }
+    \endcode
+
+    Drawer is a special type of popup that resides at one of the window \l {edge}{edges}.
+    By default, Drawer re-parents itself to the window \l {ApplicationWindow::}{overlay},
+    and therefore operates on window coordinates. It is also possible to manually set the
+    \l {Popup::}{parent} to something else to make the drawer operate in a specific
+    coordinate space.
+
     In the image above, the application's contents are \e "pushed" across the
     screen. This is achieved by applying a translation to the contents:
 
diff --git a/tests/auto/controls/data/tst_drawer.qml b/tests/auto/controls/data/tst_drawer.qml
index e08856bd..021afdb2 100644
--- a/tests/auto/controls/data/tst_drawer.qml
+++ b/tests/auto/controls/data/tst_drawer.qml
@@ -60,6 +60,7 @@ TestCase {
         compare(control.edge, Qt.LeftEdge)
         compare(control.position, 0.0)
         compare(control.dragMargin, Qt.styleHints.startDragDistance)
+        compare(control.parent, ApplicationWindow.overlay)
         control.destroy()
     }
 
diff --git a/tests/auto/drawer/data/header.qml b/tests/auto/drawer/data/header.qml
new file mode 100644
index 00000000..9a352ffc
--- /dev/null
+++ b/tests/auto/drawer/data/header.qml
@@ -0,0 +1,57 @@
+/****************************************************************************
+**
+** 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 drawer: drawer
+
+    header: ToolBar { }
+
+    Drawer {
+        id: drawer
+        width: 200
+        height: parent.height
+    }
+}
diff --git a/tests/auto/drawer/tst_drawer.cpp b/tests/auto/drawer/tst_drawer.cpp
index 3a02e9a9..f29abf21 100644
--- a/tests/auto/drawer/tst_drawer.cpp
+++ b/tests/auto/drawer/tst_drawer.cpp
@@ -69,6 +69,7 @@ private slots:
     void dragMargin();
 
     void reposition();
+    void header();
 
     void hover_data();
     void hover();
@@ -352,6 +353,37 @@ void tst_Drawer::reposition()
     QTRY_COMPARE(drawer->popupItem()->x(), static_cast<qreal>(window->width()));
 }
 
+void tst_Drawer::header()
+{
+    QQuickApplicationHelper helper(this, QStringLiteral("header.qml"));
+
+    QQuickApplicationWindow *window = helper.appWindow;
+    window->show();
+    QVERIFY(QTest::qWaitForWindowExposed(window));
+
+    QQuickItem *content = window->contentItem();
+    QVERIFY(content);
+
+    QQuickOverlay *overlay = QQuickOverlay::overlay(window);
+    QVERIFY(overlay);
+
+    QQuickDrawer *drawer = window->property("drawer").value<QQuickDrawer*>();
+    QVERIFY(drawer);
+    QQuickItem *popupItem = drawer->popupItem();
+
+    drawer->open();
+    QVERIFY(drawer->isVisible());
+
+    QCOMPARE(drawer->parentItem(), overlay);
+    QCOMPARE(drawer->height(), overlay->height());
+    QCOMPARE(popupItem->height(), overlay->height());
+
+    drawer->setParentItem(content);
+    QCOMPARE(drawer->parentItem(), content);
+    QCOMPARE(drawer->height(), content->height());
+    QCOMPARE(popupItem->height(), content->height());
+}
+
 void tst_Drawer::hover_data()
 {
     QTest::addColumn<QString>("source");