SwipeDelegate: fix documentation review findings

Change-Id: I8ff60306fac53abefde6d8e9fe7727036f264799
Task-number: QTBUG-55904
Reviewed-by: J-P Nurmi <jpnurmi@qt.io>

2 files changed, 74 insertions, 3 deletions

diff --git a/src/imports/controls/doc/snippets/qtquickcontrols2-swipedelegate.qml b/src/imports/controls/doc/snippets/qtquickcontrols2-swipedelegate.qml
new file mode 100644
index 00000000..db077057
--- /dev/null
+++ b/src/imports/controls/doc/snippets/qtquickcontrols2-swipedelegate.qml
@@ -0,0 +1,65 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 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$
+**
+****************************************************************************/
+
+import QtQuick 2.7
+import QtQuick.Controls 2.0
+
+//! [1]
+ListView {
+    width: 200
+    height: 300
+    clip: true
+    model: ListModel {
+        id: listModel
+        ListElement { title: "Electricity bill" }
+        ListElement { title: "Happy Birthday!" }
+        ListElement { title: "FW: Cat pictures" }
+        ListElement { title: "Hotel visit receipt" }
+        ListElement { title: "Customer service" }
+    }
+    delegate: SwipeDelegate {
+        id: swipeDelegate
+        text: title
+        width: parent.width
+
+        onClicked: if (swipe.complete) listModel.remove(index)
+
+        swipe.right: Rectangle {
+            color: swipeDelegate.swipe.complete && swipeDelegate.pressed ? "#333" : "#444"
+            width: parent.width
+            height: parent.height
+
+            Label {
+                font.pixelSize: swipeDelegate.font.pixelSize
+                text: qsTr("Remove")
+                color: "white"
+                anchors.centerIn: parent
+            }
+        }
+    }
+}
+//! [1]
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