doc: Customize and update docs for PointHandler

Many of the inherited docs were inappropriate or insufficiently specific
to PointHandler. Now we have more snippets with more ideas for how it
can be used.

As a drive-by, fix a typo in the docs for
PointerDeviceHandler::acceptedPointerTypes and add a link to the new
PointerDevice page added in e283c05af745210d4a1f6c0aa9c33bf4da23a1e0

Fixes: QTBUG-74020
Fixes: QTBUG-106878
Change-Id: I028e1577ac5d4ef0b927c94259d6ab25b6028885
Reviewed-by: Doris Verria <doris.verria@qt.io>
(cherry picked from commit 4c6d0b2bf09329dd8b036761f8f2924f54af3a07)
Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>

7 files changed, 275 insertions, 5 deletions

diff --git a/src/quick/doc/snippets/pointerHandlers/pointHandler.qml b/src/quick/doc/snippets/pointerHandlers/pointHandler.qml
index f5fe29566e..d363150ab5 100644
--- a/src/quick/doc/snippets/pointerHandlers/pointHandler.qml
+++ b/src/quick/doc/snippets/pointerHandlers/pointHandler.qml
@@ -1,8 +1,7 @@
 // Copyright (C) 2017 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 //![0]
-import QtQuick 2.12
-import QtQuick.Window 2.2
+import QtQuick
 
 Window {
     width: 480
@@ -14,6 +13,7 @@ Window {
         z: 10000
         anchors.fill: parent
 
+        //![1]
         PointHandler {
             id: handler
             acceptedDevices: PointerDevice.TouchScreen | PointerDevice.TouchPad
@@ -26,6 +26,7 @@ Window {
                 width: 20; height: width; radius: width / 2
             }
         }
+        //![1]
     }
 }
 //![0]
diff --git a/src/quick/doc/snippets/pointerHandlers/pointHandlerAcceptedButtons.qml b/src/quick/doc/snippets/pointerHandlers/pointHandlerAcceptedButtons.qml
new file mode 100644
index 0000000000..3eab8b319b
--- /dev/null
+++ b/src/quick/doc/snippets/pointerHandlers/pointHandlerAcceptedButtons.qml
@@ -0,0 +1,21 @@
+// Copyright (C) 2023 Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+//![0]
+import QtQuick
+
+Item {
+    width: 480; height: 320
+
+    Rectangle {
+        color: handler.active ? "tomato" : "wheat"
+        x: handler.point.position.x - width / 2
+        y: handler.point.position.y - height / 2
+        width: 20; height: width; radius: width / 2
+    }
+
+    PointHandler {
+        id: handler
+        acceptedButtons: Qt.MiddleButton | Qt.RightButton
+    }
+}
+//![0]
diff --git a/src/quick/doc/snippets/pointerHandlers/pointHandlerAcceptedModifiers.qml b/src/quick/doc/snippets/pointerHandlers/pointHandlerAcceptedModifiers.qml
new file mode 100644
index 0000000000..9e3cb6f465
--- /dev/null
+++ b/src/quick/doc/snippets/pointerHandlers/pointHandlerAcceptedModifiers.qml
@@ -0,0 +1,36 @@
+// Copyright (C) 2023 Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+//![0]
+import QtQuick
+
+Item {
+    id: feedbackPane
+    width: 480; height: 320
+
+    PointHandler {
+        id: control
+        acceptedModifiers: Qt.ControlModifier
+        cursorShape: Qt.PointingHandCursor
+        target: Rectangle {
+            parent: feedbackPane
+            color: control.active ? "indianred" : "khaki"
+            x: control.point.position.x - width / 2
+            y: control.point.position.y - height / 2
+            width: 20; height: width; radius: width / 2
+        }
+    }
+
+    PointHandler {
+        id: shift
+        acceptedModifiers: Qt.ShiftModifier | Qt.MetaModifier
+        cursorShape: Qt.CrossCursor
+        target: Rectangle {
+            parent: feedbackPane
+            color: shift.active ? "darkslateblue" : "lightseagreen"
+            x: shift.point.position.x - width / 2
+            y: shift.point.position.y - height / 2
+            width: 30; height: width; radius: width / 2
+        }
+    }
+}
+//![0]
diff --git a/src/quick/doc/snippets/pointerHandlers/pointHandlerCanvasDrawing.qml b/src/quick/doc/snippets/pointerHandlers/pointHandlerCanvasDrawing.qml
new file mode 100644
index 0000000000..d04bd4f149
--- /dev/null
+++ b/src/quick/doc/snippets/pointerHandlers/pointHandlerCanvasDrawing.qml
@@ -0,0 +1,54 @@
+// Copyright (C) 2023 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
+//![0]
+import QtQuick
+
+Canvas {
+    id: canvas
+    width: 800
+    height: 600
+    antialiasing: true
+    renderTarget: Canvas.FramebufferObject
+    property var points: []
+    onPaint: {
+        if (points.length < 2)
+            return
+        var ctx = canvas.getContext('2d');
+        ctx.save()
+        ctx.strokeStyle = stylusHandler.active ? "blue" : "white"
+        ctx.lineCap = "round"
+        ctx.beginPath()
+        ctx.moveTo(points[0].x, points[0].y)
+        for (var i = 1; i < points.length; i++)
+            ctx.lineTo(points[i].x, points[i].y)
+        ctx.lineWidth = 3
+        ctx.stroke()
+        points = points.slice(points.length - 2, 1)
+        ctx.restore()
+    }
+
+    PointHandler {
+        id: stylusHandler
+        acceptedPointerTypes: PointerDevice.Pen
+        onPointChanged: {
+            canvas.points.push(point.position)
+            canvas.requestPaint()
+        }
+    }
+
+    PointHandler {
+        id: eraserHandler
+        acceptedPointerTypes: PointerDevice.Eraser
+        onPointChanged: {
+            canvas.points.push(point.position)
+            canvas.requestPaint()
+        }
+    }
+
+    Rectangle {
+        width: 10; height: 10
+        color: stylusHandler.active ? "green" : eraserHandler.active ? "red" : "beige"
+    }
+}
+//![0]
diff --git a/src/quick/doc/snippets/pointerHandlers/pointHandlerMargin.qml b/src/quick/doc/snippets/pointerHandlers/pointHandlerMargin.qml
new file mode 100644
index 0000000000..1b66531dbf
--- /dev/null
+++ b/src/quick/doc/snippets/pointerHandlers/pointHandlerMargin.qml
@@ -0,0 +1,36 @@
+// Copyright (C) 2023 Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+//![0]
+import QtQuick
+
+Item {
+    width: 480; height: 320
+
+    Rectangle {
+        anchors.fill: handlingContainer
+        anchors.margins: -handler.margin
+        color: "beige"
+    }
+
+    Rectangle {
+        id: handlingContainer
+        width: 200; height: 200
+        anchors.centerIn: parent
+        border.color: "green"
+        color: handler.active ? "lightsteelblue" : "khaki"
+
+        Text {
+            text: "X"
+            x: handler.point.position.x - width / 2
+            y: handler.point.position.y - height / 2
+            visible: handler.active
+        }
+
+        PointHandler {
+            id: handler
+            margin: 30
+        }
+    }
+
+}
+//![0]
diff --git a/src/quick/handlers/qquickpointerdevicehandler.cpp b/src/quick/handlers/qquickpointerdevicehandler.cpp
index b610e083cc..5da7849a44 100644
--- a/src/quick/handlers/qquickpointerdevicehandler.cpp
+++ b/src/quick/handlers/qquickpointerdevicehandler.cpp
@@ -139,7 +139,7 @@ void QQuickPointerDeviceHandler::setAcceptedDevices(QPointingDevice::DeviceTypes
     By default, this property is set to
     \l {QPointingDevice::PointerType} {PointerDevice.AllPointerTypes}.
     If you set it to an OR combination of device types, it will ignore events
-    from non-matching events.
+    from non-matching \l {PointerDevice}{devices}.
 
     For example, a control could be made to respond to mouse, touch, and stylus clicks
     in some way, but delete itself if tapped with an eraser tool on a graphics tablet,
diff --git a/src/quick/handlers/qquickpointhandler.cpp b/src/quick/handlers/qquickpointhandler.cpp
index 1c5f36b6dd..2a9e0ff9bb 100644
--- a/src/quick/handlers/qquickpointhandler.cpp
+++ b/src/quick/handlers/qquickpointhandler.cpp
@@ -66,7 +66,8 @@ QT_BEGIN_NAMESPACE
     PointHandler will not automatically manipulate the \c target item in any way.
     You need to use bindings to make it react to the \l point.
 
-    \note On macOS, PointHandler does not react to the trackpad by default.
+    \note On macOS, PointHandler does not react to multiple fingers on the
+    trackpad by default, although it does react to a pressed point (mouse position).
     That is because macOS can provide either native gesture recognition, or raw
     touchpoints, but not both. We prefer to use the native gesture event in
     PinchHandler, so we do not want to disable it by enabling touch. However
@@ -75,7 +76,7 @@ QT_BEGIN_NAMESPACE
     want to react to all the touchpoints but do not require the smooth
     native-gesture experience.
 
-    \sa MultiPointTouchArea
+    \sa MultiPointTouchArea, HoverHandler, {Pointer Handlers Example}
 */
 
 QQuickPointHandler::QQuickPointHandler(QQuickItem *parent)
@@ -128,6 +129,127 @@ QVector2D QQuickPointHandler::translation() const
     return QVector2D(point().position() - point().pressPosition());
 }
 
+/*!
+    \qmlproperty flags PointHandler::acceptedButtons
+
+    The mouse buttons that can activate this PointHandler.
+
+    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
+    in which other buttons are pressed or held.
+
+    \snippet pointerHandlers/pointHandlerAcceptedButtons.qml 0
+
+    \note On a touchscreen, there are no buttons, so this property does not
+    prevent PointHandler from reacting to touchpoints.
+*/
+
+/*!
+    \qmlproperty flags PointHandler::acceptedDevices
+
+    The types of pointing devices that can activate this PointHandler.
+
+    By default, this property is set to
+    \l{QInputDevice::DeviceType}{PointerDevice.AllDevices}.
+    If you set it to an OR combination of device types, it will ignore events
+    from non-matching \l {PointerDevice}{devices}:
+
+    \snippet pointerHandlers/pointHandler.qml 1
+*/
+
+/*!
+    \qmlproperty flags PointHandler::acceptedPointerTypes
+
+    The types of pointing instruments (finger, stylus, eraser, etc.)
+    that can activate this PointHandler.
+
+    By default, this property is set to
+    \l {QPointingDevice::PointerType} {PointerDevice.AllPointerTypes}.
+    If you set it to an OR combination of device types, it will ignore events
+    from non-matching \l {PointerDevice}{devices}:
+
+    \snippet pointerHandlers/pointHandlerCanvasDrawing.qml 0
+
+    The \l {Pointer Handlers Example} includes a more complex example for
+    drawing on a Canvas with a graphics tablet.
+*/
+
+/*!
+    \qmlproperty flags PointHandler::acceptedModifiers
+
+    If this property is set, PointHandler requires the given keyboard modifiers
+    to be pressed in order to react to \l {PointerEvent}{PointerEvents}, and
+    otherwise ignores them.
+
+    If this property is set to \c Qt.KeyboardModifierMask (the default value),
+    then PointHandler ignores the modifier keys.
+
+    For example, an \l [QML] Item could have two handlers, one of which is
+    enabled only if the required keyboard modifier is pressed:
+
+    \snippet pointerHandlers/pointHandlerAcceptedModifiers.qml 0
+
+    If you set \c acceptedModifiers to an OR combination of modifier keys,
+    it means \e all of those modifiers must be pressed to activate the handler.
+
+    The available modifiers are as follows:
+
+    \value NoModifier       No modifier key is allowed.
+    \value ShiftModifier    A Shift key on the keyboard must be pressed.
+    \value ControlModifier  A Ctrl key on the keyboard must be pressed.
+    \value AltModifier      An Alt key on the keyboard must be pressed.
+    \value MetaModifier     A Meta key on the keyboard must be pressed.
+    \value KeypadModifier   A keypad button must be pressed.
+    \value GroupSwitchModifier X11 only (unless activated on Windows by a command line argument).
+                            A Mode_switch key on the keyboard must be pressed.
+    \value KeyboardModifierMask The handler does not care which modifiers are pressed.
+
+    \sa Qt::KeyboardModifier
+*/
+
+/*!
+    \readonly
+    \qmlproperty bool PointHandler::active
+
+    This holds \c true whenever the constraints are satisfied and this
+    PointHandler is reacting. This means that it is keeping its properties
+    up-to-date according to the movements of the \l {eventPoint}{eventPoints}
+    that satisfy the constraints.
+*/
+
+/*!
+    \internal
+    \qmlproperty flags PointHandler::dragThreshold
+
+    This property is not used in PointHandler.
+*/
+
+/*!
+    \qmlproperty real PointHandler::margin
+
+    The margin beyond the bounds of the \l {PointerHandler::parent}{parent}
+    item within which an \l eventPoint can activate this handler.
+
+    The default value is \c 0.
+
+    \snippet pointerHandlers/pointHandlerMargin.qml 0
+*/
+
+/*!
+    \qmlproperty real PointHandler::target
+
+    A property that can conveniently hold an Item to be manipulated or to show
+    feedback. Unlike other \l {Qt Quick Input Handlers}{Pointer Handlers},
+    PointHandler does not do anything with the \c target on its own: you
+    usually need to create reactive bindings to properties such as
+    \l SinglePointHandler::point and \l PointHandler::active. If you declare
+    an Item instance here, you need to explicitly set its \l {Item::}{parent},
+    because PointHandler is not an Item.
+
+    By default, it is the same as the \l {PointerHandler::}{parent}, the Item
+    within which the handler is declared.
+*/
+
 QT_END_NAMESPACE
 
 #include "moc_qquickpointhandler_p.cpp"