Commit 9fafddcf authored by Mitch Curtis's avatar Mitch Curtis Committed by The Qt Project
Browse files

Document CheckBox.


Change-Id: Iaa60ffde5ff4c0d3a6d8a9c1277fa77ccbbb0c24
Reviewed-by: default avatarJens Bache-Wiig <jens.bache-wiig@digia.com>
parent eb2529c4
6.2 5.10 5.11 5.12 5.12.1 5.12.10 5.12.11 5.12.12 5.12.2 5.12.3 5.12.4 5.12.5 5.12.6 5.12.7 5.12.8 5.12.9 5.13 5.13.0 5.13.1 5.13.2 5.14 5.14.0 5.14.1 5.14.2 5.15 5.15.0 5.15.1 5.15.2 5.3 5.4 5.5 5.6 5.7 5.8 5.9 5.9.8 dev old/5.1 old/5.2 wip/calendar wip/tizen v5.15.0-alpha1 v5.14.1 v5.14.0 v5.14.0-rc2 v5.14.0-rc1 v5.14.0-beta3 v5.14.0-beta2 v5.14.0-beta1 v5.14.0-alpha1 v5.13.2 v5.13.1 v5.13.0 v5.13.0-rc3 v5.13.0-rc2 v5.13.0-rc1 v5.13.0-beta4 v5.13.0-beta3 v5.13.0-beta2 v5.13.0-beta1 v5.13.0-alpha1 v5.12.7 v5.12.6 v5.12.5 v5.12.4 v5.12.3 v5.12.2 v5.12.1 v5.12.0 v5.12.0-rc2 v5.12.0-rc1 v5.12.0-beta4 v5.12.0-beta3 v5.12.0-beta2 v5.12.0-beta1 v5.12.0-alpha1 v5.11.3 v5.11.2 v5.11.1 v5.11.0 v5.11.0-rc2 v5.11.0-rc1 v5.11.0-beta4 v5.11.0-beta3 v5.11.0-beta2 v5.11.0-beta1 v5.11.0-alpha1 v5.10.1 v5.10.0 v5.10.0-rc3 v5.10.0-rc2 v5.10.0-rc1 v5.10.0-beta4 v5.10.0-beta3 v5.10.0-beta2 v5.10.0-beta1 v5.10.0-alpha1 v5.9.9 v5.9.8 v5.9.7 v5.9.6 v5.9.5 v5.9.4 v5.9.3 v5.9.2 v5.9.1 v5.9.0 v5.9.0-rc2 v5.9.0-rc1 v5.9.0-beta4 v5.9.0-beta3 v5.9.0-beta2 v5.9.0-beta1 v5.9.0-alpha1 v5.8.0 v5.8.0-rc1 v5.8.0-beta1 v5.8.0-alpha1 v5.7.1 v5.7.0 v5.7.0-rc1 v5.7.0-beta1 v5.7.0-alpha1 v5.6.3 v5.6.2 v5.6.1 v5.6.1-1 v5.6.0 v5.6.0-rc1 v5.6.0-beta1 v5.6.0-alpha1 v5.5.1 v5.5.0 v5.5.0-rc1 v5.5.0-beta1 v5.5.0-alpha1 v5.4.2 v5.4.1 v5.4.0 v5.4.0-rc1 v5.4.0-beta1 v5.4.0-alpha1 v5.3.2 v5.3.1 v5.3.0 v5.3.0-rc1 v5.3.0-beta1 v5.3.0-alpha1 v5.2.1 v5.2.0 v5.2.0-rc1 v5.2.0-beta1 v5.2.0-alpha1 v5.1.1 v5.1.0 v5.1.0-rc2 v5.1.0-rc1 v5.1.0-beta1 v5.1.0-alpha1
No related merge requests found
Showing with 53 additions and 1 deletion
...@@ -46,22 +46,68 @@ import "private" ...@@ -46,22 +46,68 @@ import "private"
/*! /*!
\qmltype CheckBox \qmltype CheckBox
\inqmlmodule QtDesktop 1.0 \inqmlmodule QtDesktop 1.0
\brief CheckBox is doing bla...bla... \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.
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.
*/ */
FocusScope { FocusScope {
id: checkBox id: checkBox
/*!
Emitted whenever the checkbox is clicked.
*/
signal clicked signal clicked
/*!
\qmlproperty bool pressed
This property is \c true if the checkbox is pressed.
Set this property to manually invoke a mouse click.
*/
property alias pressed: behavior.effectivePressed property alias pressed: behavior.effectivePressed
/*!
\qmlproperty bool checked
This property is \c true if the checkbox is checked.
*/
property alias checked: behavior.checked property alias checked: behavior.checked
/*!
\qmlproperty bool containsMouse
This property is \c true if the checkbox currently contains the mouse
cursor.
*/
property alias containsMouse: behavior.containsMouse property alias containsMouse: behavior.containsMouse
/*!
This property is \c true if the checkbox takes the focus when it is
pressed; \l{QQuickItem::forceActiveFocus()}{forceActiveFocus()} will be
called on the checkbox.
*/
property bool activeFocusOnPress: false property bool activeFocusOnPress: false
property alias exclusiveGroup: behavior.exclusiveGroup property alias exclusiveGroup: behavior.exclusiveGroup
/*!
This property holds the text that the label should display.
*/
property string text property string text
/*!
\internal
*/
property var styleHints:[] property var styleHints:[]
// implementation // implementation
...@@ -71,6 +117,12 @@ FocusScope { ...@@ -71,6 +117,12 @@ FocusScope {
implicitWidth: Math.max(120, loader.item ? loader.item.implicitWidth : 0) implicitWidth: Math.max(120, loader.item ? loader.item.implicitWidth : 0)
implicitHeight: loader.item ? loader.item.implicitHeight : 0 implicitHeight: loader.item ? loader.item.implicitHeight : 0
/*!
The style that should be applied to the checkbox. Custom style
components can be created with:
\codeline Qt.createComponent("path/to/style.qml", checkBoxId);
*/
property Component style: Qt.createComponent(Settings.THEME_PATH + "/CheckBoxStyle.qml", checkBox) property Component style: Qt.createComponent(Settings.THEME_PATH + "/CheckBoxStyle.qml", checkBox)
Loader { Loader {
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment