Add "Swipe to Remove" example

Change-Id: Ibab960ddd073ddcdfbf2b6e4492882662c7021b5
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>

2 files changed, 62 insertions, 0 deletions

diff --git a/examples/quickcontrols2/swipetoremove/doc/images/qtquickcontrols2-swipetoremove.png b/examples/quickcontrols2/swipetoremove/doc/images/qtquickcontrols2-swipetoremove.png
new file mode 100644
index 00000000..11005371
--- /dev/null
+++ b/examples/quickcontrols2/swipetoremove/doc/images/qtquickcontrols2-swipetoremove.png
diff --git a/examples/quickcontrols2/swipetoremove/doc/src/qtquickcontrols2-swipetoremove.qdoc b/examples/quickcontrols2/swipetoremove/doc/src/qtquickcontrols2-swipetoremove.qdoc
new file mode 100644
index 00000000..84fd3873
--- /dev/null
+++ b/examples/quickcontrols2/swipetoremove/doc/src/qtquickcontrols2-swipetoremove.qdoc
@@ -0,0 +1,62 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+    \example swipetoremove
+    \title Qt Quick Controls 2 - Swipe to Remove
+    \ingroup qtquickcontrols2-examples
+    \brief Demonstrates removing list items by swipe.
+
+    This example demonstrates how \l SwipeDelegate can be used to implement
+    removal of list items by swipe. This UI pattern is often used in touch
+    user interfaces.
+
+    \image qtquickcontrols2-swipetoremove.png
+
+    Each list item can be swiped to the left, which reveals a label on the
+    \l {SwipeDelegate::swipe}{right} side indicating that the item will be
+    removed if the swipe is completed. The following snippet contains the
+    implementation of the side item.
+
+    \snippet swipetoremove/swipetoremove.qml delegate
+
+    The following snippet presents how the logic of removing items is
+    implemented. When the swipe is \l {SwipeDelegate::swipe}{completed}, it
+    starts a timer tha waits a few seconds to let the user undo the remove
+    action. Once the undo timer triggers, the item is removed from the list:
+
+    \snippet swipetoremove/swipetoremove.qml removal
+
+    Finally, the removal of an item triggers the following transitions. The
+    \l {ListView::} {remove} transition applies to the item that is removed,
+    and the \l {ListView::}{displaced} transition applies to the other items
+    that got displaced due to the removal:
+
+    \snippet swipetoremove/swipetoremove.qml transitions
+
+    \include examples-run.qdocinc
+*/