aboutsummaryrefslogtreecommitdiffstats
path: root/src/quickcontrols/doc/src/qtquickcontrols-menus.qdoc
blob: f2f5b76ae28062b0a1578151e7305cf68e0b9251 (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
// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \page qtquickcontrols-menus.html
    \title Menu Controls
    \ingroup qtquickcontrols-guidelines
    \brief Guidelines for menu controls

    \annotatedlist qtquickcontrols-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 qtquickcontrols-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 qtquickcontrols-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
*/