aboutsummaryrefslogtreecommitdiffstats
path: root/src/imports/controls/doc/src/qtquickcontrols2-indicators.qdoc
blob: 54ac0a5a5837e9a02c5a5e15800b9defd65c525f (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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/****************************************************************************
**
** 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-indicators.html
    \title Indicator Controls
    \ingroup qtquickcontrols2-guidelines
    \brief Guidelines for indicator controls

    Qt Quick Controls 2 offers a selection of indicator-like controls.

    \annotatedlist qtquickcontrols2-indicators

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

    \section1 BusyIndicator Control

    \image qtquickcontrols2-busyindicator.png

    BusyIndicator can be used to show that an operation is in progress,
    and that the UI has to wait for the operation to complete.

    \section1 PageIndicator Control

    \image qtquickcontrols2-pageindicator.png

    \l PageIndicator is used to indicate the currently active page in
    a container of multiple pages.

    \section1 ProgressBar Control

    \image qtquickcontrols2-progressbar.gif

    \l ProgressBar indicates the progress of an operation. The value should be
    updated regularly.

    \section1 ScrollBar Control

    \image qtquickcontrols2-scrollbar.gif

    \l ScrollBar is an interactive bar that indicates the current scroll
    position, and can be used to scroll to a specific position in a
    \l Flickable.

    \section1 ScrollIndicator Control

    \image qtquickcontrols2-scrollindicator.gif

    \l ScrollIndicator is a non-interactive indicator that indicates the
    current scroll position, and can be used to scroll to a specific position in a
    \l {Flickable}.

    \section1 Related Information
    \list
    \li \l {Qt Quick Controls 2 Guidelines}
    \endlist
*/