aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/handlers
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@qt.io>2018-02-19 15:10:10 +0100
committerMartin Smith <martin.smith@qt.io>2018-02-23 13:05:16 +0000
commit485e183062043b39c0b6ec57caee7032dfffc5b0 (patch)
tree6a15414169658b1548b061b0a6970c2ca09f78d8 /src/quick/handlers
parent5475f84af82668e25d40a31ad9c6ede438bf7dfe (diff)
doc: Correct mostly linking errors
This update corrects many qdoc warnings, mostly of the "Can't link to..." variety, but there were also a few qdoc comments added. As of this update, the qdoc warning count is 46 in QtDeclarative. Change-Id: Icf2d34c7ce7010ebfd9b474feacfe8af42f3fd5f Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'src/quick/handlers')
-rw-r--r--src/quick/handlers/qquickdraghandler.cpp9
-rw-r--r--src/quick/handlers/qquickpointerdevicehandler.cpp6
-rw-r--r--src/quick/handlers/qquickpointerhandler.cpp6
-rw-r--r--src/quick/handlers/qquickpointhandler.cpp39
-rw-r--r--src/quick/handlers/qquicksinglepointhandler.cpp7
5 files changed, 37 insertions, 30 deletions
diff --git a/src/quick/handlers/qquickdraghandler.cpp b/src/quick/handlers/qquickdraghandler.cpp
index 5180a840ca..a4c3d3dfb1 100644
--- a/src/quick/handlers/qquickdraghandler.cpp
+++ b/src/quick/handlers/qquickdraghandler.cpp
@@ -59,14 +59,15 @@ QT_BEGIN_NAMESPACE
It has properties to restrict the range of dragging.
- If it is declared within one Item but is assigned a different \l target,
- then it handles events within the bounds of the \l parent Item but
+ 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
manipulates the \c target Item instead:
\snippet pointerHandlers/dragHandlerDifferentTarget.qml 0
- A third way to use it is to set \l target to \c null and react to property
- changes in some other way:
+ A third way to use it is to set \l {PointerHandler::target} to
+ \c null and react to property changes in some other way:
\snippet pointerHandlers/dragHandlerNullTarget.qml 0
diff --git a/src/quick/handlers/qquickpointerdevicehandler.cpp b/src/quick/handlers/qquickpointerdevicehandler.cpp
index 1521b58d57..06831613b6 100644
--- a/src/quick/handlers/qquickpointerdevicehandler.cpp
+++ b/src/quick/handlers/qquickpointerdevicehandler.cpp
@@ -75,7 +75,8 @@ QQuickPointerDeviceHandler::~QQuickPointerDeviceHandler()
The types of pointing devices that can activate this Pointer Handler.
- By default, this property is set to \l PointerDevice.AllDevices.
+ By default, this property is set to
+ \l{QtQuick::PointerDevice::type} {PointerDevice.AllDevices}.
If you set it to an OR combination of device types, it will ignore events
from non-matching devices.
@@ -110,7 +111,8 @@ void QQuickPointerDeviceHandler::setAcceptedDevices(QQuickPointerDevice::DeviceT
The types of pointing instruments (finger, stylus, eraser, etc.)
that can activate this Pointer Handler.
- By default, this property is set to \l PointerDevice.AllPointerTypes.
+ By default, this property is set to
+ \l {QtQuick::PointerDevice::pointerType} {PointerDevice.AllPointerTypes}.
If you set it to an OR combination of device types, it will ignore events
from non-matching events.
diff --git a/src/quick/handlers/qquickpointerhandler.cpp b/src/quick/handlers/qquickpointerhandler.cpp
index d6d3a52d95..959030b8fe 100644
--- a/src/quick/handlers/qquickpointerhandler.cpp
+++ b/src/quick/handlers/qquickpointerhandler.cpp
@@ -319,7 +319,7 @@ void QQuickPointerHandler::setEnabled(bool enabled)
The Item which this handler will manipulate.
- By default, it is the same as the \l parent: the Item within which
+ By default, it is the same as the \l [QML] {parent}, the Item within which
the handler is declared. However, it can sometimes be useful to set the
target to a different Item, in order to handle events within one item
but manipulate another; or to \c null, to disable the default behavior
@@ -402,10 +402,10 @@ void QQuickPointerHandler::handlePointerEventImpl(QQuickPointerEvent *event)
The \l Item which is the scope of the handler; the Item in which it was declared.
The handler will handle events on behalf of this Item, which means a
pointer event is relevant if at least one of its event points occurs within
- the Item's interior. Initially \l target() is the same, but target()
+ the Item's interior. Initially \l [QML] {target} {target()} is the same, but it
can be reassigned.
- \sa QQuick::PointerHandler::target(), QObject::parent()
+ \sa {target}, QObject::parent()
*/
/*!
diff --git a/src/quick/handlers/qquickpointhandler.cpp b/src/quick/handlers/qquickpointhandler.cpp
index ed03685252..7e2d40452c 100644
--- a/src/quick/handlers/qquickpointhandler.cpp
+++ b/src/quick/handlers/qquickpointhandler.cpp
@@ -54,19 +54,22 @@ QT_BEGIN_NAMESPACE
PointHandler can be used to show feedback about a touchpoint or the mouse
position, or to otherwise react to pointer events.
- When a press event occurs, each instance of PointHandler chooses a single
- point which is not yet "taken" at that moment: if the press occurs within
- the bounds of the \l parent, and no sibling PointHandler within the same
- \l parent has yet acquired a passive grab on that point, and if the other
- constraints such as \l acceptedMouseButtons, \l acceptedDevices etc. are
- satisfied, it's eligible, and the PointHandler then acquires a passive
- grab. In this way, the \l parent acts like an exclusive group: there can be
- multiple instances of PointHandler, and the set of pressed touchpoints will
- be distributed among them. Each PointHandler which has chosen a point to
- track has its \l active property \c true. It then continues to track its
- chosen point until release: the properties of the \l point will be kept
- up-to-date. Any Item can bind to these properties, and thereby follow the
- point's movements.
+ When a press event occurs, each instance of PointHandler chooses a
+ single point which is not yet "taken" at that moment: if the press
+ occurs within the bounds of the \l {PointerHandler::parent}, and
+ no sibling PointHandler within the same \l {PointerHandler::parent}
+ has yet acquired a passive grab on that point, and if the other
+ constraints such as \l {SinglePointHandler::acceptedButtons},
+ \l {PointerDeviceHandler::acceptedDevices} etc. are satisfied, it's
+ eligible, and the PointHandler then acquires a passive grab. In
+ this way, the \l {PointerHandler::parent} acts like an exclusive
+ group: there can be multiple instances of PointHandler, and the
+ set of pressed touchpoints will be distributed among them. Each
+ PointHandler which has chosen a point to track has its \l active
+ property \c true. It then continues to track its chosen point
+ until release: the properties of the \l point will be kept
+ up-to-date. Any Item can bind to these properties, and thereby
+ follow the point's movements.
By being only a passive grabber, it has the ability to keep independent
oversight of all movements. The passive grab cannot be stolen or overridden
@@ -81,11 +84,11 @@ QT_BEGIN_NAMESPACE
types, and thus sets itself up as a potential event delivery bottleneck.
One possible use case is to add this handler to a transparent Item which is
- on top of the rest of the scene (by having a high \l z value), so that when
- a point is freshly pressed, it will be delivered to that Item and its
- handlers first, providing the opportunity to take the passive grab as early
- as possible. Such an item (like a pane of glass over the whole UI) can be a
- convenient parent for other Items which visualize the kind of reactive
+ on top of the rest of the scene (by having a high \l{Item::z} {z} value),
+ so that when a point is freshly pressed, it will be delivered to that Item
+ and its handlers first, providing the opportunity to take the passive grab
+ as early as possible. Such an item (like a pane of glass over the whole UI)
+ can be a convenient parent for other Items which visualize the kind of reactive
feedback which must always be on top; and likewise it can be the parent for
popups, popovers, dialogs and so on. If it will be used in that way, it can
be helpful for your main.cpp to use QQmlContext::setContextProperty() to
diff --git a/src/quick/handlers/qquicksinglepointhandler.cpp b/src/quick/handlers/qquicksinglepointhandler.cpp
index dee168a8e4..8b1d8c11b9 100644
--- a/src/quick/handlers/qquicksinglepointhandler.cpp
+++ b/src/quick/handlers/qquicksinglepointhandler.cpp
@@ -217,7 +217,7 @@ void QQuickSinglePointHandler::moveTarget(QPointF pos, QQuickEventPoint *point)
The mouse buttons which can activate this Pointer Handler.
- By default, this property is set to \l Qt.LeftButton.
+ By default, this property is set to \l {QtQuick::MouseEvent::button} {Qt.LeftButton}.
It can be set to an OR combination of mouse buttons, and will ignore events
from other buttons.
@@ -360,7 +360,8 @@ void QQuickHandlerPoint::reset()
\qmlproperty QPointF QtQuick::HandlerPoint::position
\brief The position within the \c parent Item
- This is the position of the event point relative to the bounds of the \l parent.
+ This is the position of the event point relative to the bounds of
+ the \l {PointerHandler::parent} {parent}.
*/
/*!
@@ -378,7 +379,7 @@ void QQuickHandlerPoint::reset()
\brief The pressed position within the \c parent Item
This is the position at which this point was pressed, relative to the
- bounds of the \l parent.
+ bounds of the \l {PointerHandler::parent} {parent}.
*/
/*!