aboutsummaryrefslogtreecommitdiffstats
path: root/src/quicktemplates2
diff options
context:
space:
mode:
authorJ-P Nurmi <jpnurmi@qt.io>2016-08-13 14:18:07 +0200
committerJ-P Nurmi <jpnurmi@qt.io>2016-08-13 22:38:42 +0000
commit2c6cd0f7e0583243dd1d8438d6252e581e4e99f5 (patch)
tree5cd39b01489234732c4523888a4f9d1f3ee789bb /src/quicktemplates2
parente479bd241a5263b0ddfb4fad725dd26f34d5e39a (diff)
Doc: SwipeDelegate: move methods out of property groups
This is the same as 49b79522 for RangeSlider. QDoc doesn't support documenting methods inside a property group. Move them to the top level and use 'see also' to link between the group and method. Change-Id: I6af44fa44e107b62cedb38f60c04582ab4bbd299 Reviewed-by: J-P Nurmi <jpnurmi@qt.io>
Diffstat (limited to 'src/quicktemplates2')
-rw-r--r--src/quicktemplates2/qquickswipedelegate.cpp21
1 files changed, 12 insertions, 9 deletions
diff --git a/src/quicktemplates2/qquickswipedelegate.cpp b/src/quicktemplates2/qquickswipedelegate.cpp
index 1d5d3496..50eb7584 100644
--- a/src/quicktemplates2/qquickswipedelegate.cpp
+++ b/src/quicktemplates2/qquickswipedelegate.cpp
@@ -790,6 +790,17 @@ QQuickSwipeDelegate::QQuickSwipeDelegate(QQuickItem *parent) :
}
/*!
+ \since QtQuick.Controls 2.1
+ \qmlmethod void QtQuick.Controls::SwipeDelegate::swipe.close()
+
+ This method sets the \c position of the swipe to \c 0. Any animations
+ defined for the \l {Item::}{x} position of \l {Control::}{contentItem}
+ and \l {Control::}{background} will be triggered.
+
+ \sa swipe
+*/
+
+/*!
\qmlpropertygroup QtQuick.Controls::SwipeDelegate::swipe
\qmlproperty real QtQuick.Controls::SwipeDelegate::swipe.position
\qmlproperty bool QtQuick.Controls::SwipeDelegate::swipe.complete
@@ -799,7 +810,6 @@ QQuickSwipeDelegate::QQuickSwipeDelegate(QQuickItem *parent) :
\qmlproperty Item QtQuick.Controls::SwipeDelegate::swipe.leftItem
\qmlproperty Item QtQuick.Controls::SwipeDelegate::swipe.behindItem
\qmlproperty Item QtQuick.Controls::SwipeDelegate::swipe.rightItem
- \qmlmethod void QtQuick.Controls::SwipeDelegate::swipe.close()
\table
\header
@@ -866,13 +876,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 close()
- \li This method sets the \c position of the swipe to \c 0. Any animations
- defined for the \l {Item::}{x} position of \l {Control::}{contentItem}
- and \l {Control::}{background} will be triggered.
-
- This method was added in QtQuick.Controls 2.1.
- \row
\li completed()
\li This signal is emitted when \c complete becomes \c true.
@@ -883,7 +886,7 @@ QQuickSwipeDelegate::QQuickSwipeDelegate(QQuickItem *parent) :
This signal was added in QtQuick.Controls 2.1.
\endtable
- \sa {Control::}{contentItem}, {Control::}{background}
+ \sa {Control::}{contentItem}, {Control::}{background}, swipe.close()
*/
QQuickSwipe *QQuickSwipeDelegate::swipe() const
{