From 3fc2c58ff6864ac1b7b6d6979f13bfc4249cde8f Mon Sep 17 00:00:00 2001 From: J-P Nurmi Date: Wed, 14 Oct 2015 16:16:10 +0200 Subject: Docs: Buttons group Change-Id: I2945a3c367244ec0b92cc8f2ba84a7b052d9a514 Reviewed-by: Mitch Curtis --- .../controls/doc/images/qtlabscontrols-button.png | Bin 0 -> 1467 bytes .../doc/images/qtlabscontrols-checkbox.png | Bin 0 -> 2778 bytes .../doc/images/qtlabscontrols-radiobutton.png | Bin 0 -> 3454 bytes .../images/qtlabscontrols-switch-background.png | Bin 2136 -> 2465 bytes .../doc/images/qtlabscontrols-switch-checked.png | Bin 2344 -> 2822 bytes .../doc/images/qtlabscontrols-switch-disabled.png | Bin 2401 -> 2964 bytes .../doc/images/qtlabscontrols-switch-focused.png | Bin 2417 -> 2747 bytes .../doc/images/qtlabscontrols-switch-indicator.png | Bin 2014 -> 2315 bytes .../doc/images/qtlabscontrols-switch-label.png | Bin 2082 -> 2415 bytes .../doc/images/qtlabscontrols-switch-normal.png | Bin 1925 -> 2200 bytes .../controls/doc/images/qtlabscontrols-switch.png | Bin 0 -> 2414 bytes .../doc/images/qtlabscontrols-toolbutton.png | Bin 0 -> 2143 bytes .../controls/doc/src/qtlabscontrols-buttons.qdoc | 76 +++++++++++++++++++++ src/templates/qquickbutton.cpp | 4 +- src/templates/qquickcheckbox.cpp | 4 +- src/templates/qquickradiobutton.cpp | 4 +- src/templates/qquickswitch.cpp | 4 +- src/templates/qquicktoolbutton.cpp | 4 +- 18 files changed, 86 insertions(+), 10 deletions(-) create mode 100644 src/imports/controls/doc/images/qtlabscontrols-button.png create mode 100644 src/imports/controls/doc/images/qtlabscontrols-checkbox.png create mode 100644 src/imports/controls/doc/images/qtlabscontrols-radiobutton.png create mode 100644 src/imports/controls/doc/images/qtlabscontrols-switch.png create mode 100644 src/imports/controls/doc/images/qtlabscontrols-toolbutton.png create mode 100644 src/imports/controls/doc/src/qtlabscontrols-buttons.qdoc (limited to 'src') diff --git a/src/imports/controls/doc/images/qtlabscontrols-button.png b/src/imports/controls/doc/images/qtlabscontrols-button.png new file mode 100644 index 00000000..f0a13b8c Binary files /dev/null and b/src/imports/controls/doc/images/qtlabscontrols-button.png differ diff --git a/src/imports/controls/doc/images/qtlabscontrols-checkbox.png b/src/imports/controls/doc/images/qtlabscontrols-checkbox.png new file mode 100644 index 00000000..af9c9e20 Binary files /dev/null and b/src/imports/controls/doc/images/qtlabscontrols-checkbox.png differ diff --git a/src/imports/controls/doc/images/qtlabscontrols-radiobutton.png b/src/imports/controls/doc/images/qtlabscontrols-radiobutton.png new file mode 100644 index 00000000..74f7cc73 Binary files /dev/null and b/src/imports/controls/doc/images/qtlabscontrols-radiobutton.png differ diff --git a/src/imports/controls/doc/images/qtlabscontrols-switch-background.png b/src/imports/controls/doc/images/qtlabscontrols-switch-background.png index bfa24fe6..5b10cffd 100644 Binary files a/src/imports/controls/doc/images/qtlabscontrols-switch-background.png and b/src/imports/controls/doc/images/qtlabscontrols-switch-background.png differ diff --git a/src/imports/controls/doc/images/qtlabscontrols-switch-checked.png b/src/imports/controls/doc/images/qtlabscontrols-switch-checked.png index fadf851a..88036efb 100644 Binary files a/src/imports/controls/doc/images/qtlabscontrols-switch-checked.png and b/src/imports/controls/doc/images/qtlabscontrols-switch-checked.png differ diff --git a/src/imports/controls/doc/images/qtlabscontrols-switch-disabled.png b/src/imports/controls/doc/images/qtlabscontrols-switch-disabled.png index 328ff6a9..bf266c52 100644 Binary files a/src/imports/controls/doc/images/qtlabscontrols-switch-disabled.png and b/src/imports/controls/doc/images/qtlabscontrols-switch-disabled.png differ diff --git a/src/imports/controls/doc/images/qtlabscontrols-switch-focused.png b/src/imports/controls/doc/images/qtlabscontrols-switch-focused.png index 795868b8..84108e3f 100644 Binary files a/src/imports/controls/doc/images/qtlabscontrols-switch-focused.png and b/src/imports/controls/doc/images/qtlabscontrols-switch-focused.png differ diff --git a/src/imports/controls/doc/images/qtlabscontrols-switch-indicator.png b/src/imports/controls/doc/images/qtlabscontrols-switch-indicator.png index 5fc9c83b..97e236a2 100644 Binary files a/src/imports/controls/doc/images/qtlabscontrols-switch-indicator.png and b/src/imports/controls/doc/images/qtlabscontrols-switch-indicator.png differ diff --git a/src/imports/controls/doc/images/qtlabscontrols-switch-label.png b/src/imports/controls/doc/images/qtlabscontrols-switch-label.png index 57deabc6..9fc5ad3b 100644 Binary files a/src/imports/controls/doc/images/qtlabscontrols-switch-label.png and b/src/imports/controls/doc/images/qtlabscontrols-switch-label.png differ diff --git a/src/imports/controls/doc/images/qtlabscontrols-switch-normal.png b/src/imports/controls/doc/images/qtlabscontrols-switch-normal.png index a162e898..0297e98e 100644 Binary files a/src/imports/controls/doc/images/qtlabscontrols-switch-normal.png and b/src/imports/controls/doc/images/qtlabscontrols-switch-normal.png differ diff --git a/src/imports/controls/doc/images/qtlabscontrols-switch.png b/src/imports/controls/doc/images/qtlabscontrols-switch.png new file mode 100644 index 00000000..5c8901c4 Binary files /dev/null and b/src/imports/controls/doc/images/qtlabscontrols-switch.png differ diff --git a/src/imports/controls/doc/images/qtlabscontrols-toolbutton.png b/src/imports/controls/doc/images/qtlabscontrols-toolbutton.png new file mode 100644 index 00000000..d608e4de Binary files /dev/null and b/src/imports/controls/doc/images/qtlabscontrols-toolbutton.png differ diff --git a/src/imports/controls/doc/src/qtlabscontrols-buttons.qdoc b/src/imports/controls/doc/src/qtlabscontrols-buttons.qdoc new file mode 100644 index 00000000..2f4b7845 --- /dev/null +++ b/src/imports/controls/doc/src/qtlabscontrols-buttons.qdoc @@ -0,0 +1,76 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qtlabscontrols-buttons.html + \title Buttons + + \annotatedlist qtlabscontrols-buttons + + Qt Labs Controls offers a selection of button-like controls. Each type + of button has its own target use case. + + \section1 Button + + \image qtlabscontrols-button.png + + \l {Qt.labs.controls::Button}{Button} presents a push-button control + that can be pushed or clicked by the user. Buttons are normally used + to perform an action, or to answer a question. Typical buttons are + \e OK, \e Apply, \e Cancel, \e Close, \e Yes, \e No, and \e Help. + + \section1 CheckBox + + \image qtlabscontrols-checkbox.png + + \l {Qt.labs.controls::CheckBox}{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. + + \section1 RadioButton + + \image qtlabscontrols-radiobutton.png + + \l {Qt.labs.controls::RadioButton}{RadioButton} presents an option button + that can be toggled on (checked) or off (unchecked). Radio buttons are + typically used to select one option from a set of options. + + \section1 Switch + + \image qtlabscontrols-switch.png + + \l {Qt.labs.controls::Switch}{Switch} is an option button that can be + dragged or toggled on (checked) or off (unchecked). Switches are typically + used to select between two states. + + \section1 ToolButton + + \image qtlabscontrols-toolbutton.png + + \l {Qt.labs.controls::ToolButton}{ToolButton} is functionally similar to + \l Button, but provides a look that is more suitable within a \l ToolBar. +*/ diff --git a/src/templates/qquickbutton.cpp b/src/templates/qquickbutton.cpp index 77638dfe..12234358 100644 --- a/src/templates/qquickbutton.cpp +++ b/src/templates/qquickbutton.cpp @@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE \inherits AbstractButton \instantiates QQuickButton \inqmlmodule Qt.labs.controls - \ingroup buttons + \ingroup qtlabscontrols-buttons \brief A button control. \image qtlabscontrols-button.gif @@ -78,7 +78,7 @@ QT_BEGIN_NAMESPACE } \endcode - \sa {Customizing Button} + \sa {Customizing Button}, Buttons */ class QQuickButtonPrivate : public QQuickAbstractButtonPrivate diff --git a/src/templates/qquickcheckbox.cpp b/src/templates/qquickcheckbox.cpp index 2f70be3e..029cc168 100644 --- a/src/templates/qquickcheckbox.cpp +++ b/src/templates/qquickcheckbox.cpp @@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE \inherits AbstractButton \instantiates QQuickCheckBox \inqmlmodule Qt.labs.controls - \ingroup buttons + \ingroup qtlabscontrols-buttons \brief A check box control. CheckBox presents an option button that can be toggled on (checked) or @@ -78,7 +78,7 @@ QT_BEGIN_NAMESPACE } \endcode - \sa {Customizing CheckBox} + \sa {Customizing CheckBox}, Buttons */ class QQuickCheckBoxPrivate : public QQuickAbstractButtonPrivate diff --git a/src/templates/qquickradiobutton.cpp b/src/templates/qquickradiobutton.cpp index 758cd0fb..6d9efd6c 100644 --- a/src/templates/qquickradiobutton.cpp +++ b/src/templates/qquickradiobutton.cpp @@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE \inherits AbstractButton \instantiates QQuickRadioButton \inqmlmodule Qt.labs.controls - \ingroup buttons + \ingroup qtlabscontrols-buttons \brief A radio button control. RadioButton presents an option button that can be toggled on (checked) or @@ -80,7 +80,7 @@ QT_BEGIN_NAMESPACE } \endcode - \sa ExclusiveGroup, {Customizing RadioButton} + \sa ExclusiveGroup, {Customizing RadioButton}, Buttons */ QQuickRadioButton::QQuickRadioButton(QQuickItem *parent) : diff --git a/src/templates/qquickswitch.cpp b/src/templates/qquickswitch.cpp index dc66f063..d259e6df 100644 --- a/src/templates/qquickswitch.cpp +++ b/src/templates/qquickswitch.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE \inherits AbstractButton \instantiates QQuickSwitch \inqmlmodule Qt.labs.controls - \ingroup buttons + \ingroup qtlabscontrols-buttons \brief A switch control. \image qtlabscontrols-switch.gif @@ -77,7 +77,7 @@ QT_BEGIN_NAMESPACE } \endcode - \sa {Customizing Switch} + \sa {Customizing Switch}, Buttons */ class QQuickSwitchPrivate : public QQuickAbstractButtonPrivate diff --git a/src/templates/qquicktoolbutton.cpp b/src/templates/qquicktoolbutton.cpp index c1b7b9dd..3c25c0d7 100644 --- a/src/templates/qquicktoolbutton.cpp +++ b/src/templates/qquicktoolbutton.cpp @@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE \inherits Button \instantiates QQuickToolButton \inqmlmodule Qt.labs.controls - \ingroup buttons + \ingroup qtlabscontrols-buttons \brief A tool button control. ToolButton is functionally similar to \l Button, but provides a look that @@ -70,7 +70,7 @@ QT_BEGIN_NAMESPACE } \endcode - \sa ToolBar, {Customizing ToolButton} + \sa ToolBar, {Customizing ToolButton}, Buttons */ QQuickToolButton::QQuickToolButton(QQuickItem *parent) : -- cgit v1.2.3