summaryrefslogtreecommitdiff
path: root/src/extras/ToggleButton.qml
diff options
context:
space:
mode:
Diffstat (limited to 'src/extras/ToggleButton.qml')
-rw-r--r--src/extras/ToggleButton.qml69
1 files changed, 69 insertions, 0 deletions
diff --git a/src/extras/ToggleButton.qml b/src/extras/ToggleButton.qml
new file mode 100644
index 00000000..8e0d313e
--- /dev/null
+++ b/src/extras/ToggleButton.qml
@@ -0,0 +1,69 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the Qt Quick Extras module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** 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 http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later as published by the Free
+** Software Foundation and appearing in the file LICENSE.GPL included in
+** the packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import QtQuick 2.2
+import QtQuick.Controls 1.1
+import QtQuick.Extras 1.3
+import QtQuick.Extras.Styles 1.3
+import QtQuick.Extras.Private 1.0
+
+/*!
+ \qmltype ToggleButton
+ \inqmlmodule QtQuick.Extras
+ \since QtQuick.Extras 1.0
+ \ingroup extras
+ \ingroup extras-interactive
+ \brief A push button that toggles between two states.
+
+ \image togglebutton-unchecked.png An unchecked ToggleButton
+ An unchecked ToggleButton.
+ \image togglebutton-checked.png A checked ToggleButton
+ A checked ToggleButton.
+
+ The ToggleButton is a simple extension of Qt Quick Controls' Button, using
+ the checked property to toggle between two states: \e checked and
+ \e unchecked. It enhances the visibility of a checkable button's state by
+ placing color-coded indicators around the button.
+
+ You can create a custom appearance for a ToggleButton by assigning a
+ \l {QtQuick.Extras.Styles::}{ToggleButtonStyle}.
+*/
+
+Button {
+ id: button
+ checkable: true
+ style: Qt.createComponent(StyleSettings.style + "/ToggleButtonStyle.qml", button)
+}