aboutsummaryrefslogtreecommitdiffstats
path: root/src/imports/controls/doc/src/qtquickcontrols2-buttons.qdoc
diff options
context:
space:
mode:
authorVenugopal Shivashankar <venugopal.shivashankar@digia.com>2016-03-22 14:40:51 +0100
committerJ-P Nurmi <jpnurmi@theqtcompany.com>2016-03-22 21:21:52 +0000
commitdc5b4044fddfa31509610b22f9527435cd1c580c (patch)
tree0a5b217b05734cb624fe7887a18cb09b110ee566 /src/imports/controls/doc/src/qtquickcontrols2-buttons.qdoc
parentcd716f1b1c903b7a2fdfd82bb88959119ebca72d (diff)
Rename Qt Labs Controls to Qt Quick Controls 2 - doc filenames
Except the .qdocconf all .qdoc files are renamed to use "qtquickcontrols2" instead of "qtlabscontrols". Change-Id: I317a4e81ea4e78b63a0d4d849d7352f496824cb3 Reviewed-by: J-P Nurmi <jpnurmi@theqtcompany.com>
Diffstat (limited to 'src/imports/controls/doc/src/qtquickcontrols2-buttons.qdoc')
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-buttons.qdoc79
1 files changed, 79 insertions, 0 deletions
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-buttons.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-buttons.qdoc
new file mode 100644
index 00000000..b6610949
--- /dev/null
+++ b/src/imports/controls/doc/src/qtquickcontrols2-buttons.qdoc
@@ -0,0 +1,79 @@
+/****************************************************************************
+**
+** 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 Button Controls
+
+ Qt Labs Controls offers a selection of button-like controls.
+
+ \annotatedlist qtlabscontrols-buttons
+
+ Each type of button has its own specific target use case. The following
+ sections offer guidelines for choosing the appropriate type of button,
+ depending on the use case.
+
+ \section1 Button Control
+
+ \image qtquickcontrols-button.png
+
+ \l 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 Control
+
+ \image qtquickcontrols-checkbox.png
+
+ \l 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 Control
+
+ \image qtquickcontrols-radiobutton.png
+
+ \l 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 Control
+
+ \image qtquickcontrols-switch.png
+
+ \l 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 Control
+
+ \image qtquickcontrols-toolbutton.png
+
+ \l ToolButton is functionally similar to \l Button, but provides a look
+ that is more suitable within a \l ToolBar.
+*/