aboutsummaryrefslogtreecommitdiffstats
path: root/src/quicktemplates2/qquickradiobutton.cpp
diff options
context:
space:
mode:
authorMitch Curtis <mitch.curtis@qt.io>2016-10-06 16:31:23 +0200
committerMitch Curtis <mitch.curtis@qt.io>2016-10-07 10:46:05 +0000
commit73cd7f2c6faff63dd31ffc896b032f0db932ecc2 (patch)
treee17490d56634d55000522e96a1cc90c121ea549b /src/quicktemplates2/qquickradiobutton.cpp
parentcd425eb9b6674da0f3e920dc9829cb20ebe2ca95 (diff)
RadioButton: fix documentation review findings
Change-Id: I018038b41f05244876c6d18a4015a18a1b65fbc0 Task-number: QTBUG-55904 Reviewed-by: J-P Nurmi <jpnurmi@qt.io>
Diffstat (limited to 'src/quicktemplates2/qquickradiobutton.cpp')
-rw-r--r--src/quicktemplates2/qquickradiobutton.cpp15
1 files changed, 13 insertions, 2 deletions
diff --git a/src/quicktemplates2/qquickradiobutton.cpp b/src/quicktemplates2/qquickradiobutton.cpp
index 6037ff0d..a8d11377 100644
--- a/src/quicktemplates2/qquickradiobutton.cpp
+++ b/src/quicktemplates2/qquickradiobutton.cpp
@@ -56,10 +56,21 @@ QT_BEGIN_NAMESPACE
off (unchecked). Radio buttons are typically used to select one option
from a set of options.
+ RadioButton inherits its API from \l AbstractButton. For instance,
+ you can set \l {AbstractButton::text}{text} and react to
+ \l {AbstractButton::clicked}{clicks} using the AbstractButton API.
+ The state of the radio button can be set with the
+ \l {AbstractButton::}{checked} property.
+
Radio buttons are \l {AbstractButton::autoExclusive}{auto-exclusive}
by default. Only one button can be checked at any time amongst radio
buttons that belong to the same parent item; checking another button
- automatically unchecks the previously checked one.
+ automatically unchecks the previously checked one. For radio buttons
+ that do not share a common parent, ButtonGroup can be used to manage
+ exclusivity.
+
+ \l RadioDelegate is similar to RadioButton, except that it is typically
+ used in views.
\code
ColumnLayout {
@@ -76,7 +87,7 @@ QT_BEGIN_NAMESPACE
}
\endcode
- \sa ButtonGroup, {Customizing RadioButton}, {Button Controls}
+ \sa ButtonGroup, {Customizing RadioButton}, {Button Controls}, RadioDelegate
*/
QQuickRadioButton::QQuickRadioButton(QQuickItem *parent) :