From 5475f84af82668e25d40a31ad9c6ede438bf7dfe Mon Sep 17 00:00:00 2001 From: Martin Smith Date: Thu, 22 Feb 2018 14:31:06 +0100 Subject: doc: Correct several QML property links This update corrects several QML property links. Currently, the best way to link to a QML property is like this: \l {QtQuick::EventPoint::velocity} {velocity} In other words, use the full path to the property as the link, using '::' as the separator, and use the property name as the label. Enclose both the link and the label in curly braces. Change-Id: I19231403b82d41ad89096dd27787eff57c91b8ae Reviewed-by: Martin Smith --- src/quick/items/qquickevents.cpp | 53 ++++++++++++++++++++++------------------ 1 file changed, 29 insertions(+), 24 deletions(-) (limited to 'src/quick/items/qquickevents.cpp') diff --git a/src/quick/items/qquickevents.cpp b/src/quick/items/qquickevents.cpp index 260b302121..827ec78b9e 100644 --- a/src/quick/items/qquickevents.cpp +++ b/src/quick/items/qquickevents.cpp @@ -520,11 +520,11 @@ Item { \value CapabilityFlag.Pressure the \l {QtQuick::EventTouchPoint::pressure}{pressure} property \value CapabilityFlag.Velocity - the \l {QtQuick::PointerEvent::velocity}{velocity} property + the \l {QtQuick::EventPoint::velocity}{velocity} property \value CapabilityFlag.Scroll - a \l {QtQuick::PointerDevice::DeviceType::Mouse}{Mouse} has a wheel, or the + a \l {QtQuick::PointerDevice::type}{Mouse} has a wheel, or the operating system recognizes scroll gestures on a - \l {QtQuick::PointerDevice::DeviceType::TouchPad}{TouchPad} + \l {QtQuick::PointerDevice::type}{TouchPad} \value CapabilityFlag.Hover events are sent even when no button is pressed, or the finger or stylus is not in contact with the surface @@ -651,8 +651,8 @@ QQuickPointerDevice *QQuickPointerDevice::tabletDevice(qint64 id) \qmlproperty point QtQuick::EventPoint::scenePosition This property holds the coordinates of the position supplied by the event, - relative to the scene. If a contact patch is available from the \l device, - this point represents its centroid. + relative to the scene. If a contact patch is available from the + \l {QtQuick::PointerEvent::device} {device}, this point represents its centroid. */ /*! @@ -710,7 +710,7 @@ QQuickPointerDevice *QQuickPointerDevice::tabletDevice(qint64 id) presses a finger against the touchscreen, it will be a larger number. In other cases, it will be -1. - \sa PointerDevice.uniqueId + \sa {QtQuick::EventTouchPoint::uniqueId}{uniqueId} */ /*! @@ -1044,22 +1044,27 @@ void QQuickEventPoint::setAccepted(bool accepted) \qmlproperty size QtQuick::EventTouchPoint::ellipseDiameters This property holds the diameters of the contact patch, if the event - comes from a touchpoint and the \l device provides this information. - - A touchpoint is modeled as an elliptical area where the finger is pressed - against the touchscreen. (In fact, it could also be modeled as a bitmap; but - in that case we expect an elliptical bounding estimate to be fitted to the - contact patch before the event is sent.) The harder the user presses, the - larger the contact patch; so, these diameters provide an alternate way of - detecting pressure, in case the device does not include a separate pressure - sensor. The ellipse is centered on \l scenePos (\l pos in the PointerHandler's + comes from a touchpoint and the \l {QtQuick::PointerEvent::device} {device} + provides this information. + + A touchpoint is modeled as an elliptical area where the finger is + pressed against the touchscreen. (In fact, it could also be + modeled as a bitmap; but in that case we expect an elliptical + bounding estimate to be fitted to the contact patch before the + event is sent.) The harder the user presses, the larger the + contact patch; so, these diameters provide an alternate way of + detecting pressure, in case the device does not include a separate + pressure sensor. The ellipse is centered on + \l {QtQuick::EventPoint::scenePosition} {scenePosition} + (\l {QtQuick::EventPoint::position} {position} in the PointerHandler's Item's local coordinates). The \l rotation property provides the - rotation of the ellipse, if known. It is expected that if the \l rotation - is zero, the verticalDiameter of the ellipse is the larger one (the major axis), - because of the usual hand position, reaching upward or outward across the surface. + rotation of the ellipse, if known. It is expected that if the + \l rotation is zero, the verticalDiameter of the ellipse is the + larger one (the major axis), because of the usual hand position, + reaching upward or outward across the surface. - If the contact patch is unknown, or the \l device is not a touchscreen, - these values will be zero. + If the contact patch is unknown, or the \l {QtQuick::PointerEvent::device} {device} + is not a touchscreen, these values will be zero. */ QQuickEventTouchPoint::QQuickEventTouchPoint(QQuickPointerTouchEvent *parent) @@ -1143,8 +1148,8 @@ QVector2D QQuickEventPoint::estimatedVelocity() const A PointerEvent is an event describing contact or movement across a surface, provided by a mouse, a touchpoint (single finger on a touchscreen), or a - stylus on a graphics tablet. The \l device property provides more - information about where the event came from. + stylus on a graphics tablet. The \l {QtQuick::PointerEvent::device} {device} + property provides more information about where the event came from. \sa PointerHandler @@ -1170,8 +1175,8 @@ QVector2D QQuickEventPoint::estimatedVelocity() const \qmlproperty enumeration QtQuick::PointerEvent::button This property holds the \l {Qt::MouseButton}{button} that caused the event, - if any. If the \l device does not have buttons, or the event is a hover - event, it will be \c Qt.NoButton. + if any. If the \l {QtQuick::PointerEvent::device} {device} does not have + buttons, or the event is a hover event, it will be \c Qt.NoButton. */ /*! -- cgit v1.2.3