aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorMitch Curtis <mitch.curtis@qt.io>2016-09-19 11:29:23 +0200
committerMitch Curtis <mitch.curtis@qt.io>2016-09-19 14:01:04 +0000
commit3c6ea8948b67d758dc777b044df127d5514ecc08 (patch)
tree04bda9c70645a606b3709462fb2e69537ef56c0d /src
parent8bac9a45693b14ce6f1f39d67f57c2327a0adb4e (diff)
CheckBox: expand detailed description
Mention that the API is inherited from AbstractButton, and how it's different from CheckDelegate. Change-Id: I3de58b57ee3a00194312ab6bff1aa43ce58f3199 Task-number: QTBUG-55904 Reviewed-by: J-P Nurmi <jpnurmi@qt.io>
Diffstat (limited to 'src')
-rw-r--r--src/quicktemplates2/qquickcheckbox.cpp6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/quicktemplates2/qquickcheckbox.cpp b/src/quicktemplates2/qquickcheckbox.cpp
index 1daf69dc..a777c2b4 100644
--- a/src/quicktemplates2/qquickcheckbox.cpp
+++ b/src/quicktemplates2/qquickcheckbox.cpp
@@ -52,9 +52,11 @@ QT_BEGIN_NAMESPACE
CheckBox presents an option button that can be toggled on (checked) or
off (unchecked). Check boxes are typically used to select one or more
- options from a set of options.
+ options from a set of options. For larger sets of options, such as those
+ in a list, consider using \l CheckDelegate instead.
- The state of the checkbox can be set with the \l {AbstractButton::}{checked} property.
+ CheckBox inherits its API from \l AbstractButton. For instance, the
+ state of the checkbox can be set with the \l {AbstractButton::}{checked} property.
In addition to the checked and unchecked states, there is a third state:
partially checked. The partially checked state can be enabled using the