summaryrefslogtreecommitdiff
path: root/src/controls/CheckBox.qml
diff options
context:
space:
mode:
authorJens Bache-Wiig <jens.bache-wiig@digia.com>2013-02-20 17:38:44 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-02-21 16:59:55 +0100
commit6ea1b2b1f26d266b88b091ddece0cdaad5d3accc (patch)
tree38b488f646b7070b0bc8ef1edae7281f8a24e1e3 /src/controls/CheckBox.qml
parente8a53a5a3a4b3d8069e69eba7f96e1f0b47699b6 (diff)
downloadqtquickcontrols-6ea1b2b1f26d266b88b091ddece0cdaad5d3accc.tar.gz
Rename QtDesktop to QtQuick.Controls
Change-Id: Icc61dbfc74cc2a303b9847e7d2c7ace4a9002046 Reviewed-by: Jens Bache-Wiig <jens.bache-wiig@digia.com>
Diffstat (limited to 'src/controls/CheckBox.qml')
-rw-r--r--src/controls/CheckBox.qml147
1 files changed, 147 insertions, 0 deletions
diff --git a/src/controls/CheckBox.qml b/src/controls/CheckBox.qml
new file mode 100644
index 00000000..574f35e5
--- /dev/null
+++ b/src/controls/CheckBox.qml
@@ -0,0 +1,147 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Components project.
+**
+** $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.0
+import QtQuick.Controls 1.0
+import "Styles/Settings.js" as Settings
+import QtQuick.Controls.Private 1.0
+
+/*!
+ \qmltype CheckBox
+ \inqmlmodule QtQuick.Controls 1.0
+ \ingroup controls
+ \brief A checkbox with a text label
+
+ 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 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 checked when \l partiallyCheckedEnabled is \c false;
+ setting one will appropriately set the other.
+
+ The text of the label shown next to the checkbox can be set with the \l text
+ property.
+
+ Whenever a CheckBox is clicked, it emits the clicked() signal.
+*/
+
+AbstractCheckable {
+ id: checkBox
+
+ /*!
+ 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.
+ */
+ 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.
+
+ By default, this property is \c false.
+ */
+ property bool partiallyCheckedEnabled: false
+
+ /*!
+ True if onCheckedChanged should be ignored because we were reacting
+ to onCheckedStateChanged.
+ */
+ property bool ignoreChecked: false
+
+ style: Qt.createComponent(Settings.THEME_PATH + "/CheckBoxStyle.qml", checkBox)
+
+ Accessible.role: Accessible.CheckBox
+ Accessible.name: text
+
+ __cycleStatesHandler: cycleCheckBoxStates
+
+ /*! \internal */
+ onCheckedChanged: {
+ if (!ignoreChecked)
+ checkedState = checked ? Qt.Checked : Qt.Unchecked;
+ }
+
+ /*! \internal */
+ onCheckedStateChanged: {
+ ignoreChecked = true;
+ if (checkedState === Qt.PartiallyChecked) {
+ partiallyCheckedEnabled = true;
+ checked = false;
+ } else {
+ checked = checkedState === Qt.Checked;
+ }
+ ignoreChecked = false;
+ }
+
+ /*! \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;
+ }
+ }
+ }
+}