summaryrefslogtreecommitdiffstats
path: root/src/gui/kernel/qstandardgestures.cpp
diff options
context:
space:
mode:
authorMartin Smith <msmith@trolltech.com>2009-08-31 10:29:08 (GMT)
committerMartin Smith <msmith@trolltech.com>2009-08-31 10:31:56 (GMT)
commit0c4a6ba2573713aea1867599b1d872aa7c523daf (patch)
tree8a915a13bf7768d289c174500ffd711f06f47bf9 /src/gui/kernel/qstandardgestures.cpp
parentf1d8ae975f1979c17509aa56785a1d663e145215 (diff)
downloadQt-0c4a6ba2573713aea1867599b1d872aa7c523daf.zip
Qt-0c4a6ba2573713aea1867599b1d872aa7c523daf.tar.gz
Qt-0c4a6ba2573713aea1867599b1d872aa7c523daf.tar.bz2
doc: Fixed several qdoc errors.
Diffstat (limited to 'src/gui/kernel/qstandardgestures.cpp')
-rw-r--r--src/gui/kernel/qstandardgestures.cpp60
1 files changed, 48 insertions, 12 deletions
diff --git a/src/gui/kernel/qstandardgestures.cpp b/src/gui/kernel/qstandardgestures.cpp
index de6e7c7..d96019d 100644
--- a/src/gui/kernel/qstandardgestures.cpp
+++ b/src/gui/kernel/qstandardgestures.cpp
@@ -63,11 +63,23 @@ QWidgetPrivate *qt_widget_private(QWidget *widget);
*/
/*!
- Creates a new Pan gesture handler object and marks it as a child of \a
- parent.
+ \enum QSwipeGesture::SwipeDirection
+ \brief This enum specifies the direction of the swipe gesture.
+
+ \value NoDirection
+ \value Left
+ \value Right
+ \value Up
+ \value Down
+*/
+
+/*!
+ Creates a new pan gesture handler object and marks it as a child of
+ \a parent. The pan gesture handler watches \a gestureTarget for its
+ events.
- On some platform like Windows it's necessary to provide a non-null widget
- as \a parent to get native gesture support.
+ On some platform like Windows it's necessary to provide a non-null
+ widget as \a parent to get native gesture support.
*/
QPanGesture::QPanGesture(QWidget *gestureTarget, QObject *parent)
: QGesture(*new QPanGesturePrivate, gestureTarget, parent)
@@ -306,11 +318,12 @@ QSizeF QPanGesture::lastOffset() const
*/
/*!
- Creates a new Pinch gesture handler object and marks it as a child of \a
- parent.
+ Creates a new Pinch gesture handler object and marks it as a child
+ of \a parent. The pan gesture handler watches \a gestureTarget for its
+ events.
- On some platform like Windows it's necessary to provide a non-null widget
- as \a parent to get native gesture support.
+ On some platform like Windows it's necessary to provide a non-null
+ widget as \a parent to get native gesture support.
*/
QPinchGesture::QPinchGesture(QWidget *gestureTarget, QObject *parent)
: QGesture(*new QPinchGesturePrivate, gestureTarget, parent)
@@ -523,11 +536,12 @@ QPointF QPinchGesture::startCenterPoint() const
*/
/*!
- Creates a new Swipe gesture handler object and marks it as a child of \a
- parent.
+ Creates a new Swipe gesture handler object and marks it as a
+ child of \a parent. The swipe gesture handler watches \a
+ gestureTarget for its events.
- On some platform like Windows it's necessary to provide a non-null widget
- as \a parent to get native gesture support.
+ On some platform like Windows it's necessary to provide a non-null
+ widget as \a parent to get native gesture support.
*/
QSwipeGesture::QSwipeGesture(QWidget *gestureTarget, QObject *parent)
: QGesture(*new QSwipeGesturePrivate, gestureTarget, parent)
@@ -556,12 +570,25 @@ void QSwipeGesturePrivate::setupGestureTarget(QObject *newGestureTarget)
QGesturePrivate::setupGestureTarget(newGestureTarget);
}
+/*!
+ \property QSwipeGesture::swipeAngle
+
+ Holds the angle of the swipe gesture, 0..360.
+*/
qreal QSwipeGesture::swipeAngle() const
{
Q_D(const QSwipeGesture);
return d->swipeAngle;
}
+/*!
+ \property QSwipeGesture::horizontalDirection
+
+ Holds the direction for the horizontal component of the swipe
+ gesture, SwipeDirection::Left or SwipeDirection::Right.
+ SwipeDirection::NoDirection if there is no horizontal
+ component to the swipe gesture.
+*/
QSwipeGesture::SwipeDirection QSwipeGesture::horizontalDirection() const
{
Q_D(const QSwipeGesture);
@@ -573,6 +600,15 @@ QSwipeGesture::SwipeDirection QSwipeGesture::horizontalDirection() const
return QSwipeGesture::Left;
}
+
+/*!
+ \property QSwipeGesture::verticalDirection
+
+ Holds the direction for the vertical component of the swipe
+ gesture, SwipeDirection::Down or SwipeDirection::Up.
+ SwipeDirection::NoDirection if there is no vertical
+ component to the swipe gesture.
+*/
QSwipeGesture::SwipeDirection QSwipeGesture::verticalDirection() const
{
Q_D(const QSwipeGesture);