diff options
| author | Shawn Rutledge <shawn.rutledge@qt.io> | 2023-02-08 11:11:58 +0100 |
|---|---|---|
| committer | Shawn Rutledge <shawn.rutledge@qt.io> | 2023-02-21 12:13:59 +0100 |
| commit | 60ebb044c87c1e5cf8e0b4a7f135aac283203122 (patch) | |
| tree | 7613c84dad90fdb506dd6c79e900110cd68dc77e /src/quick/handlers/qquickpointerhandler.cpp | |
| parent | 05c16d8e1c058fe872e17b2d00ed32a8057f032a (diff) | |
doc: Update QML eventPoint; fix GrabTransition link
Amends outdated stuff from 507efe5a8a2390813fb620a91b0b3b6b383f599d and
c248a32fe69dfe1c685105d0c6aeaeb15d7ba29f. "eventPoint" should now always
link to docs added in b43a873264d012dc0a0e574ea53335a40af8aa38.
Replace the phrase "event point" with a link to the QML eventPoint
value type.
QPointingDevice is called PointerDevice in QML, so the GrabTransition
enum ought to be found in those docs, in theory, for use in the
PointerHandler::grabChanged doc.
Pick-to: 6.2 6.4 6.5
Task-number: QTBUG-102160
Task-number: QTBUG-104761
Change-Id: I5d1a8dedd9d98e6dee3fbca457aa38f42ea7bfb1
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Diffstat (limited to 'src/quick/handlers/qquickpointerhandler.cpp')
| -rw-r--r-- | src/quick/handlers/qquickpointerhandler.cpp | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/src/quick/handlers/qquickpointerhandler.cpp b/src/quick/handlers/qquickpointerhandler.cpp index 3a15eb4d41..81bf7de8b0 100644 --- a/src/quick/handlers/qquickpointerhandler.cpp +++ b/src/quick/handlers/qquickpointerhandler.cpp @@ -57,7 +57,7 @@ QQuickPointerHandler::~QQuickPointerHandler() \qmlproperty real PointerHandler::margin The margin beyond the bounds of the \l {PointerHandler::parent}{parent} - item within which an event point can activate this handler. For example, on + item within which an \l eventPoint can activate this handler. For example, on a PinchHandler where the \l {PointerHandler::target}{target} is also the \c parent, it's useful to set this to a distance at least half the width of a typical user's finger, so that if the \c parent has been scaled down @@ -90,7 +90,7 @@ void QQuickPointerHandler::setMargin(qreal pointDistanceThreshold) \qmlproperty int PointerHandler::dragThreshold \since 5.15 - The distance in pixels that the user must drag an event point in order to + The distance in pixels that the user must drag an \l eventPoint in order to have it treated as a drag gesture. The default value depends on the platform and screen resolution. @@ -217,8 +217,8 @@ bool QQuickPointerHandler::isCursorShapeExplicitlySet() const The \a grabber (subject) will be the Input Handler whose state is changing, or null if the state change regards an Item. The \a transition (verb) tells what happened. - The \a point (object) is the point that was grabbed or ungrabbed. - EventPoint has the sole responsibility to call this function. + The \a point (object) is the \l eventPoint that was grabbed or ungrabbed. + QQuickDeliveryAgent calls this function. The Input Handler must react in whatever way is appropriate, and must emit the relevant signals (for the benefit of QML code). A subclass is allowed to override this virtual function, but must always @@ -690,9 +690,9 @@ bool QQuickPointerHandler::wantsEventPoint(const QPointerEvent *event, const QEv \qmlproperty bool QtQuick::PointerHandler::active This holds true whenever this Input Handler has taken sole responsibility - for handing one or more EventPoints, by successfully taking an exclusive - grab of those points. This means that it is keeping its properties - up-to-date according to the movements of those Event Points and actively + for handing one or more \l {eventPoint}{eventPoints}, by successfully taking an + exclusive grab of those points. This means that it is keeping its properties + up-to-date according to the movements of those eventPoints and actively manipulating its \l target (if any). */ void QQuickPointerHandler::setActive(bool active) @@ -715,7 +715,7 @@ void QQuickPointerHandler::handlePointerEventImpl(QPointerEvent *) 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 + pointer event is relevant if at least one of its \l {eventPoint}{eventPoints} occurs within the Item's interior. Initially \l [QML] {target} {target()} is the same, but it can be reassigned. @@ -726,7 +726,7 @@ void QQuickPointerHandler::handlePointerEventImpl(QPointerEvent *) */ /*! - \qmlsignal QtQuick::PointerHandler::grabChanged(GrabTransition transition, eventPoint point) + \qmlsignal QtQuick::PointerHandler::grabChanged(PointerDevice::GrabTransition transition, eventPoint point) This signal is emitted when the grab has changed in some way which is relevant to this handler. |