diff options
author | J-P Nurmi <jpnurmi@qt.io> | 2016-12-20 15:25:24 +0100 |
---|---|---|
committer | J-P Nurmi <jpnurmi@qt.io> | 2016-12-20 15:53:28 +0000 |
commit | 66cca16867594f27b6d9e44101f1bd34d165c8ac (patch) | |
tree | 572bbe5cb18efa4603c8b7ca0be11d564bb01a91 /src | |
parent | 2071c1b059ae19e560c6568e522a155c78d76a5e (diff) |
Doc: SwipeDelegate: document grouped signals with \qmlsignal
This makes them appear in the list of signals at the top of
the documentation. The same was done for methods earlier.
a506a0ac added the swipe.opened() and swipe.closed() signals
but missed a changelog entry:
[ChangeLog][Controls][SwipeDelegate] Added swipe.opened() and
swipe.closed() signals, which are emitted when the delegate has
been opened or closed by swipe, and the respective transition has
finished.
Change-Id: Iacd2befc691ab7ed8209736595d8ad98e86e637a
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Diffstat (limited to 'src')
-rw-r--r-- | src/quicktemplates2/qquickswipedelegate.cpp | 70 |
1 files changed, 41 insertions, 29 deletions
diff --git a/src/quicktemplates2/qquickswipedelegate.cpp b/src/quicktemplates2/qquickswipedelegate.cpp index 75bfa5c2..10be2ac2 100644 --- a/src/quicktemplates2/qquickswipedelegate.cpp +++ b/src/quicktemplates2/qquickswipedelegate.cpp @@ -991,6 +991,47 @@ QQuickSwipeDelegate::QQuickSwipeDelegate(QQuickItem *parent) : */ /*! + \since QtQuick.Controls 2.2 + \qmlsignal void QtQuick.Controls::SwipeDelegate::swipe.opened() + + This signal is emitted when the delegate has been swiped open + and the transition has finished. + + It is useful for performing some action upon completion of a swipe. + For example, it can be used to remove the delegate from the list + that it is in. + + \sa swipe, swipe.closed() +*/ + +/*! + \since QtQuick.Controls 2.2 + \qmlsignal void QtQuick.Controls::SwipeDelegate::swipe.closed() + + This signal is emitted when the delegate has been swiped to closed + and the transition has finished. + + It is useful for performing some action upon cancellation of a swipe. + For example, it can be used to cancel the removal of the delegate from + the list that it is in. + + \sa swipe, swipe.opened() +*/ + +/*! + \since QtQuick.Controls 2.1 + \qmlsignal void QtQuick.Controls::SwipeDelegate::swipe.completed() + + This signal is emitted when \c swipe.complete becomes \c true. + + It is useful for performing some action upon completion of a swipe. + For example, it can be used to remove the delegate from the list + that it is in. + + \sa swipe +*/ + +/*! \qmlpropertygroup QtQuick.Controls::SwipeDelegate::swipe \qmlproperty real QtQuick.Controls::SwipeDelegate::swipe.position \qmlproperty bool QtQuick.Controls::SwipeDelegate::swipe.complete @@ -1071,35 +1112,6 @@ QQuickSwipeDelegate::QQuickSwipeDelegate(QQuickItem *parent) : If \c right has not been set, or the position hasn't changed since creation of the SwipeDelegate, this property will be \c null. - \row - \li completed() - \li This signal is emitted when \c complete becomes \c true. - - It is useful for performing some action upon completion of a swipe. - For example, it can be used to remove the delegate from the list - that it is in. - - This signal was added in QtQuick.Controls 2.1. - \row - \li opened() - \li This signal is emitted when the delegate has been swiped open - and the transition has finished. - - It is useful for performing some action upon completion of a swipe. - For example, it can be used to remove the delegate from the list - that it is in. - - This signal was added in QtQuick.Controls 2.2. - \row - \li closed() - \li This signal is emitted when the delegate has been swiped to closed - and the transition has finished. - - It is useful for performing some action upon cancellation of a swipe. - For example, it can be used to cancel the removal of the delegate from - the list that it is in. - - This signal was added in QtQuick.Controls 2.2. \endtable \sa {Control::}{contentItem}, {Control::}{background}, swipe.open(), swipe.close() |