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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Quick Controls module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
** of its contributors may be used to endorse or promote products derived
** from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/
import QtQuick 2.2
import QtQuick.Controls 1.2
import QtQuick.Controls.Private 1.0
/*!
\qmltype CheckBox
\inqmlmodule QtQuick.Controls
\since 5.1
\ingroup controls
\brief A checkbox with a text label.
\image checkbox.png
A CheckBox is an option button that can be toggled on (checked) or off
(unchecked). Checkboxes are typically used to represent features in an
application that can be enabled or disabled without affecting others.
The state of the checkbox can be set with the \l {AbstractCheckable::checked}{checked} property.
In addition to the checked and unchecked states, there is a third state:
partially checked. This state indicates that the
regular checked/unchecked state can not be determined; generally because of
other states that affect the checkbox. This state is useful when several
child nodes are selected in a treeview, for example.
The partially checked state can be made available to the user by setting
\l partiallyCheckedEnabled to \c true, or set directly by setting
\l checkedState to \c Qt.PartiallyChecked. \l checkedState behaves
identically to \l {AbstractCheckable::checked}{checked} when \l partiallyCheckedEnabled
is \c false; setting one will appropriately set the other.
The label is shown next to the checkbox, and you can set the label text using its
\l {AbstractCheckable::text}{text} property.
\qml
Column {
CheckBox {
text: qsTr("Breakfast")
checked: true
}
CheckBox {
text: qsTr("Lunch")
}
CheckBox {
text: qsTr("Dinner")
checked: true
}
}
\endqml
Whenever a CheckBox is clicked, it emits the \l {AbstractCheckable::clicked}{clicked()} signal.
You can create a custom appearance for a CheckBox by
assigning a \l {QtQuick.Controls.Styles::CheckBoxStyle}{CheckBoxStyle}.
*/
AbstractCheckable {
id: checkBox
/*!
\qmlproperty enumeration CheckBox::checkedState
This property indicates the current checked state of the checkbox.
Possible values:
\c Qt.UnChecked - The checkbox is not checked (default).
\c Qt.Checked - The checkbox is checked.
\c Qt.PartiallyChecked - The checkbox is in a partially checked (or
"mixed") state.
The \l {AbstractCheckable::checked}{checked} property also determines whether
this property is \c Qt.Checked or \c Qt.UnChecked, and vice versa.
*/
property int checkedState: checked ? Qt.Checked : Qt.Unchecked
/*!
This property determines whether the \c Qt.PartiallyChecked state is
available.
A checkbox may be in a partially checked state when the regular checked
state can not be determined.
Setting \l checkedState to \c Qt.PartiallyChecked will implicitly set
this property to \c true.
If this property is \c true, \l {AbstractCheckable::checked}{checked} will be \c false.
By default, this property is \c false.
*/
property bool partiallyCheckedEnabled: false
/*!
\internal
True if onCheckedChanged should be ignored because we were reacting
to onCheckedStateChanged.
*/
property bool __ignoreChecked: false
/*!
\internal
True if onCheckedStateChanged should be ignored because we were reacting
to onCheckedChanged.
*/
property bool __ignoreCheckedState: false
style: Qt.createComponent(Settings.style + "/CheckBoxStyle.qml", checkBox)
activeFocusOnTab: true
Accessible.role: Accessible.CheckBox
Accessible.name: text
__cycleStatesHandler: __cycleCheckBoxStates
onCheckedChanged: {
if (!__ignoreChecked) {
__ignoreCheckedState = true;
checkedState = checked ? Qt.Checked : Qt.Unchecked;
__ignoreCheckedState = false;
}
}
onCheckedStateChanged: {
__ignoreChecked = true;
if (checkedState === Qt.PartiallyChecked) {
partiallyCheckedEnabled = true;
checked = false;
} else if (!__ignoreCheckedState) {
checked = checkedState === Qt.Checked;
}
__ignoreChecked = false;
}
onPartiallyCheckedEnabledChanged: {
if (exclusiveGroup && partiallyCheckedEnabled) {
console.warn("Cannot have partially checked boxes in an ExclusiveGroup.");
}
}
onExclusiveGroupChanged: {
if (exclusiveGroup && partiallyCheckedEnabled) {
console.warn("Cannot have partially checked boxes in an ExclusiveGroup.");
}
}
/*! \internal */
function __cycleCheckBoxStates() {
if (!partiallyCheckedEnabled) {
checked = !checked;
} else {
switch (checkedState) {
case Qt.Unchecked: checkedState = Qt.Checked; break;
case Qt.Checked: checkedState = Qt.PartiallyChecked; break;
case Qt.PartiallyChecked: checkedState = Qt.Unchecked; break;
}
}
}
}
|
