summaryrefslogtreecommitdiff
path: root/src/controls/doc/src/qtquickcontrolsstyles-index.qdoc
blob: 100868a92df5e9c43deffff4c97d4e0124532e52 (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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
/****************************************************************************
**
** Copyright (C) 2016 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$
**
****************************************************************************/

/*!
    \group applicationwindowstyling
    \title Styling Application Window
    \internal
*/

/*!
    \group viewsstyling
    \title Styling Views
    \brief How to add custom styles for views.
*/

/*!
    \group controlsstyling
    \brief Provides custom styling for Buttons and UI Controls.
    \title Styling Controls
*/

/*!
    \group menusstyling
    \title Styling Menus
    \internal
*/

/*!
    \group stylingtutorials
    \title Styling Tutorials
*/


/*!
    \page qtquickcontrolsstyles-index.html
    \title Qt Quick Controls Styles
    \brief The Qt Quick Controls Styles submodule provides custom styles for Qt Quick Controls.

    The Qt Quick Controls Styles submodule allows custom styling for \l {Qt Quick Controls}.

    The submodule was introduced in Qt 5.1.

    \section1 Getting started

    The QML types can be imported into your application using the following import statement in your \c {.qml} file.

    \code
    import QtQuick.Controls.Styles 1.4
    \endcode

    \section1 Styles

    \section2 Base Style

    The Base Style is the default style used when none is specified. It is also
    used as a fallback when the specified style cannot be found.

    \image tumbler.png
    \caption The Base Style Tumbler.

    \section2 Flat Style

    The Flat Style is designed for touch devices.

    \image tumbler-flat-style.png
    \caption The Flat Style Tumbler.

    \section2 Selecting Styles

    You can apply a different style to the controls by setting the
    \e QT_QUICK_CONTROLS_1_STYLE environment variable to the name of the style.
    For example, to use the Flat style, you can do the following:

    \code
    QT_QUICK_CONTROLS_1_STYLE=Flat ./app
    \endcode

    This can also be done in C++, using qputenv():

    \code
    qputenv("QT_QUICK_CONTROLS_1_STYLE", "Flat");
    \endcode

    \section1 Styling Views
    \annotatedlist viewsstyling

    \section1 Styling Controls
    \annotatedlist controlsstyling

    \section1 Styling Tutorials
    \annotatedlist stylingtutorials

    \section1 Related information

     \list
      \li \l{Qt Quick}
      \li \l{Qt Quick Controls}
      \li \l{Qt Quick Controls Styles QML Types}
     \endlist

*/

/*!
    \qmlmodule QtQuick.Controls.Styles 1.4
    \title Qt Quick Controls Styles QML Types
    \ingroup qmlmodules
    \brief Provides QML types for Qt Quick Controls styles.

    The \l{Qt Quick Controls} module provides a set of QML types for handling
    styles.

    Some of the controls allow custom styling similar to widget style sheets.
    A styling object is usually a collection of properties that control behavior and simple delegates
    that can be replaced with custom QML snippets.

    \code
    import QtQuick.Controls.Styles 1.4
    \endcode
*/

/*! \qmlmodule QtQuick.Controls.Private 1.0
    \internal
*/