diff options
author | J-P Nurmi <jpnurmi@theqtcompany.com> | 2015-06-10 16:41:59 +0200 |
---|---|---|
committer | J-P Nurmi <jpnurmi@theqtcompany.com> | 2015-06-10 16:52:18 +0000 |
commit | 2412b3238fa0746624975fcd66765346d8029a16 (patch) | |
tree | 12289e69fa228a9fe2dc7c70adbee77b5f07e20c /src/controls | |
parent | b57245ac65d339d4aa803d38005118b99783b2b3 (diff) |
Docs: ToggleButton
Change-Id: Id4db1808a42ee29c030f095f8c87542de1702ce0
Reviewed-by: J-P Nurmi <jpnurmi@theqtcompany.com>
Diffstat (limited to 'src/controls')
-rw-r--r-- | src/controls/doc/images/qtquickcontrols2-togglebutton-background.png | bin | 0 -> 2558 bytes | |||
-rw-r--r-- | src/controls/doc/images/qtquickcontrols2-togglebutton-checked.png | bin | 0 -> 1921 bytes | |||
-rw-r--r-- | src/controls/doc/images/qtquickcontrols2-togglebutton-disabled.png | bin | 0 -> 1921 bytes | |||
-rw-r--r-- | src/controls/doc/images/qtquickcontrols2-togglebutton-focused.png | bin | 0 -> 1788 bytes | |||
-rw-r--r-- | src/controls/doc/images/qtquickcontrols2-togglebutton-indicator.png | bin | 0 -> 2450 bytes | |||
-rw-r--r-- | src/controls/doc/images/qtquickcontrols2-togglebutton-label.png | bin | 0 -> 2530 bytes | |||
-rw-r--r-- | src/controls/doc/images/qtquickcontrols2-togglebutton-normal.png | bin | 0 -> 1444 bytes | |||
-rw-r--r-- | src/controls/doc/src/qtquickcontrols2-customize.qdoc | 24 | ||||
-rw-r--r-- | src/controls/qquicktogglebutton.cpp | 28 |
9 files changed, 51 insertions, 1 deletions
diff --git a/src/controls/doc/images/qtquickcontrols2-togglebutton-background.png b/src/controls/doc/images/qtquickcontrols2-togglebutton-background.png Binary files differnew file mode 100644 index 00000000..8f390b49 --- /dev/null +++ b/src/controls/doc/images/qtquickcontrols2-togglebutton-background.png diff --git a/src/controls/doc/images/qtquickcontrols2-togglebutton-checked.png b/src/controls/doc/images/qtquickcontrols2-togglebutton-checked.png Binary files differnew file mode 100644 index 00000000..fa883751 --- /dev/null +++ b/src/controls/doc/images/qtquickcontrols2-togglebutton-checked.png diff --git a/src/controls/doc/images/qtquickcontrols2-togglebutton-disabled.png b/src/controls/doc/images/qtquickcontrols2-togglebutton-disabled.png Binary files differnew file mode 100644 index 00000000..794692b0 --- /dev/null +++ b/src/controls/doc/images/qtquickcontrols2-togglebutton-disabled.png diff --git a/src/controls/doc/images/qtquickcontrols2-togglebutton-focused.png b/src/controls/doc/images/qtquickcontrols2-togglebutton-focused.png Binary files differnew file mode 100644 index 00000000..f52e4686 --- /dev/null +++ b/src/controls/doc/images/qtquickcontrols2-togglebutton-focused.png diff --git a/src/controls/doc/images/qtquickcontrols2-togglebutton-indicator.png b/src/controls/doc/images/qtquickcontrols2-togglebutton-indicator.png Binary files differnew file mode 100644 index 00000000..97e06e2c --- /dev/null +++ b/src/controls/doc/images/qtquickcontrols2-togglebutton-indicator.png diff --git a/src/controls/doc/images/qtquickcontrols2-togglebutton-label.png b/src/controls/doc/images/qtquickcontrols2-togglebutton-label.png Binary files differnew file mode 100644 index 00000000..3eb3ba35 --- /dev/null +++ b/src/controls/doc/images/qtquickcontrols2-togglebutton-label.png diff --git a/src/controls/doc/images/qtquickcontrols2-togglebutton-normal.png b/src/controls/doc/images/qtquickcontrols2-togglebutton-normal.png Binary files differnew file mode 100644 index 00000000..b066c565 --- /dev/null +++ b/src/controls/doc/images/qtquickcontrols2-togglebutton-normal.png diff --git a/src/controls/doc/src/qtquickcontrols2-customize.qdoc b/src/controls/doc/src/qtquickcontrols2-customize.qdoc index 8b02a62b..3843531c 100644 --- a/src/controls/doc/src/qtquickcontrols2-customize.qdoc +++ b/src/controls/doc/src/qtquickcontrols2-customize.qdoc @@ -125,4 +125,28 @@ \image qtquickcontrols2-switch-indicator.png \snippet Switch.qml indicator + + \section1 Customizing ToggleButton + + ToggleButton 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-togglebutton-background.png + + ToggleButton has no background item by default. + + \section3 Label + + \image qtquickcontrols2-togglebutton-label.png + + \snippet ToggleButton.qml label + + \section3 Indicator + + \image qtquickcontrols2-togglebutton-indicator.png + + \snippet ToggleButton.qml indicator */ diff --git a/src/controls/qquicktogglebutton.cpp b/src/controls/qquicktogglebutton.cpp index 40ea2e02..a399691e 100644 --- a/src/controls/qquicktogglebutton.cpp +++ b/src/controls/qquicktogglebutton.cpp @@ -46,7 +46,33 @@ QT_BEGIN_NAMESPACE \ingroup buttons \brief A toggle button control. - TODO + ToggleButton is an option button that can be dragged or toggled on + (checked) or off (unchecked). ToggleButtons are typically used to + select between two states. + + \table + \row \li \image qtquickcontrols2-togglebutton-normal.png + \li A toggle button in its normal state. + \row \li \image qtquickcontrols2-togglebutton-checked.png + \li A toggle button that is checked. + \row \li \image qtquickcontrols2-togglebutton-focused.png + \li A toggle button that has active focus. + \row \li \image qtquickcontrols2-togglebutton-disabled.png + \li A toggle button that is disabled. + \endtable + + \code + ColumnLayout { + ToggleButton { + text: qsTr("Wi-Fi") + } + ToggleButton { + text: qsTr("Bluetooth") + } + } + \endcode + + \sa {Customizing ToggleButton} */ QQuickToggleButton::QQuickToggleButton(QQuickItem *parent) : |