From 375cd1cadb5aaa50d76490f0fecb401620fb5677 Mon Sep 17 00:00:00 2001 From: J-P Nurmi Date: Tue, 9 Jun 2015 22:27:41 +0200 Subject: RadioButton docs Change-Id: I158dac84c09172b7c27b227f673653feafb956af Reviewed-by: J-P Nurmi --- .../qtquickcontrols2-radiobutton-background.png | Bin 0 -> 2875 bytes .../qtquickcontrols2-radiobutton-checked.png | Bin 0 -> 2292 bytes .../qtquickcontrols2-radiobutton-disabled.png | Bin 0 -> 2366 bytes .../qtquickcontrols2-radiobutton-focused.png | Bin 0 -> 2332 bytes .../qtquickcontrols2-radiobutton-indicator.png | Bin 0 -> 2726 bytes .../images/qtquickcontrols2-radiobutton-label.png | Bin 0 -> 2848 bytes .../images/qtquickcontrols2-radiobutton-normal.png | Bin 0 -> 1883 bytes src/controls/qquickradiobutton.cpp | 62 ++++++++++++++++++++- src/imports/controls/RadioButton.qml | 4 ++ 9 files changed, 65 insertions(+), 1 deletion(-) create mode 100644 src/controls/doc/images/qtquickcontrols2-radiobutton-background.png create mode 100644 src/controls/doc/images/qtquickcontrols2-radiobutton-checked.png create mode 100644 src/controls/doc/images/qtquickcontrols2-radiobutton-disabled.png create mode 100644 src/controls/doc/images/qtquickcontrols2-radiobutton-focused.png create mode 100644 src/controls/doc/images/qtquickcontrols2-radiobutton-indicator.png create mode 100644 src/controls/doc/images/qtquickcontrols2-radiobutton-label.png create mode 100644 src/controls/doc/images/qtquickcontrols2-radiobutton-normal.png diff --git a/src/controls/doc/images/qtquickcontrols2-radiobutton-background.png b/src/controls/doc/images/qtquickcontrols2-radiobutton-background.png new file mode 100644 index 00000000..3ee9590e Binary files /dev/null and b/src/controls/doc/images/qtquickcontrols2-radiobutton-background.png differ diff --git a/src/controls/doc/images/qtquickcontrols2-radiobutton-checked.png b/src/controls/doc/images/qtquickcontrols2-radiobutton-checked.png new file mode 100644 index 00000000..9f71b6b6 Binary files /dev/null and b/src/controls/doc/images/qtquickcontrols2-radiobutton-checked.png differ diff --git a/src/controls/doc/images/qtquickcontrols2-radiobutton-disabled.png b/src/controls/doc/images/qtquickcontrols2-radiobutton-disabled.png new file mode 100644 index 00000000..f7fbcb7c Binary files /dev/null and b/src/controls/doc/images/qtquickcontrols2-radiobutton-disabled.png differ diff --git a/src/controls/doc/images/qtquickcontrols2-radiobutton-focused.png b/src/controls/doc/images/qtquickcontrols2-radiobutton-focused.png new file mode 100644 index 00000000..dfb8d51e Binary files /dev/null and b/src/controls/doc/images/qtquickcontrols2-radiobutton-focused.png differ diff --git a/src/controls/doc/images/qtquickcontrols2-radiobutton-indicator.png b/src/controls/doc/images/qtquickcontrols2-radiobutton-indicator.png new file mode 100644 index 00000000..f9e91709 Binary files /dev/null and b/src/controls/doc/images/qtquickcontrols2-radiobutton-indicator.png differ diff --git a/src/controls/doc/images/qtquickcontrols2-radiobutton-label.png b/src/controls/doc/images/qtquickcontrols2-radiobutton-label.png new file mode 100644 index 00000000..16c0ee08 Binary files /dev/null and b/src/controls/doc/images/qtquickcontrols2-radiobutton-label.png differ diff --git a/src/controls/doc/images/qtquickcontrols2-radiobutton-normal.png b/src/controls/doc/images/qtquickcontrols2-radiobutton-normal.png new file mode 100644 index 00000000..5a2d4bca Binary files /dev/null and b/src/controls/doc/images/qtquickcontrols2-radiobutton-normal.png differ diff --git a/src/controls/qquickradiobutton.cpp b/src/controls/qquickradiobutton.cpp index c42a0207..1dcc309c 100644 --- a/src/controls/qquickradiobutton.cpp +++ b/src/controls/qquickradiobutton.cpp @@ -46,7 +46,67 @@ QT_BEGIN_NAMESPACE \ingroup buttons \brief A radio button control. - TODO + RadioButton presents an option button that can be toggled on (checked) or + off (unchecked). Radio buttons are typically used to select one option + from a set of options. + + \table + \row \li \image qtquickcontrols2-radiobutton-normal.png + \li A radio button in its normal state. + \row \li \image qtquickcontrols2-radiobutton-checked.png + \li A radio button that is checked. + \row \li \image qtquickcontrols2-radiobutton-focused.png + \li A radio button that has active focus. + \row \li \image qtquickcontrols2-radiobutton-disabled.png + \li A radio button that is disabled. + \endtable + + \code + ColumnLayout { + ExclusiveGroup { id: group } + RadioButton { + checked: true + text: qsTr("First") + Exclusive.group: group + } + RadioButton { + text: qsTr("Second") + Exclusive.group: group + } + RadioButton { + text: qsTr("Third") + Exclusive.group: group + } + } + \endcode + + \section1 Structure + + RadioButton consists of three parts, \l {Control::background}{background}, + \l {Button::label}{label} and \l {Checkable::indicator}{indicator}. Their + implicit sizes are used to calculate the implicit size of the control. + + \section3 Background + + \image qtquickcontrols2-radiobutton-background.png + + RadioButton has no background item by default. + + \section3 Label + + \image qtquickcontrols2-radiobutton-label.png + + The following snippet presents the default label item implementation. + + \snippet RadioButton.qml label + + \section3 Indicator + + \image qtquickcontrols2-radiobutton-indicator.png + + The following snippet presents the default indicator item implementation. + + \snippet RadioButton.qml indicator \sa ExclusiveGroup */ diff --git a/src/imports/controls/RadioButton.qml b/src/imports/controls/RadioButton.qml index 31c198ac..106b382e 100644 --- a/src/imports/controls/RadioButton.qml +++ b/src/imports/controls/RadioButton.qml @@ -55,6 +55,7 @@ AbstractRadioButton { padding: Theme.padding + //! [indicator] indicator: Rectangle { implicitWidth: 20 implicitHeight: 20 @@ -80,7 +81,9 @@ AbstractRadioButton { border.color: control.Theme.frameColor } } + //! [indicator] + //! [label] label: Text { x: control.mirrored ? control.leftPadding : (indicator.x + indicator.width + control.Theme.spacing) y: control.topPadding @@ -94,4 +97,5 @@ AbstractRadioButton { horizontalAlignment: Text.AlignLeft verticalAlignment: Text.AlignVCenter } + //! [label] } -- cgit v1.2.3