aboutsummaryrefslogtreecommitdiffstats
path: root/src/quickcontrols2/doc/src/qtquickcontrols2-menus.qdoc
blob: 43db20927c6709312959322a7beebe7789bb02b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/****************************************************************************
**
** 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-menus.html
    \title Menu Controls
    \ingroup qtquickcontrols2-guidelines
    \brief Guidelines for menu controls

    \annotatedlist qtquickcontrols2-menus

    Each type of menu control has its own specific target use case. The
    following sections offer guidelines for choosing the appropriate type
    of menu control, depending on the use case.

    \section1 Menu Control

    \image qtquickcontrols2-menu.png

    \l Menu control can be used for context menus; for example, after
    right-clicking. It can also be used for popup menus; for example, a
    menu that is shown after clicking a button.

    \l MenuItem is an item in the Menu control. Each item in a menu:
    \list
    \li displays text to the user
    \li allows checking/unchecking
    \li is highlighted (for example, on keyboard navigation)
    \li performs some action on activation
    \endlist

    \section1 MenuBar Control

    \image qtquickcontrols2-menubar.png

    \l MenuBar control can be used for window menu bars.

    \l MenuBarItem is an item in the MenuBar control. Each item in a menu bar:
    \list
    \li displays text to the user
    \li is highlighted (for example, on keyboard navigation)
    \li pops up the respective menu on activation
    \endlist
*/