summaryrefslogtreecommitdiffstats
path: root/src/controls/GroupBox.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/GroupBox.qml
parente8a53a5a3a4b3d8069e69eba7f96e1f0b47699b6 (diff)
Rename QtDesktop to QtQuick.Controls
Change-Id: Icc61dbfc74cc2a303b9847e7d2c7ace4a9002046 Reviewed-by: Jens Bache-Wiig <jens.bache-wiig@digia.com>
Diffstat (limited to 'src/controls/GroupBox.qml')
-rw-r--r--src/controls/GroupBox.qml193
1 files changed, 193 insertions, 0 deletions
diff --git a/src/controls/GroupBox.qml b/src/controls/GroupBox.qml
new file mode 100644
index 000000000..2e5b35d69
--- /dev/null
+++ b/src/controls/GroupBox.qml
@@ -0,0 +1,193 @@
+/****************************************************************************
+**
+** 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
+
+/*!
+ \qmltype GroupBox
+ \inqmlmodule QtQuick.Controls 1.0
+ \ingroup controls
+ \brief GroupBox provides a group box frame with a title
+
+ A group box provides a frame, a title on top and displays various other controls inside itself. Group boxes can also be checkable.
+
+ Child controls in checkable group boxes are enabled or disabled depending on whether or not the group box is checked.
+
+ You can minimize the space consumption of a group box by enabling the flat property.
+ In most styles, enabling this property results in the removal of the left, right and bottom edges of the frame.
+
+ GroupBox doesn't automatically lay out the child controls (which are often \l{CheckBox}{CheckBoxes} or \l{RadioButton}{RadioButtons} but can be any controls).
+ The following example shows how we can set up a GroupBox with a column:
+
+ \qml
+ GroupBox {
+ title: "Package selection"
+ adjustToContentSize: true
+ Column {
+ CheckBox {
+ text: "Update system"
+ }
+ CheckBox {
+ text: "Update applications"
+ }
+ CheckBox {
+ text: "Update documentation"
+ }
+ }
+ }
+ \endqml
+*/
+
+Item {
+ id: groupbox
+
+ /*!
+ This property holds the group box title text.
+
+ There is no default title text.
+ */
+ property string title
+
+ /*!
+ This property holds whether the group box is painted flat or has a frame.
+
+ A group box usually consists of a surrounding frame with a title at the top.
+ If this property is enabled, only the top part of the frame is drawn in most styles;
+ otherwise, the whole frame is drawn.
+
+ By default, this property is disabled, i.e., group boxes are not flat unless explicitly specified.
+
+ \note In some styles, flat and non-flat group boxes have similar representations and may not be as
+ distinguishable as they are in other styles.
+ */
+ property bool flat: false
+
+ /*!
+ This property holds whether the group box has a checkbox in its title.
+
+ If this property is true, the group box displays its title using a checkbox in place of an ordinary label.
+ If the checkbox is checked, the group box's children are enabled; otherwise, they are disabled and inaccessible.
+
+ By default, group boxes are not checkable.
+ */
+ property bool checkable: false
+
+ /*!
+ \qmlproperty bool GroupBox::checked
+
+ This property holds whether the group box is checked.
+
+ If the group box is checkable, it is displayed with a check box. If the check box is checked, the group
+ box's children are enabled; otherwise, the children are disabled and are inaccessible to the user.
+
+ By default, checkable group boxes are also checked.
+ */
+ property alias checked: check.checked
+
+ /*!
+ This property holds the width of the content.
+ */
+ readonly property real contentWidth: content.childrenRect.width
+
+ /*!
+ This property holds the height of the content.
+ */
+ readonly property real contentHeight: content.childrenRect.height
+
+ /*!
+ This property holds whether the group box resizes itself to fit the contents.
+
+ By default, group boxes do not resize itself to fit the contents.
+
+ \note When adjustToContentSize is enabled, children cannot be anchored.
+ */
+ property bool adjustToContentSize: false
+
+ /*! \internal */
+ property Component style: Qt.createComponent(Settings.THEME_PATH + "/GroupBoxStyle.qml", groupbox)
+
+ /*! \internal */
+ default property alias data: content.data
+
+ /*! \internal */
+ property alias __checkbox: check
+
+ implicitWidth: Math.max(200, contentWidth + (loader.item ? loader.item.implicitWidth: 0) )
+ implicitHeight: contentHeight + (loader.item ? loader.item.implicitHeight : 0) + 4
+
+ Accessible.role: Accessible.Grouping
+ Accessible.name: title
+
+ Loader {
+ id: loader
+ property alias control: groupbox
+ anchors.fill: parent
+ property int topMargin: title.length > 0 || checkable ? 22 : 4
+ property int bottomMargin: 4
+ property int leftMargin: 4
+ property int rightMargin: 4
+ sourceComponent: style
+ onLoaded: item.z = -1
+ }
+
+ CheckBox {
+ id: check
+ checked: true
+ visible: checkable
+ anchors.top: parent.top
+ anchors.left: parent.left
+ anchors.right: parent.right
+ height: loader.topMargin
+ }
+
+ Item {
+ id:content
+ z: 1
+ focus: true
+ anchors.topMargin: loader.topMargin
+ anchors.leftMargin: 8
+ anchors.rightMargin: 8
+ anchors.bottomMargin: 8
+ anchors.fill: parent
+ enabled: (!checkable || checkbox.checked)
+ }
+}