Doc: explain how to receive mouse press and release eventsv5.15.0-beta3

Change-Id: Icd6df727597659b81612a57a3e7e2e5b31adfef6
Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>

1 files changed, 11 insertions, 0 deletions

diff --git a/src/quick/items/qquickitem.cpp b/src/quick/items/qquickitem.cpp
index 4b635ac7b8..3f655e84fa 100644
--- a/src/quick/items/qquickitem.cpp
+++ b/src/quick/items/qquickitem.cpp
@@ -3977,6 +3977,9 @@ void QQuickItem::focusOutEvent(QFocusEvent * /*event*/)
     press events for an item. The event information is provided by the
     \a event parameter.
 
+    In order to receive mouse press events, \l acceptedMouseButtons() must
+    return the relevant mouse button.
+
     \input item.qdocinc accepting-events
   */
 void QQuickItem::mousePressEvent(QMouseEvent *event)
@@ -3989,6 +3992,10 @@ void QQuickItem::mousePressEvent(QMouseEvent *event)
     move events for an item. The event information is provided by the
     \a event parameter.
 
+    In order to receive mouse movement events, the preceding mouse press event
+    must be accepted (by overriding \l mousePressEvent(), for example) and
+    \l acceptedMouseButtons() must return the relevant mouse button.
+
     \input item.qdocinc accepting-events
   */
 void QQuickItem::mouseMoveEvent(QMouseEvent *event)
@@ -4001,6 +4008,10 @@ void QQuickItem::mouseMoveEvent(QMouseEvent *event)
     release events for an item. The event information is provided by the
     \a event parameter.
 
+    In order to receive mouse release events, the preceding mouse press event
+    must be accepted (by overriding \l mousePressEvent(), for example) and
+    \l acceptedMouseButtons() must return the relevant mouse button.
+
     \input item.qdocinc accepting-events
   */
 void QQuickItem::mouseReleaseEvent(QMouseEvent *event)