diff options
author | Mitch Curtis <mitch.curtis@qt.io> | 2016-09-19 11:13:11 +0200 |
---|---|---|
committer | Mitch Curtis <mitch.curtis@qt.io> | 2016-09-19 14:00:59 +0000 |
commit | 8bac9a45693b14ce6f1f39d67f57c2327a0adb4e (patch) | |
tree | 2576d3ec47bc1873e9715d7536d52235596192ba /src | |
parent | 2b0db3a4809e6316114ec65bd55fa80ddefe97c5 (diff) |
CheckDelegate: expand detailed description
Mention the API that is inherited and the difference between it and
CheckBox.
Change-Id: I931fa410e90b686d0ac27a2fd5945ef9e8b6f949
Task-number: QTBUG-55904
Reviewed-by: J-P Nurmi <jpnurmi@qt.io>
Diffstat (limited to 'src')
-rw-r--r-- | src/quicktemplates2/qquickcheckdelegate.cpp | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/src/quicktemplates2/qquickcheckdelegate.cpp b/src/quicktemplates2/qquickcheckdelegate.cpp index 09be5d60..249aaa95 100644 --- a/src/quicktemplates2/qquickcheckdelegate.cpp +++ b/src/quicktemplates2/qquickcheckdelegate.cpp @@ -54,9 +54,14 @@ QT_BEGIN_NAMESPACE CheckDelegate presents an item delegate that can be toggled on (checked) or off (unchecked). Check delegates are typically used to select one or more - options from a set of options. - - The state of the check delegate can be set with the + options from a set of options in a list. For smaller sets of options, or + for options that need to be uniquely identifiable, consider using + \l CheckBox instead. + + CheckDelegate inherits its API from \l ItemDelegate, which is inherited + from 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 check delegate can be set with the \l {AbstractButton::}{checked} property. In addition to the checked and unchecked states, there is a third state: @@ -75,7 +80,7 @@ QT_BEGIN_NAMESPACE } \endcode - \sa {Customizing CheckDelegate}, {Delegate Controls} + \sa {Customizing CheckDelegate}, {Delegate Controls}, CheckBox */ class QQuickCheckDelegatePrivate : public QQuickItemDelegatePrivate |