qtquickcontrols-popups.qdoc

Go to the documentation of this file.

// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
 
/*!
    \page qtquickcontrols-popups.html
    \title Popup Controls
    \ingroup qtquickcontrols-guidelines
    \brief Guidelines for popup controls
 
    \annotatedlist qtquickcontrols-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 qtquickcontrols-drawer-expanded-wireframe.webp
           {Drawer expanded from screen edge}
 
    \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 qtquickcontrols-menu.png
           {Menu displaying items with shortcuts}
 
    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 qtquickcontrols-popup-settings.png
           {Popup displaying settings with controls}
 
    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 qtquickcontrols-tooltip.png
           {Tooltip displaying helpful text}
 
    \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
*/