From 70e6e47fc646448be8116e17bc79a6011f93ba1b Mon Sep 17 00:00:00 2001 From: Shawn Rutledge Date: Wed, 8 Feb 2023 13:28:24 +0100 Subject: doc: Rename QML type HandlerPoint to handlerPoint MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit It's a Q_GADGET value type so it needs a lowercase name. Link eventPoint to handlerPoint to help reduce confusion. There's already a link in the other direction. Task-number: QTBUG-104761 Task-number: QTBUG-104570 Change-Id: I962d2d44690ec2f75190e07be7489eb3883d0657 Reviewed-by: Sami Shalayel Reviewed-by: Topi Reiniö (cherry picked from commit 9e25d24b3730463a5c5c4ecb1a39ad0ca02892a8) Reviewed-by: Shawn Rutledge --- src/quick/handlers/qquickhandlerpoint.cpp | 30 ++++++++++++------------- src/quick/handlers/qquickmultipointhandler.cpp | 2 +- src/quick/handlers/qquickpinchhandler.cpp | 2 +- src/quick/handlers/qquicksinglepointhandler.cpp | 2 +- 4 files changed, 18 insertions(+), 18 deletions(-) diff --git a/src/quick/handlers/qquickhandlerpoint.cpp b/src/quick/handlers/qquickhandlerpoint.cpp index 5d9c14e154..75848c2882 100644 --- a/src/quick/handlers/qquickhandlerpoint.cpp +++ b/src/quick/handlers/qquickhandlerpoint.cpp @@ -8,7 +8,7 @@ QT_BEGIN_NAMESPACE Q_DECLARE_LOGGING_CATEGORY(lcTouchTarget) /*! - \qmltype HandlerPoint + \qmltype handlerPoint \instantiates QQuickHandlerPoint \inqmlmodule QtQuick \brief An event point. @@ -30,7 +30,7 @@ Q_DECLARE_LOGGING_CATEGORY(lcTouchTarget) and reused for subsequent event deliveries. Continuous bindings to its properties are not possible, and an individual handler cannot rely on it outside the period when that point is part of an active gesture which that - handler is handling. HandlerPoint is a Q_GADGET that the handler owns. + handler is handling. handlerPoint is a Q_GADGET that the handler owns. This allows you to make lifetime bindings to its properties. \sa SinglePointHandler::point, MultiPointHandler::centroid @@ -144,7 +144,7 @@ void QQuickHandlerPoint::reset(const QVector &points) /*! \readonly - \qmlproperty int QtQuick::HandlerPoint::id + \qmlproperty int QtQuick::handlerPoint::id \brief The ID number of the point During a touch gesture, from the time that the first finger is pressed @@ -162,7 +162,7 @@ void QQuickHandlerPoint::reset(const QVector &points) /*! \readonly - \qmlproperty pointingDeviceUniqueId QtQuick::HandlerPoint::uniqueId + \qmlproperty pointingDeviceUniqueId QtQuick::handlerPoint::uniqueId \brief The unique ID of the point, if any This is normally empty, because touchscreens cannot uniquely identify fingers. @@ -184,7 +184,7 @@ void QQuickHandlerPoint::reset(const QVector &points) /*! \readonly - \qmlproperty QPointF QtQuick::HandlerPoint::position + \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 @@ -193,7 +193,7 @@ void QQuickHandlerPoint::reset(const QVector &points) /*! \readonly - \qmlproperty QPointF QtQuick::HandlerPoint::scenePosition + \qmlproperty QPointF QtQuick::handlerPoint::scenePosition \brief The position within the scene This is the position of the event point relative to the bounds of the Qt @@ -202,7 +202,7 @@ void QQuickHandlerPoint::reset(const QVector &points) /*! \readonly - \qmlproperty QPointF QtQuick::HandlerPoint::pressPosition + \qmlproperty QPointF QtQuick::handlerPoint::pressPosition \brief The pressed position within the \c parent Item This is the position at which this point was pressed, relative to the @@ -211,7 +211,7 @@ void QQuickHandlerPoint::reset(const QVector &points) /*! \readonly - \qmlproperty QPointF QtQuick::HandlerPoint::scenePressPosition + \qmlproperty QPointF QtQuick::handlerPoint::scenePressPosition \brief The pressed position within the scene This is the position at which this point was pressed, in the coordinate @@ -220,7 +220,7 @@ void QQuickHandlerPoint::reset(const QVector &points) /*! \readonly - \qmlproperty QPointF QtQuick::HandlerPoint::sceneGrabPosition + \qmlproperty QPointF QtQuick::handlerPoint::sceneGrabPosition \brief The grabbed position within the scene If this point has been grabbed by a Pointer Handler or an Item, it means @@ -231,7 +231,7 @@ void QQuickHandlerPoint::reset(const QVector &points) /*! \readonly - \qmlproperty enumeration QtQuick::HandlerPoint::pressedButtons + \qmlproperty enumeration QtQuick::handlerPoint::pressedButtons \brief Which mouse or stylus buttons are currently pressed \sa MouseArea::pressedButtons @@ -239,7 +239,7 @@ void QQuickHandlerPoint::reset(const QVector &points) /*! \readonly - \qmlproperty enumeration QtQuick::HandlerPoint::modifiers + \qmlproperty enumeration QtQuick::handlerPoint::modifiers \brief Which modifier keys are currently pressed This property holds the keyboard modifiers that were pressed at the time @@ -248,7 +248,7 @@ void QQuickHandlerPoint::reset(const QVector &points) /*! \readonly - \qmlproperty QVector2D QtQuick::HandlerPoint::velocity + \qmlproperty QVector2D QtQuick::handlerPoint::velocity \brief A vector representing the average speed and direction of movement This is a velocity vector pointing in the direction of movement, in logical @@ -261,7 +261,7 @@ void QQuickHandlerPoint::reset(const QVector &points) /*! \readonly - \qmlproperty qreal QtQuick::HandlerPoint::rotation + \qmlproperty qreal QtQuick::handlerPoint::rotation This property holds the rotation angle of the stylus on a graphics tablet or the contact patch of a touchpoint on a touchscreen. @@ -272,7 +272,7 @@ void QQuickHandlerPoint::reset(const QVector &points) /*! \readonly - \qmlproperty qreal QtQuick::HandlerPoint::pressure + \qmlproperty qreal QtQuick::handlerPoint::pressure This property tells how hard the user is pressing the stylus on a graphics tablet or the finger against a touchscreen, in the range from \c 0 (no @@ -285,7 +285,7 @@ void QQuickHandlerPoint::reset(const QVector &points) /*! \readonly - \qmlproperty size QtQuick::HandlerPoint::ellipseDiameters + \qmlproperty size QtQuick::handlerPoint::ellipseDiameters This property holds the diameters of the contact patch, if the event comes from a touchpoint and the device provides this information. diff --git a/src/quick/handlers/qquickmultipointhandler.cpp b/src/quick/handlers/qquickmultipointhandler.cpp index 1ef76148c5..c50de437cd 100644 --- a/src/quick/handlers/qquickmultipointhandler.cpp +++ b/src/quick/handlers/qquickmultipointhandler.cpp @@ -229,7 +229,7 @@ void QQuickMultiPointHandler::setMaximumPointCount(int maximumPointCount) /*! \readonly - \qmlproperty QtQuick::HandlerPoint QtQuick::MultiPointHandler::centroid + \qmlproperty QtQuick::handlerPoint QtQuick::MultiPointHandler::centroid A point exactly in the middle of the currently-pressed touch points. If only one point is pressed, it's the same as that point. diff --git a/src/quick/handlers/qquickpinchhandler.cpp b/src/quick/handlers/qquickpinchhandler.cpp index 6fec0feaa1..55c648358d 100644 --- a/src/quick/handlers/qquickpinchhandler.cpp +++ b/src/quick/handlers/qquickpinchhandler.cpp @@ -427,7 +427,7 @@ void QQuickPinchHandler::handlePointerEventImpl(QPointerEvent *event) /*! \readonly - \qmlproperty QtQuick::HandlerPoint QtQuick::PinchHandler::centroid + \qmlproperty QtQuick::handlerPoint QtQuick::PinchHandler::centroid A point exactly in the middle of the currently-pressed touch points. The \l target will be rotated around this point. diff --git a/src/quick/handlers/qquicksinglepointhandler.cpp b/src/quick/handlers/qquicksinglepointhandler.cpp index c732a2562e..c7b642a7bc 100644 --- a/src/quick/handlers/qquicksinglepointhandler.cpp +++ b/src/quick/handlers/qquicksinglepointhandler.cpp @@ -171,7 +171,7 @@ QQuickHandlerPoint QQuickSinglePointHandler::point() const /*! \readonly - \qmlproperty HandlerPoint QtQuick::SinglePointHandler::point + \qmlproperty handlerPoint QtQuick::SinglePointHandler::point The event point currently being handled. When no point is currently being handled, this object is reset to default values (all coordinates are 0). -- cgit v1.2.3