aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJ-P Nurmi <jpnurmi@qt.io>2017-10-23 13:39:00 +0200
committerJ-P Nurmi <jpnurmi@qt.io>2017-10-23 13:24:35 +0000
commitf22c30720f8a191b7adaa8ddfe4d5dc4b6c1540f (patch)
tree0987f914fb4207c725bbbcf60d4399814a456588
parentd1990ff285a8a265fc41d193179ce8fb6746f7b3 (diff)
Docs: make button icons sound as worthy as text labels
Advertise text and icon properties equally. The additional mention of the icon property make icons sound somehow less worthy. :) Change-Id: I564954091ba9d484abda702ce4ba46ddebe7a082 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
-rw-r--r--src/quicktemplates2/qquickbutton.cpp7
-rw-r--r--src/quicktemplates2/qquickitemdelegate.cpp5
-rw-r--r--src/quicktemplates2/qquickmenuitem.cpp4
-rw-r--r--src/quicktemplates2/qquicktoolbutton.cpp5
4 files changed, 10 insertions, 11 deletions
diff --git a/src/quicktemplates2/qquickbutton.cpp b/src/quicktemplates2/qquickbutton.cpp
index b5a8ac1c..9cbf8b21 100644
--- a/src/quicktemplates2/qquickbutton.cpp
+++ b/src/quicktemplates2/qquickbutton.cpp
@@ -57,6 +57,10 @@ QT_BEGIN_NAMESPACE
a question. Typical buttons are \e OK, \e Apply, \e Cancel, \e Close,
\e Yes, \e No, and \e Help.
+ Button inherits its API from AbstractButton. For instance, you can set
+ \l {AbstractButton::text}{text}, display an \l {Icons in Qt Quick Controls 2}{icon},
+ and react to \l {AbstractButton::clicked}{clicks} using the AbstractButton API.
+
A button emits the signal \l {AbstractButton::}{clicked()} when it is activated by the user.
Connect to this signal to perform the button's action. Buttons also
provide the signals \l {AbstractButton::}{canceled()}, \l {AbstractButton::}{doubleClicked()}, \l {AbstractButton::}{pressed()},
@@ -77,9 +81,6 @@ QT_BEGIN_NAMESPACE
}
\endcode
- In addition to displaying \l {AbstractButton::}{text}, buttons can also
- display an \l [QML]{Button Icons}{icon}.
-
\sa {Customizing Button}, {Button Controls}
*/
diff --git a/src/quicktemplates2/qquickitemdelegate.cpp b/src/quicktemplates2/qquickitemdelegate.cpp
index 6eb04a46..044141f2 100644
--- a/src/quicktemplates2/qquickitemdelegate.cpp
+++ b/src/quicktemplates2/qquickitemdelegate.cpp
@@ -56,9 +56,8 @@ QT_BEGIN_NAMESPACE
in various views and controls, such as \l ListView and \l ComboBox.
ItemDelegate inherits its API from AbstractButton. For instance, you can set
- \l {AbstractButton::text}{text}, and react to \l {AbstractButton::clicked}{clicks}
- using the AbstractButton API. In addition to displaying text, item delegates
- can also display an \l [QML]{Button Icons}{icon}.
+ \l {AbstractButton::text}{text}, display an \l {Icons in Qt Quick Controls 2}{icon},
+ and react to \l {AbstractButton::clicked}{clicks} using the AbstractButton API.
\snippet qtquickcontrols2-itemdelegate.qml 1
diff --git a/src/quicktemplates2/qquickmenuitem.cpp b/src/quicktemplates2/qquickmenuitem.cpp
index 3a43dbfa..f71b9c35 100644
--- a/src/quicktemplates2/qquickmenuitem.cpp
+++ b/src/quicktemplates2/qquickmenuitem.cpp
@@ -57,8 +57,8 @@ QT_BEGIN_NAMESPACE
example.
MenuItem inherits its API from AbstractButton. For instance, you can set
- \l {AbstractButton::text}{text} and \l [QML]{Button Icons}{icon} using the
- AbstractButton API
+ \l {AbstractButton::text}{text} and \l {Icons in Qt Quick Controls 2}{icon}
+ using the AbstractButton API.
\code
Button {
diff --git a/src/quicktemplates2/qquicktoolbutton.cpp b/src/quicktemplates2/qquicktoolbutton.cpp
index 8c9e9bca..f87a58b2 100644
--- a/src/quicktemplates2/qquicktoolbutton.cpp
+++ b/src/quicktemplates2/qquicktoolbutton.cpp
@@ -58,9 +58,8 @@ QT_BEGIN_NAMESPACE
\snippet qtquickcontrols2-toolbar.qml 1
ToolButton inherits its API from AbstractButton. For instance, you can set
- \l {AbstractButton::text}{text}, and react to \l {AbstractButton::clicked}{clicks}
- using the AbstractButton API. In addition to displaying text, tool buttons
- can also display an \l [QML]{Button Icons}{icon}.
+ \l {AbstractButton::text}{text}, display an \l {Icons in Qt Quick Controls 2}{icon},
+ and react to \l {AbstractButton::clicked}{clicks} using the AbstractButton API.
\sa ToolBar, {Customizing ToolButton}, {Button Controls}
*/