Side Panel example

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

3 files changed, 81 insertions, 0 deletions

diff --git a/examples/quickcontrols2/sidepanel/doc/images/qtquickcontrols2-sidepanel-landscape.png b/examples/quickcontrols2/sidepanel/doc/images/qtquickcontrols2-sidepanel-landscape.png
new file mode 100644
index 0000000000..73ad430728
--- /dev/null
+++ b/examples/quickcontrols2/sidepanel/doc/images/qtquickcontrols2-sidepanel-landscape.png
diff --git a/examples/quickcontrols2/sidepanel/doc/images/qtquickcontrols2-sidepanel-portrait.png b/examples/quickcontrols2/sidepanel/doc/images/qtquickcontrols2-sidepanel-portrait.png
new file mode 100644
index 0000000000..ad23add57e
--- /dev/null
+++ b/examples/quickcontrols2/sidepanel/doc/images/qtquickcontrols2-sidepanel-portrait.png
diff --git a/examples/quickcontrols2/sidepanel/doc/src/qtquickcontrols2-sidepanel.qdoc b/examples/quickcontrols2/sidepanel/doc/src/qtquickcontrols2-sidepanel.qdoc
new file mode 100644
index 0000000000..822b25a4ab
--- /dev/null
+++ b/examples/quickcontrols2/sidepanel/doc/src/qtquickcontrols2-sidepanel.qdoc
@@ -0,0 +1,81 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \example sidepanel
+    \title Qt Quick Controls 2 - Side Panel
+    \ingroup qtquickcontrols2-examples
+    \brief A non-closable persistent side panel with Drawer
+
+    This example demonstrates how \l Drawer can be used as a non-closable
+    persistent side panel.
+
+    \raw HTML
+    <div class="table"><table style="background:transparent; border:0px">
+    <tr><td style="border:0px">
+    \endraw
+    \image qtquickcontrols2-sidepanel-portrait.png
+    \caption An interactive Drawer in portrait mode
+    \raw HTML
+    </td><td style="border:0px">
+    \endraw
+    \image qtquickcontrols2-sidepanel-landscape.png
+    \caption A non-interactive Drawer in landscape mode
+    \raw HTML
+    </td></tr>
+    </table></div>
+    \endraw
+
+    When the application is in portrait mode, the drawer is an interactive
+    side panel that can be swiped open from the left edge. It appears on
+    top of the content, and blocks user interaction through its modal
+    background. When the application is in landscape mode, the drawer and
+    the content are laid out side by side.
+
+    The current orientation of the application is determined by comparing
+    the width and height of the window:
+
+    \snippet sidepanel/sidepanel.qml orientation
+
+    This is used to specify whether the drawer is \l {Popup::}{modal} and
+    \l {Drawer::}{interactive}, and to configure its \l {Drawer::}{position}
+    and \l {Popup::visible}{visibility} accordingly.
+
+    \quotefromfile sidepanel/sidepanel.qml
+    \skipto Drawer
+    \printline Drawer
+    \dots 8
+    \codeline
+    \skipto modal
+    \printuntil visible
+    \dots 8
+    \skipuntil ScrollIndicator
+    \skipuntil }
+    \printline }
+
+    \include examples-run.qdocinc
+*/