aboutsummaryrefslogtreecommitdiffstats
path: root/src/quicktemplates2/qquickswipedelegate.cpp
diff options
context:
space:
mode:
authorMitch Curtis <mitch.curtis@qt.io>2016-10-17 16:02:58 +0200
committerMitch Curtis <mitch.curtis@qt.io>2016-10-17 16:09:58 +0000
commitb13c94c9fcac1bf8a4761c56776c82292d261827 (patch)
tree1c922921ea3c7ec01944ce28d5e853696519fd0e /src/quicktemplates2/qquickswipedelegate.cpp
parent18f6bec453f4046edc774edcf0d9f8e925aed2df (diff)
SwipeDelegate: fix documentation review findings
Change-Id: I8ff60306fac53abefde6d8e9fe7727036f264799 Task-number: QTBUG-55904 Reviewed-by: J-P Nurmi <jpnurmi@qt.io>
Diffstat (limited to 'src/quicktemplates2/qquickswipedelegate.cpp')
-rw-r--r--src/quicktemplates2/qquickswipedelegate.cpp12
1 files changed, 9 insertions, 3 deletions
diff --git a/src/quicktemplates2/qquickswipedelegate.cpp b/src/quicktemplates2/qquickswipedelegate.cpp
index fcdb9a7a..0edf7106 100644
--- a/src/quicktemplates2/qquickswipedelegate.cpp
+++ b/src/quicktemplates2/qquickswipedelegate.cpp
@@ -59,9 +59,15 @@ QT_BEGIN_NAMESPACE
expose more options or information. It is used as a delegate in views such
as \l ListView.
- SwipeDelegate 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 the following example, SwipeDelegate is used in a \l ListView to allow
+ items to be removed from it by swiping to the left:
+
+ \snippet qtquickcontrols2-swipedelegate.qml 1
+
+ SwipeDelegate inherits its API from \l ItemDelegate, which is inherited
+ from AbstractButton. For instance, you can set \l {AbstractButton::text}{text},
+ and react to \l {AbstractButton::clicked}{clicks} using the AbstractButton
+ API.
Information regarding the progress of a swipe, as well as the components
that should be shown upon swiping, are both available through the