1// Copyright (C) 2022 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
5 \page qtquickcontrols-index.html
6 \keyword Qt Quick Controls 2
7 \title Qt Quick Controls
9 \brief Provides a set of UI controls for Qt Quick.
11 Qt Quick Controls provides a set of controls that can be used
12 to build complete interfaces in Qt Quick. The module was introduced
15 \image qtquickcontrols-styles.png
17 Qt Quick Controls comes with a selection of customizable styles.
18 See \l {Styling Qt Quick Controls} for more details.
21 \section1 Using the Module
25 \include {module-use.qdocinc} {using the qml api} {QtQuick.Controls}
29 \include {module-use.qdocinc} {using the c++ api}
31 \section3 Building with CMake
33 \include {module-use.qdocinc} {building with cmake} {QuickControls2}
35 \section3 Building with qmake
37 \include {module-use.qdocinc} {building_with_qmake} {quickcontrols2}
39 \section2 Building From Source
41 The \b{Qt Image Formats} module is recommended, but not
42 required. It provides support for the \c {.webp} format used by the
43 \l {Animated Images}{Imagine style}.
47 Qt Quick Controls 2.0 was introduced in Qt 5.7. Subsequent minor Qt releases
48 increment the import version of the Qt Quick Controls modules by one,
49 until Qt 5.12, where the import versions match Qt's minor version.
51 In Qt 6, both the major and minor versions match, and version numbers may
52 be omitted from imports in QML. If the version is omitted, the latest
55 The experimental Qt Labs modules use import version 1.0.
60 \li \l {Qt Quick QML Types}{\c QtQuick}
61 \li \l {Qt Quick Controls QML Types}{\c QtQuick.Controls},\br
62 \l {Material Style}{\c QtQuick.Controls.Material},\br
63 \l {Universal Style}{\c QtQuick.Controls.Universal},\br
64 \l {Qt Quick Templates 2 QML Types}{\c QtQuick.Templates}
65 \li \l {Qt Labs Platform QML Types}{\c Qt.labs.platform}
110 Due to how Qt Quick Controls are implemented, new properties that are added
111 may clash with any user-defined properties of the same name. For example,
112 the following snippet will result in an error:
115 import QtQuick.Controls 2.13
121 anchors.centerIn: parent
123 // As currentValue was added in 2.14, the versioned import above
124 // should cause this property to be used, but instead an error is produced:
125 // "Cannot override FINAL property"
126 property int currentValue: 0
131 These properties should be renamed to avoid the conflict.
133 \section1 Module Evolution
135 Qt Quick Controls was originally written with touch interfaces as the
137 While it is already possible to develop desktop interfaces, work is ongoing
138 to provide a more native look and feel.
140 \l{Changes to Qt Quick Controls} lists important changes in the
141 module API and functionality that were done for the Qt 6 series of Qt.
143 \section1 Articles and Guides
146 \li \l{Getting Started with Qt Quick Controls}{Getting Started}
147 \li \l{Qt Quick Controls Guidelines}{Guidelines}
148 \li \l{Styling Qt Quick Controls}{Styling}
149 \li \l{Icons in Qt Quick Controls}{Icons}
150 \li \l{Customizing Qt Quick Controls}{Customization}
151 \li \l{Using File Selectors with Qt Quick Controls}{Using File Selectors}
152 \li \l{Deploying Qt Quick Controls Applications}{Deployment}
153 \li \l{Qt Quick Controls Configuration File}{Configuration File}
154 \li \l{Supported Environment Variables in Qt Quick Controls}
155 {Environment Variables}
161 \li \l{Qt Quick Controls - Gallery}{Gallery}
162 \li \l{Qt Quick Controls - Chat Tutorial}{Chat Tutorial}
163 \li \l{Qt Quick Controls - Text Editor}{Text Editor}
164 \li \l{Qt Quick Controls - Wearable Demo}{Wearable Demo}
165 \li \l{Qt Quick Controls - Imagine Style Example: Automotive}{Automotive Example}
166 \li \l{Qt Quick Controls Examples}{All Examples}
172 \li \l{Qt Quick Controls QML Types}{QML Types}
173 \li \l{Qt Quick Controls C++ Classes}{C++ Classes}
176 \section1 Related Modules
180 \li \l{Qt Quick Layouts}
181 \li \l{Qt Quick Templates 2}
182 \li \l{Qt Labs Platform}
185 \section1 License and Attributions
187 Qt Quick Controls is available under commercial licenses from \l{The Qt Company}.
188 In addition, it is available under the
189 \l{GNU Lesser General Public License, version 3}, or
190 the \l{GNU General Public License, version 2}.
191 See \l{Qt Licensing} for further details.
193 Furthermore, Qt Quick Controls potentially contains third party
194 modules under the following permissive licenses:
196 \generatelist{groupsbymodule attributions-qtquickcontrols}