diff options
author | Mitch Curtis <mitch.curtis@qt.io> | 2022-11-23 16:50:43 +0800 |
---|---|---|
committer | Mitch Curtis <mitch.curtis@qt.io> | 2022-12-01 10:26:28 +0800 |
commit | 8b100bed5237b1ec864f059d7fb04b94fd874f49 (patch) | |
tree | 3e0503297e0dcdee3ea6245f480b9ce65766a056 /src/quickcontrols/doc/src/qtquickcontrols-environment.qdoc | |
parent | 4bd87b903b355b53e3105ba1ae7c154c4e55cdaf (diff) |
Doc: remove "2" from Qt Quick Controls files
Work on this was already started for the documentation in
1abdfe5d5a052f2298b7bf657513dfa7e0c66a56.
The CMake target (docs_QuickControls2) probably can't be renamed
until we rename the library, which won't happen until Qt 7.
Task-number: QTBUG-95413
Change-Id: Ied20805a91286436606577c3de39671a447f27dd
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Diffstat (limited to 'src/quickcontrols/doc/src/qtquickcontrols-environment.qdoc')
-rw-r--r-- | src/quickcontrols/doc/src/qtquickcontrols-environment.qdoc | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/src/quickcontrols/doc/src/qtquickcontrols-environment.qdoc b/src/quickcontrols/doc/src/qtquickcontrols-environment.qdoc new file mode 100644 index 0000000000..fea7da1153 --- /dev/null +++ b/src/quickcontrols/doc/src/qtquickcontrols-environment.qdoc @@ -0,0 +1,54 @@ +// Copyright (C) 2017 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \page qtquickcontrols-environment.html + \title Supported Environment Variables in Qt Quick Controls + + This page contains a list of all environment variables that Qt Quick Controls + supports. The environment variables are primarily meant for testing purposes, but + they can also be used to set system-wide defaults. + + \table + \header + \li Variable + \li Description + \row + \li \c QT_QUICK_CONTROLS_STYLE + \li Specifies the default \l {Styling Qt Quick Controls}{Qt Quick Controls style}. + The value can be either one of the built-in styles, for example \c "Material", + or a custom style such as \c "MyStyle". + \row + \li \c QT_QUICK_CONTROLS_FALLBACK_STYLE + \li Specifies a fallback style for \l {Creating a Custom Style}{custom styles}. + The value can be one of the built-in styles, for example \c "Material", + \row + \li \c QT_QUICK_CONTROLS_CONF + \li Specifies the location of the \l {Qt Quick Controls configuration file}. + By default, the configuration file is loaded from the application's + resources in \c ":/qtquickcontrols2.conf". + \row + \li \c QT_QUICK_CONTROLS_HOVER_ENABLED + \li Specifies whether Qt Quick Controls use \l {Control::hoverEnabled}{hover effects}. + The value can be set to \c 0 or \c 1 to disable or enable hover effects, respectively. + \endtable + + \l {Imagine style} specific environment variables: + + \include qquickimaginestyle.qdocinc env + + \l {Material style} specific environment variables: + + \include qquickmaterialstyle.qdocinc env + + \l {Universal style} specific environment variables: + + \include qquickuniversalstyle.qdocinc env + + \section1 Related Information + + \list + \li \l{Styling Qt Quick Controls} + \li \l{Qt Quick Controls Configuration File} + \endlist +*/ |