aboutsummaryrefslogtreecommitdiffstats
path: root/src/templates/qquickswipedelegate.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/templates/qquickswipedelegate.cpp')
-rw-r--r--src/templates/qquickswipedelegate.cpp845
1 files changed, 845 insertions, 0 deletions
diff --git a/src/templates/qquickswipedelegate.cpp b/src/templates/qquickswipedelegate.cpp
new file mode 100644
index 00000000..b66c2203
--- /dev/null
+++ b/src/templates/qquickswipedelegate.cpp
@@ -0,0 +1,845 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the Qt Labs Templates module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** 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 Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later as published by the Free
+** Software Foundation and appearing in the file LICENSE.GPL included in
+** the packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qquickswipedelegate_p.h"
+#include "qquickcontrol_p_p.h"
+#include "qquickabstractbutton_p_p.h"
+
+#include <QtGui/qstylehints.h>
+#include <QtGui/private/qguiapplication_p.h>
+#include <QtGui/qpa/qplatformtheme.h>
+#include <QtQml/qqmlinfo.h>
+
+QT_BEGIN_NAMESPACE
+
+/*!
+ \qmltype SwipeDelegate
+ \inherits AbstractButton
+ \instantiates QQuickSwipeDelegate
+ \inqmlmodule Qt.labs.controls
+ \brief A swipable item delegate.
+
+ SwipeDelegate presents a view item that can be swiped left or right to
+ 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}, make items \l {AbstractButton::checkable}{checkable},
+ 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
+ \l {SwipeDelegate::}{exposure} grouped property object. For example,
+ \c exposure.position holds the position of the
+ swipe within the range \c -1.0 to \c 1.0. The \c exposure.left
+ property determines which item will be displayed when the control is swiped
+ to the right, and vice versa for \c exposure.right. The positioning of these
+ components is left to applications to decide. For example, without specifying
+ any position for \c exposure.left or \c exposure.right, the following will
+ occur:
+
+ \image qtlabscontrols-swipedelegate.gif
+
+ If \c exposure.left and \c exposure.right are anchored to the left and
+ right of the \l background item (respectively), they'll behave like this:
+
+ \image qtlabscontrols-swipedelegate-leading-trailing.gif
+
+ When using \c exposure.left and \c exposure.right, the control cannot be
+ swiped past the left and right edges. To achieve this type of "wrapping"
+ behavior, set \c exposure.behind instead. This will result in the same
+ item being shown regardless of which direction the control is swiped. For
+ example, in the image below, we set \c exposure.behind and then swipe the
+ control repeatedly in both directions:
+
+ \image qtlabscontrols-swipedelegate-behind.gif
+
+ \labs
+
+ \sa {Customizing SwipeDelegate}
+*/
+
+class QQuickSwipeExposurePrivate : public QObjectPrivate
+{
+ Q_DECLARE_PUBLIC(QQuickSwipeExposure)
+
+public:
+ QQuickSwipeExposurePrivate(QQuickSwipeDelegate *control) :
+ control(control),
+ positionBeforePress(0),
+ position(0),
+ wasActive(false),
+ active(false),
+ left(nullptr),
+ behind(nullptr),
+ right(nullptr),
+ leftItem(nullptr),
+ behindItem(nullptr),
+ rightItem(nullptr)
+ {
+ }
+
+ static QQuickSwipeExposurePrivate *get(QQuickSwipeExposure *exposure);
+
+ QQuickItem *createDelegateItem(QQmlComponent *component);
+ QQuickItem *showRelevantItemForPosition(qreal position);
+ QQuickItem *createRelevantItemForDistance(qreal distance);
+ void createLeftItem();
+ void createBehindItem();
+ void createRightItem();
+ void createAndShowLeftItem();
+ void createAndShowBehindItem();
+ void createAndShowRightItem();
+
+ void warnAboutMixingDelegates();
+ void warnAboutSettingDelegatesWhileVisible();
+
+ QQuickSwipeDelegate *control;
+ // Same range as position, but is set before press events so that we can
+ // keep track of which direction the user must swipe when using left and right delegates.
+ qreal positionBeforePress;
+ qreal position;
+ // A "less strict" version of active that is true if active was true
+ // before the last press event.
+ bool wasActive;
+ bool active;
+ QQmlComponent *left;
+ QQmlComponent *behind;
+ QQmlComponent *right;
+ QQuickItem *leftItem;
+ QQuickItem *behindItem;
+ QQuickItem *rightItem;
+};
+
+QQuickSwipeExposurePrivate *QQuickSwipeExposurePrivate::get(QQuickSwipeExposure *exposure)
+{
+ return exposure->d_func();
+}
+
+QQuickItem *QQuickSwipeExposurePrivate::createDelegateItem(QQmlComponent *component)
+{
+ // If we don't use the correct context, it won't be possible to refer to
+ // the control's id from within the delegates.
+ QQmlContext *creationContext = component->creationContext();
+ // The component might not have been created in QML, in which case
+ // the creation context will be null and we have to create it ourselves.
+ if (!creationContext)
+ creationContext = qmlContext(control);
+ QQmlContext *context = new QQmlContext(creationContext);
+ context->setContextObject(control);
+ QQuickItem *item = qobject_cast<QQuickItem*>(component->beginCreate(context));
+ if (item) {
+ item->setParentItem(control);
+ component->completeCreate();
+ }
+ return item;
+}
+
+QQuickItem *QQuickSwipeExposurePrivate::showRelevantItemForPosition(qreal position)
+{
+ if (qFuzzyIsNull(position))
+ return nullptr;
+
+ if (behind) {
+ createAndShowBehindItem();
+ return behindItem;
+ }
+
+ if (right && position < 0.0) {
+ createAndShowRightItem();
+ return rightItem;
+ }
+
+ if (left && position > 0.0) {
+ createAndShowLeftItem();
+ return leftItem;
+ }
+
+ return nullptr;
+}
+
+QQuickItem *QQuickSwipeExposurePrivate::createRelevantItemForDistance(qreal distance)
+{
+ if (qFuzzyIsNull(distance))
+ return nullptr;
+
+ if (behind) {
+ createBehindItem();
+ return behindItem;
+ }
+
+ // a) If the position before the press was 0.0, we know that *any* movement
+ // whose distance is negative will result in the right item being shown and
+ // vice versa.
+ // b) Once the control has been exposed (that is, swiped to the left or right,
+ // and hence the position is either -1.0 or 1.0), we must use the width of the
+ // relevant item to determine if the distance is larger than that item,
+ // in order to know whether or not to display it.
+ // c) If the control has been exposed, and the swipe is larger than the width
+ // of the relevant item from which the swipe started from, we must show the
+ // item on the other side (if any).
+
+ if (right) {
+ if ((distance < 0.0 && positionBeforePress == 0.0) /* a) */
+ || (rightItem && positionBeforePress == -1.0 && distance < rightItem->width()) /* b) */
+ || (leftItem && positionBeforePress == 1.0 && qAbs(distance) > leftItem->width())) /* c) */ {
+ createRightItem();
+ return rightItem;
+ }
+ }
+
+ if (left) {
+ if ((distance > 0.0 && positionBeforePress == 0.0) /* a) */
+ || (leftItem && positionBeforePress == 1.0 && qAbs(distance) < leftItem->width()) /* b) */
+ || (rightItem && positionBeforePress == -1.0 && qAbs(distance) > rightItem->width())) /* c) */ {
+ createLeftItem();
+ return leftItem;
+ }
+ }
+
+ return nullptr;
+}
+
+void QQuickSwipeExposurePrivate::createLeftItem()
+{
+ if (!leftItem) {
+ Q_Q(QQuickSwipeExposure);
+ q->setLeftItem(createDelegateItem(left));
+ if (!leftItem)
+ qmlInfo(control) << "Failed to create left item:" << left->errors();
+ }
+}
+
+void QQuickSwipeExposurePrivate::createBehindItem()
+{
+ if (!behindItem) {
+ Q_Q(QQuickSwipeExposure);
+ q->setBehindItem(createDelegateItem(behind));
+ if (!behindItem)
+ qmlInfo(control) << "Failed to create behind item:" << behind->errors();
+ }
+}
+
+void QQuickSwipeExposurePrivate::createRightItem()
+{
+ if (!rightItem) {
+ Q_Q(QQuickSwipeExposure);
+ q->setRightItem(createDelegateItem(right));
+ if (!rightItem)
+ qmlInfo(control) << "Failed to create right item:" << right->errors();
+ }
+}
+
+void QQuickSwipeExposurePrivate::createAndShowLeftItem()
+{
+ createLeftItem();
+
+ if (leftItem)
+ leftItem->setVisible(true);
+
+ if (rightItem)
+ rightItem->setVisible(false);
+}
+
+void QQuickSwipeExposurePrivate::createAndShowBehindItem()
+{
+ createBehindItem();
+
+ if (behindItem)
+ behindItem->setVisible(true);
+}
+
+void QQuickSwipeExposurePrivate::createAndShowRightItem()
+{
+ createRightItem();
+
+ // This item may have already existed but was hidden.
+ if (rightItem)
+ rightItem->setVisible(true);
+
+ // The left item isn't visible when the right item is visible, so save rendering effort by hiding it.
+ if (leftItem)
+ leftItem->setVisible(false);
+}
+
+void QQuickSwipeExposurePrivate::warnAboutMixingDelegates()
+{
+ qmlInfo(control) << "cannot set both behind and left/right properties";
+}
+
+void QQuickSwipeExposurePrivate::warnAboutSettingDelegatesWhileVisible()
+{
+ qmlInfo(control) << "left/right/behind properties may only be set when exposure.position is 0";
+}
+
+QQuickSwipeExposure::QQuickSwipeExposure(QQuickSwipeDelegate *control) :
+ QObject(*(new QQuickSwipeExposurePrivate(control)))
+{
+}
+
+QQmlComponent *QQuickSwipeExposure::left() const
+{
+ Q_D(const QQuickSwipeExposure);
+ return d->left;
+}
+
+void QQuickSwipeExposure::setLeft(QQmlComponent *left)
+{
+ Q_D(QQuickSwipeExposure);
+ if (left == d->left)
+ return;
+
+ if (d->behind) {
+ d->warnAboutMixingDelegates();
+ return;
+ }
+
+ if (!qFuzzyIsNull(d->position)) {
+ d->warnAboutSettingDelegatesWhileVisible();
+ return;
+ }
+
+ d->left = left;
+
+ if (!d->left) {
+ delete d->leftItem;
+ d->leftItem = nullptr;
+ }
+
+ emit leftChanged();
+}
+
+QQmlComponent *QQuickSwipeExposure::behind() const
+{
+ Q_D(const QQuickSwipeExposure);
+ return d->behind;
+}
+
+void QQuickSwipeExposure::setBehind(QQmlComponent *behind)
+{
+ Q_D(QQuickSwipeExposure);
+ if (behind == d->behind)
+ return;
+
+ if (d->left || d->right) {
+ d->warnAboutMixingDelegates();
+ return;
+ }
+
+ if (!qFuzzyIsNull(d->position)) {
+ d->warnAboutSettingDelegatesWhileVisible();
+ return;
+ }
+
+ d->behind = behind;
+
+ if (!d->behind) {
+ delete d->behindItem;
+ d->behindItem = nullptr;
+ }
+
+ emit behindChanged();
+}
+
+QQmlComponent *QQuickSwipeExposure::right() const
+{
+ Q_D(const QQuickSwipeExposure);
+ return d->right;
+}
+
+void QQuickSwipeExposure::setRight(QQmlComponent *right)
+{
+ Q_D(QQuickSwipeExposure);
+ if (right == d->right)
+ return;
+
+ if (d->behind) {
+ d->warnAboutMixingDelegates();
+ return;
+ }
+
+ if (!qFuzzyIsNull(d->position)) {
+ d->warnAboutSettingDelegatesWhileVisible();
+ return;
+ }
+
+ d->right = right;
+
+ if (!d->right) {
+ delete d->rightItem;
+ d->rightItem = nullptr;
+ }
+
+ emit rightChanged();
+}
+
+QQuickItem *QQuickSwipeExposure::leftItem() const
+{
+ Q_D(const QQuickSwipeExposure);
+ return d->leftItem;
+}
+
+void QQuickSwipeExposure::setLeftItem(QQuickItem *item)
+{
+ Q_D(QQuickSwipeExposure);
+ if (item == d->leftItem)
+ return;
+
+ delete d->leftItem;
+ d->leftItem = item;
+
+ if (d->leftItem) {
+ d->leftItem->setParentItem(d->control);
+
+ if (qFuzzyIsNull(d->leftItem->z()))
+ d->leftItem->setZ(-2);
+ }
+
+ emit leftItemChanged();
+}
+
+QQuickItem *QQuickSwipeExposure::behindItem() const
+{
+ Q_D(const QQuickSwipeExposure);
+ return d->behindItem;
+}
+
+void QQuickSwipeExposure::setBehindItem(QQuickItem *item)
+{
+ Q_D(QQuickSwipeExposure);
+ if (item == d->behindItem)
+ return;
+
+ delete d->behindItem;
+ d->behindItem = item;
+
+ if (d->behindItem) {
+ d->behindItem->setParentItem(d->control);
+
+ if (qFuzzyIsNull(d->behindItem->z()))
+ d->behindItem->setZ(-2);
+ }
+
+ emit behindItemChanged();
+}
+
+QQuickItem *QQuickSwipeExposure::rightItem() const
+{
+ Q_D(const QQuickSwipeExposure);
+ return d->rightItem;
+}
+
+void QQuickSwipeExposure::setRightItem(QQuickItem *item)
+{
+ Q_D(QQuickSwipeExposure);
+ if (item == d->rightItem)
+ return;
+
+ delete d->rightItem;
+ d->rightItem = item;
+
+ if (d->rightItem) {
+ d->rightItem->setParentItem(d->control);
+
+ if (qFuzzyIsNull(d->rightItem->z()))
+ d->rightItem->setZ(-2);
+ }
+
+ emit rightItemChanged();
+}
+
+qreal QQuickSwipeExposure::position() const
+{
+ Q_D(const QQuickSwipeExposure);
+ return d->position;
+}
+
+void QQuickSwipeExposure::setPosition(qreal position)
+{
+ Q_D(QQuickSwipeExposure);
+ const qreal adjustedPosition = qBound(-1.0, position, 1.0);
+ if (adjustedPosition == d->position)
+ return;
+
+ d->position = adjustedPosition;
+
+ QQuickItem *relevantItem = d->showRelevantItemForPosition(d->position);
+ const qreal relevantWidth = relevantItem ? relevantItem->width() : 0.0;
+ d->control->contentItem()->setProperty("x", d->position * relevantWidth + d->control->leftPadding());
+ if (QQuickItem *background = d->control->background())
+ background->setProperty("x", d->position * relevantWidth);
+
+ emit positionChanged();
+}
+
+bool QQuickSwipeExposure::isActive() const
+{
+ Q_D(const QQuickSwipeExposure);
+ return d->active;
+}
+
+void QQuickSwipeExposure::setActive(bool active)
+{
+ Q_D(QQuickSwipeExposure);
+ if (active == d->active)
+ return;
+
+ d->active = active;
+ emit activeChanged();
+}
+
+class QQuickSwipeDelegatePrivate : public QQuickAbstractButtonPrivate
+{
+ Q_DECLARE_PUBLIC(QQuickSwipeDelegate)
+
+public:
+ QQuickSwipeDelegatePrivate(QQuickSwipeDelegate *control) :
+ exposure(control)
+ {
+ }
+
+ bool handleMousePressEvent(QQuickItem *item, QMouseEvent *event);
+ bool handleMouseMoveEvent(QQuickItem *item, QMouseEvent *event);
+ bool handleMouseReleaseEvent(QQuickItem *item, QMouseEvent *event);
+
+ void resizeContent() override;
+
+ QQuickSwipeExposure exposure;
+};
+
+bool QQuickSwipeDelegatePrivate::handleMousePressEvent(QQuickItem *item, QMouseEvent *event)
+{
+ Q_Q(QQuickSwipeDelegate);
+ QQuickSwipeExposurePrivate *exposurePrivate = QQuickSwipeExposurePrivate::get(&exposure);
+ // If the position is 0, we want to handle events ourself - we don't want child items to steal them.
+ // This code will only get called when a child item has been created;
+ // events will go through the regular channels (mousePressEvent()) until then.
+ if (qFuzzyIsNull(exposurePrivate->position)) {
+ q->mousePressEvent(event);
+ return true;
+ }
+
+ exposurePrivate->positionBeforePress = exposurePrivate->position;
+ pressPoint = item->mapToItem(q, event->pos());
+ return false;
+}
+
+bool QQuickSwipeDelegatePrivate::handleMouseMoveEvent(QQuickItem *item, QMouseEvent *event)
+{
+ Q_Q(QQuickSwipeDelegate);
+
+ if (autoRepeat) {
+ stopPressRepeat();
+ } else if (holdTimer > 0) {
+ if (QLineF(pressPoint, event->localPos()).length() > QGuiApplication::styleHints()->startDragDistance())
+ stopPressAndHold();
+ }
+
+ // Protect against division by zero.
+ if (width == 0)
+ return false;
+
+ // Don't bother reacting to events if we don't have any delegates.
+ QQuickSwipeExposurePrivate *exposurePrivate = QQuickSwipeExposurePrivate::get(&exposure);
+ if (!exposurePrivate->left && !exposurePrivate->right && !exposurePrivate->behind)
+ return false;
+
+ // Don't handle move events for the control if it wasn't pressed.
+ if (item == q && !pressed)
+ return false;
+
+ const qreal distance = (event->pos() - pressPoint).x();
+ if (!q->keepMouseGrab()) {
+ // Taken from QQuickDrawer::handleMouseMoveEvent; see comments there.
+ int threshold = qMax(20, QGuiApplication::styleHints()->startDragDistance() + 5);
+ const bool overThreshold = QQuickWindowPrivate::dragOverThreshold(distance, Qt::XAxis, event, threshold);
+ if (window && overThreshold) {
+ QQuickItem *grabber = q->window()->mouseGrabberItem();
+ if (!grabber || !grabber->keepMouseGrab()) {
+ q->grabMouse();
+ q->setKeepMouseGrab(overThreshold);
+ q->setPressed(true);
+ exposure.setActive(false);
+ }
+ }
+ }
+
+ if (q->keepMouseGrab()) {
+ // Ensure we don't try to calculate a position when the user tried to drag
+ // to the left when the left item is already exposed, and vice versa.
+ // The code below assumes that the drag is valid, so if we don't have this check,
+ // the wrong items are visible and the swiping wraps.
+ if (exposurePrivate->behind
+ || ((exposurePrivate->left || exposurePrivate->right)
+ && (qFuzzyIsNull(exposurePrivate->positionBeforePress)
+ || (exposurePrivate->positionBeforePress == -1.0 && distance >= 0.0)
+ || (exposurePrivate->positionBeforePress == 1.0 && distance <= 0.0)))) {
+
+ // We must instantiate the items here so that we can calculate the
+ // position against the width of the relevant item.
+ QQuickItem *relevantItem = exposurePrivate->createRelevantItemForDistance(distance);
+ // If there isn't any relevant item, the user may have swiped back to the 0 position,
+ // or they swiped back to a position that is equal to positionBeforePress.
+ const qreal normalizedDistance = relevantItem ? distance / relevantItem->width() : 0.0;
+ qreal position = 0;
+
+ // If the control was exposed before the drag begun, the distance should be inverted.
+ // For example, if the control had been swiped to the right, the position would be 1.0.
+ // If the control was then swiped the left by a distance of -20 pixels, the normalized
+ // distance might be -0.2, for example, which cannot be used as the position; the swipe
+ // started from the right, so we account for that by adding the position.
+ if (qFuzzyIsNull(normalizedDistance)) {
+ // There are two cases when the normalizedDistance can be 0,
+ // and we must distinguish between them:
+ //
+ // a) The swipe returns to the position that it was at before the press event.
+ // In this case, the distance will be 0.
+ // There would have been many position changes in the meantime, so we can't just
+ // ignore the move event; we have to set position to what it was before the press.
+ //
+ // b) If the position was at, 1.0, for example, and the control was then swiped
+ // to the left by the exact width of the left item, there won't be any relevant item
+ // (because the swipe's position would be at 0.0). In turn, the normalizedDistance
+ // would be 0 (because of the lack of a relevant item), but the distance will be non-zero.
+ position = qFuzzyIsNull(distance) ? exposurePrivate->positionBeforePress : 0;
+ } else if (!exposurePrivate->wasActive) {
+ position = normalizedDistance;
+ } else {
+ position = distance > 0 ? normalizedDistance - 1.0 : normalizedDistance + 1.0;
+ }
+
+ exposure.setPosition(position);
+ }
+ }
+
+ event->accept();
+
+ return q->keepMouseGrab();
+}
+
+bool QQuickSwipeDelegatePrivate::handleMouseReleaseEvent(QQuickItem *, QMouseEvent *)
+{
+ Q_Q(QQuickSwipeDelegate);
+
+ QQuickSwipeExposurePrivate *exposurePrivate = QQuickSwipeExposurePrivate::get(&exposure);
+
+ if (exposurePrivate->position > 0.5) {
+ exposure.setPosition(1.0);
+ exposure.setActive(true);
+ exposurePrivate->wasActive = true;
+ } else if (exposurePrivate->position < -0.5) {
+ exposure.setPosition(-1.0);
+ exposure.setActive(true);
+ exposurePrivate->wasActive = true;
+ } else {
+ exposure.setPosition(0.0);
+ exposure.setActive(false);
+ exposurePrivate->wasActive = false;
+ }
+
+ q->setKeepMouseGrab(false);
+
+ return true;
+}
+
+void QQuickSwipeDelegatePrivate::resizeContent()
+{
+ // If the background and contentItem are outside the visible bounds
+ // of the control (we clip anything outside the bounds), we don't want
+ // to call QQuickControlPrivate's implementation of this function,
+ // as it repositions the contentItem to be visible.
+ QQuickSwipeExposurePrivate *exposurePrivate = QQuickSwipeExposurePrivate::get(&exposure);
+ if (!exposurePrivate->active) {
+ QQuickAbstractButtonPrivate::resizeContent();
+ }
+}
+
+QQuickSwipeDelegate::QQuickSwipeDelegate(QQuickItem *parent) :
+ QQuickAbstractButton(*(new QQuickSwipeDelegatePrivate(this)), parent)
+{
+ setFiltersChildMouseEvents(true);
+}
+
+/*!
+ \qmlpropertygroup Qt.labs.controls::SwipeDelegate::exposure
+ \qmlproperty real Qt.labs.controls::SwipeDelegate::exposure.position
+ \qmlproperty bool Qt.labs.controls::SwipeDelegate::exposure.active
+ \qmlproperty Component Qt.labs.controls::SwipeDelegate::exposure.left
+ \qmlproperty Component Qt.labs.controls::SwipeDelegate::exposure.behind
+ \qmlproperty Component Qt.labs.controls::SwipeDelegate::exposure.right
+ \qmlproperty Item Qt.labs.controls::SwipeDelegate::exposure.leftItem
+ \qmlproperty Item Qt.labs.controls::SwipeDelegate::exposure.behindItem
+ \qmlproperty Item Qt.labs.controls::SwipeDelegate::exposure.rightItem
+
+ \table
+ \header
+ \li Property
+ \li Description
+ \row
+ \li position
+ \li This property holds the position of the swipe relative to either
+ side of the control. When this value reaches either
+ \c -1.0 (left side) or \c 1.0 (right side) and the mouse button is
+ released, \c active will be \c true.
+ \row
+ \li active
+ \li This property holds whether the control is fully exposed. It is
+ equivalent to \c {!pressed && (position == -1.0 || position == 1.0)}.
+
+ When active is \c true, any interactive items declared in \l left
+ or \l right will receive mouse events.
+ \row
+ \li left
+ \li This property holds the left delegate.
+
+ The left delegate sits behind both \l {Control::}{contentItem} and
+ \l background. When the SwipeDelegate is swiped to the right, this item
+ will be gradually revealed.
+ \row
+ \li behind
+ \li This property holds the delegate that is shown when the
+ SwipeDelegate is swiped to both the left and right.
+
+ As with the \c left and \c right delegates, it sits behind both
+ \l {Control::}{contentItem} and \l background. However, a SwipeDelegate
+ whose \c behind has been set can be continuously swiped from either
+ side, and will always show the same item.
+ \row
+ \li right
+ \li This property holds the right delegate.
+
+ The right delegate sits behind both \l {Control::}{contentItem} and
+ \l background. When the SwipeDelegate is swiped to the left, this item
+ will be gradually revealed.
+ \row
+ \li leftItem
+ \li This property holds the item instantiated from the \c left component.
+
+ If \c left has not been set, or the position hasn't changed since
+ creation of the SwipeDelegate, this property will be \c null.
+ \row
+ \li behindItem
+ \li This property holds the item instantiated from the \c behind component.
+
+ If \c behind has not been set, or the position hasn't changed since
+ creation of the SwipeDelegate, this property will be \c null.
+ \row
+ \li rightItem
+ \li This property holds the item instantiated from the \c right component.
+
+ If \c right has not been set, or the position hasn't changed since
+ creation of the SwipeDelegate, this property will be \c null.
+ \endtable
+
+ \sa {Control::}{contentItem}, {Control::}{background}
+*/
+QQuickSwipeExposure *QQuickSwipeDelegate::exposure() const
+{
+ Q_D(const QQuickSwipeDelegate);
+ return const_cast<QQuickSwipeExposure*>(&d->exposure);
+}
+
+static bool isChildOrGrandchildOf(QQuickItem *child, QQuickItem *item)
+{
+ return item && (child == item || item->isAncestorOf(child));
+}
+
+bool QQuickSwipeDelegate::childMouseEventFilter(QQuickItem *child, QEvent *event)
+{
+ Q_D(QQuickSwipeDelegate);
+ // The contentItem is, by default, usually a non-interactive item like Text, and
+ // the same applies to the background. This means that simply stacking the left/right/behind
+ // items before these items won't allow us to get mouse events when the control is not currently exposed
+ // but has been previously. Therefore, we instead call setFiltersChildMouseEvents(true) in the constructor
+ // and filter out child events only when the child is the left/right/behind item.
+ const QQuickSwipeExposurePrivate *exposurePrivate = QQuickSwipeExposurePrivate::get(&d->exposure);
+ if (!isChildOrGrandchildOf(child, exposurePrivate->leftItem) && !isChildOrGrandchildOf(child, exposurePrivate->behindItem)
+ && !isChildOrGrandchildOf(child, exposurePrivate->rightItem)) {
+ return false;
+ }
+
+ switch (event->type()) {
+ case QEvent::MouseButtonPress: {
+ return d->handleMousePressEvent(child, static_cast<QMouseEvent *>(event));
+ } case QEvent::MouseMove: {
+ return d->handleMouseMoveEvent(child, static_cast<QMouseEvent *>(event));
+ } case QEvent::MouseButtonRelease: {
+ // Make sure that the control gets release events if it has created child
+ // items that are stealing events from it.
+ QMouseEvent *mouseEvent = static_cast<QMouseEvent *>(event);
+ QQuickAbstractButton::mouseReleaseEvent(mouseEvent);
+ return d->handleMouseReleaseEvent(child, mouseEvent);
+ } default:
+ return false;
+ }
+}
+
+// We only override this to set positionBeforePress;
+// otherwise, it's the same as the base class implementation.
+void QQuickSwipeDelegate::mousePressEvent(QMouseEvent *event)
+{
+ Q_D(QQuickSwipeDelegate);
+ QQuickAbstractButton::mousePressEvent(event);
+ QQuickSwipeExposurePrivate *exposurePrivate = QQuickSwipeExposurePrivate::get(&d->exposure);
+ exposurePrivate->positionBeforePress = exposurePrivate->position;
+}
+
+void QQuickSwipeDelegate::mouseMoveEvent(QMouseEvent *event)
+{
+ Q_D(QQuickSwipeDelegate);
+ d->handleMouseMoveEvent(this, event);
+}
+
+void QQuickSwipeDelegate::mouseReleaseEvent(QMouseEvent *event)
+{
+ Q_D(QQuickSwipeDelegate);
+ QQuickAbstractButton::mouseReleaseEvent(event);
+ d->handleMouseReleaseEvent(this, event);
+}
+
+QFont QQuickSwipeDelegate::defaultFont() const
+{
+ return QQuickControlPrivate::themeFont(QPlatformTheme::ItemViewFont);
+}
+
+#ifndef QT_NO_ACCESSIBILITY
+QAccessible::Role QQuickSwipeDelegate::accessibleRole() const
+{
+ return QAccessible::ListItem;
+}
+#endif
+
+QT_END_NAMESPACE