aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/handlers/qquickdraghandler.cpp
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@qt.io>2018-02-27 10:06:24 +0100
committerMartin Smith <martin.smith@qt.io>2018-02-28 08:30:12 +0000
commit7257be1c6da4c75bbfb27c42cae6d106db829ef3 (patch)
tree0b48cb111b79bc3fa603c9e5b0506677c1e07071 /src/quick/handlers/qquickdraghandler.cpp
parent6fa746fa61e35dc26e5286250ddc9488546f5b66 (diff)
doc: Fix several Can't link to errors
This update corrects several "Can't link to..." errors and splits a \qmlpropertygroup into two separate \qmlpropertygroups. Change-Id: Ic9b89a11eef64069154a932dd9dedf18279506a2 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
Diffstat (limited to 'src/quick/handlers/qquickdraghandler.cpp')
-rw-r--r--src/quick/handlers/qquickdraghandler.cpp50
1 files changed, 30 insertions, 20 deletions
diff --git a/src/quick/handlers/qquickdraghandler.cpp b/src/quick/handlers/qquickdraghandler.cpp
index a4c3d3dfb1..60b57206d3 100644
--- a/src/quick/handlers/qquickdraghandler.cpp
+++ b/src/quick/handlers/qquickdraghandler.cpp
@@ -53,20 +53,20 @@ QT_BEGIN_NAMESPACE
DragHandler is a handler that is used to interactively move an Item.
Like other Pointer Handlers, by default it is fully functional, and
- manipulates its \l target.
+ manipulates its \l {PointerHandler::target} {target}.
\snippet pointerHandlers/dragHandler.qml 0
It has properties to restrict the range of dragging.
If it is declared within one Item but is assigned a different
- \l {PointerHandler::target}, then it handles events within the
- bounds of the \l {PointerHandler::parent} Item but
+ \l {PointerHandler::target} {target}, then it handles events within the
+ bounds of the \l {PointerHandler::parent} {parent} Item but
manipulates the \c target Item instead:
\snippet pointerHandlers/dragHandlerDifferentTarget.qml 0
- A third way to use it is to set \l {PointerHandler::target} to
+ A third way to use it is to set \l {PointerHandler::target} {target} to
\c null and react to property changes in some other way:
\snippet pointerHandlers/dragHandlerNullTarget.qml 0
@@ -214,23 +214,33 @@ void QQuickDragHandler::setTranslation(const QVector2D &trans)
/*!
\qmlpropertygroup QtQuick::DragHandler::xAxis
+ \qmlproperty real QtQuick::DragHandler::xAxis.minimum
+ \qmlproperty real QtQuick::DragHandler::xAxis.maximum
+ \qmlproperty bool QtQuick::DragHandler::xAxis.enabled
+
+ \c xAxis controls the constraints for horizontal dragging.
+
+ \c minimum is the minimum acceptable value of \l {Item::x}{x} to be
+ applied to the \l {PointerHandler::target} {target}.
+ \c maximum is the maximum acceptable value of \l {Item::x}{x} to be
+ applied to the \l {PointerHandler::target} {target}.
+ If \c enabled is true, horizontal dragging is allowed.
+ */
+
+/*!
\qmlpropertygroup QtQuick::DragHandler::yAxis
- \qmlproperty real QtQuick::DragHandler::DragAxis::minimum
- \qmlproperty real QtQuick::DragHandler::DragAxis::maximum
- \qmlproperty real QtQuick::DragHandler::DragAxis::enabled
-
- \c xAxis and yAxis control the constraints for horizontal and vertical
- dragging, respectively.
-
- \value minimum
- The minimum acceptable value of \l {Item::x}{x} or \l {Item::y}{y}
- to be applied to the \l target
- \value maximum
- The maximum acceptable value of \l {Item::x}{x} or \l {Item::y}{y}
- to be applied to the \l target
- \value enabled
- Whether dragging in this direction is allowed at all
-*/
+ \qmlproperty real QtQuick::DragHandler::yAxis.minimum
+ \qmlproperty real QtQuick::DragHandler::yAxis.maximum
+ \qmlproperty bool QtQuick::DragHandler::yAxis.enabled
+
+ \c yAxis controls the constraints for vertical dragging.
+
+ \c minimum is the minimum acceptable value of \l {Item::y}{y} to be
+ applied to the \l {PointerHandler::target} {target}.
+ \c maximum is the maximum acceptable value of \l {Item::y}{y} to be
+ applied to the \l {PointerHandler::target} {target}.
+ If \c enabled is true, vertical dragging is allowed.
+ */
QQuickDragAxis::QQuickDragAxis()
: m_minimum(-DBL_MAX)
, m_maximum(DBL_MAX)