aboutsummaryrefslogtreecommitdiffstats
path: root/src/quicktemplates2/qquickcheckbox.cpp
diff options
context:
space:
mode:
authorMitch Curtis <mitch.curtis@qt.io>2016-09-30 14:55:05 +0200
committerMitch Curtis <mitch.curtis@qt.io>2016-09-30 13:11:49 +0000
commit7a418e470b1fa91d73d7ee8d299bd4a95b40eab9 (patch)
tree5f780d221e78ca7af9f484c681fa49154b54ab6b /src/quicktemplates2/qquickcheckbox.cpp
parentb749f0041d14234083d150e48d273f08c4b1d253 (diff)
CheckBox: add GIFs to documentation
- Replace the state table in the detailed description with a GIF. - Add a GIF for the tri-state documentation. Change-Id: I00f3835edad6eb454d06847ab342ce0eeb30156b Task-number: QTBUG-55904 Reviewed-by: J-P Nurmi <jpnurmi@qt.io>
Diffstat (limited to 'src/quicktemplates2/qquickcheckbox.cpp')
-rw-r--r--src/quicktemplates2/qquickcheckbox.cpp17
1 files changed, 6 insertions, 11 deletions
diff --git a/src/quicktemplates2/qquickcheckbox.cpp b/src/quicktemplates2/qquickcheckbox.cpp
index a777c2b4..ae967c34 100644
--- a/src/quicktemplates2/qquickcheckbox.cpp
+++ b/src/quicktemplates2/qquickcheckbox.cpp
@@ -50,6 +50,8 @@ QT_BEGIN_NAMESPACE
\ingroup qtquickcontrols2-buttons
\brief An option button that can be checked or unchecked.
+ \image qtquickcontrols2-checkbox.gif
+
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. For larger sets of options, such as those
@@ -65,17 +67,6 @@ QT_BEGIN_NAMESPACE
the checkbox. This state is useful when several child nodes are selected
in a treeview, for example.
- \table
- \row \li \image qtquickcontrols2-checkbox-normal.png
- \li A check box in its normal state.
- \row \li \image qtquickcontrols2-checkbox-checked.png
- \li A check box that is checked.
- \row \li \image qtquickcontrols2-checkbox-focused.png
- \li A check box that has active focus.
- \row \li \image qtquickcontrols2-checkbox-disabled.png
- \li A check box that is disabled.
- \endtable
-
\code
ColumnLayout {
CheckBox {
@@ -120,6 +111,10 @@ QQuickCheckBox::QQuickCheckBox(QQuickItem *parent) :
This property holds whether the checkbox is a tri-state checkbox.
+ In the animation below, the first checkbox is tri-state:
+
+ \image qtquickcontrols2-checkbox-tristate.gif
+
The default is \c false, i.e., the checkbox has only two states.
*/
bool QQuickCheckBox::isTristate() const