diff options
Diffstat (limited to 'tests/manual/quickcontrols/sidepanel/doc/src/qtquickcontrols-sidepanel.qdoc')
-rw-r--r-- | tests/manual/quickcontrols/sidepanel/doc/src/qtquickcontrols-sidepanel.qdoc | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/tests/manual/quickcontrols/sidepanel/doc/src/qtquickcontrols-sidepanel.qdoc b/tests/manual/quickcontrols/sidepanel/doc/src/qtquickcontrols-sidepanel.qdoc new file mode 100644 index 0000000000..7029099d0f --- /dev/null +++ b/tests/manual/quickcontrols/sidepanel/doc/src/qtquickcontrols-sidepanel.qdoc @@ -0,0 +1,59 @@ +// Copyright (C) 2017 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \example sidepanel + \keyword Qt Quick Controls - Side Panel + \title Qt Quick Controls - Side Panel + \keyword Qt Quick Controls 2 - Side Panel + \ingroup qtquickcontrols-examples + \brief A persistent side panel with Drawer. + + This example demonstrates how \l Drawer can be used as a persistent side + panel. + + \raw HTML + <div class="table"><table style="background:transparent; border:0px"> + <tr><td style="border:0px"> + \endraw + \image qtquickcontrols-sidepanel-portrait.png + \caption An interactive Drawer in portrait mode + \raw HTML + </td><td style="border:0px"> + \endraw + \image qtquickcontrols-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, blocking 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 determine whether the drawer should be \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 +*/ |