aboutsummaryrefslogtreecommitdiffstats
path: root/src/quickcontrols2/doc/src/qtquickcontrols2-popups.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/quickcontrols2/doc/src/qtquickcontrols2-popups.qdoc')
-rw-r--r--src/quickcontrols2/doc/src/qtquickcontrols2-popups.qdoc99
1 files changed, 0 insertions, 99 deletions
diff --git a/src/quickcontrols2/doc/src/qtquickcontrols2-popups.qdoc b/src/quickcontrols2/doc/src/qtquickcontrols2-popups.qdoc
deleted file mode 100644
index c26b4c4b..00000000
--- a/src/quickcontrols2/doc/src/qtquickcontrols2-popups.qdoc
+++ /dev/null
@@ -1,99 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2017 The Qt Company Ltd.
-** Contact: https://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 https://www.qt.io/terms-conditions. For further
-** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-/*!
- \page qtquickcontrols2-popups.html
- \title Popup Controls
- \ingroup qtquickcontrols2-guidelines
- \brief Guidelines for popup controls
-
- \annotatedlist qtquickcontrols2-popups
-
- Each type of popup control has its own specific target use case. The
- following sections offer guidelines for choosing the appropriate type
- of popup control, depending on the use case.
-
- \section1 Drawer Control
-
- \image qtquickcontrols2-drawer-expanded-wireframe.png
-
- \l Drawer provides a swipe-based side panel, similar to those often used
- in touch interfaces to provide a central location for navigation.
-
- The drawer can be positioned at any of the four edges of the screen. It allows
- the user to add navigation without taking up valuable screen space. The user can
- show and hide the drawer at any time with a simple swipe movement.
-
- \section1 Menu Control
-
- \image qtquickcontrols2-menu.png
-
- The \l Menu control displays a vertical list of items that can be selected. It can
- be used for offering a list of actions that can be taken in a given context.
-
- \b {See also} \l {Drawer Control}.
-
- \section1 Popup Control
-
- \image qtquickcontrols2-popup-settings.png
-
- A \l Popup displays content over other application content.
- It prompts the user to make a decision or enter information.
-
- Popups can be modal or non-modal. A modal popup blocks users from interacting
- with the application until they have made a choice and closed the popup.
-
- A popup can be used for:
-
- \list
- \li communicating a message to the user that they must read and acknowledge.
- \li displaying an error message.
- \li prompting the user to make a choice and/or enter a value.
- \endlist
-
- \section1 ToolTip Control
-
- \image qtquickcontrols2-tooltip.png
-
- \l ToolTip shows a short piece of text that informs the user of a control's
- function. It is typically placed above or below the parent control.
-
- Recommendations:
- \list
- \li Use a tooltip if a control has little or no descriptive text, or needs
- a short explanation.
- \li Use a tooltip only if the information on a particular control is not
- available elsewhere in the screen.
- \li Keep the tooltip text short so that it does not cover other content
- while being displayed.
- \endlist
-
- \section1 Related Information
- \list
- \li \l {Qt Quick Controls Guidelines}
- \endlist
-*/