aboutsummaryrefslogtreecommitdiffstats
path: root/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc
blob: d75aca4374c23634d7eef59b92d5a3b7d7c07520 (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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: http://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 http://www.qt.io/terms-conditions. For further
** information use the contact form at http://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: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \page qtquickcontrols2-index.html
    \title Qt Quick Controls 2

    \brief Provides a set of UI controls for Qt Quick.

    Qt Quick Controls 2 provides a set of controls that can be used
    to build complete interfaces in Qt Quick. The module was introduced
    in Qt 5.7.

    \section1 Prerequisites

    The \l{Qt Quick Controls 2 QML Types}{QML types} can be imported into your
    application using the following import statement in your \c {.qml} file:

    \code
    import QtQuick.Controls 2.2
    \endcode

    The \l{Qt Quick Controls 2 C++ Classes}{C++ classes} can be included into
    your application using the following include statement:

    \code
    #include <QtQuickControls2>
    \endcode

    To link against the corresponding C++ libraries, add the following to your
    qmake project file:

    \code
    QT += quickcontrols2
    \endcode

    For more details, see \l {Getting Started with Qt Quick Controls 2}.

    \section1 Important Concepts in Qt Quick Controls 2

    \list
      \li \l{Qt Quick Controls 2 Guidelines}
      \li \l{Styling Qt Quick Controls 2}
      \li \l{Customizing Qt Quick Controls 2}
      \li \l{High-DPI Support in Qt Quick Controls 2}
      \li \l{Using File Selectors with Qt Quick Controls 2}
      \li \l{Differences between Qt Quick Controls}
      \li \l{Deploying Qt Quick Controls 2 Applications}
      \li \l{Qt Quick Controls 2 Configuration File}
      \li \l{Supported Environment Variables in Qt Quick Controls 2}
    \endlist

    \section1 Reference

    \list
      \li \l{Qt Quick Controls 2 QML Types}{QML Types}
      \li \l{Qt Quick Controls 2 C++ Classes}{C++ Classes}
    \endlist

    \section1 Examples

    \list
      \li \l{Qt Quick Controls 2 - Gallery}{Gallery}
      \li \l{Qt Quick Controls 2 - Chat Tutorial}{Chat Tutorial}
      \li \l{Qt Quick Controls 2 - Text Editor}{Text Editor}
      \li \l{Qt Quick Controls 2 Examples}{All Examples}
    \endlist

    \section1 Related Modules

    \list
      \li \l{Qt Quick}
      \li \l{Qt Quick Layouts}
      \li \l{Qt Quick Templates 2}
      \li \l{Qt Labs Calendar}
      \li \l{Qt Labs Platform}
    \endlist
*/