aboutsummaryrefslogtreecommitdiffstats
path: root/src/imports/controls/doc/src/qtquickcontrols2-environment.qdoc
blob: 37be7b4c6434b3cffef4e6bf65bf23a5cc373e58 (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
/****************************************************************************
**
** 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-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 the path to 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_STYLE_PATH
            \li Specifies a list of additional paths that are used to lookup \l {Styling Qt Quick Controls}
                {Qt Quick Controls styles}. Multiple path entries must be \l {QDir::listSeparator}{separated}
                by \c ':' under Unix and \c ';' under Windows. By default, styles are looked up from
                \c $QML2_IMPORT_PATH/QtQuick/Controls.2.
        \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
*/