Doc: QQuickMouseArea::acceptedButtons() accepts ALL MouseButtons

setAcceptedButtons() can make a MouseArea respond to any/all of
the Qt::MouseButtons defined in Qt5. (27 possible buttons,
not just Qt::LeftButton | Qt::RightButton | Qt::MiddleButton)

Task-number: QTBUG-26735

Change-Id: Ib48e5b02eb64c65050b9020b99d917e472328a30
Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
Reviewed-by: Martin Jones <martin.jones@nokia.com>

diff --git a/src/quick/items/qquickmousearea.cpp b/src/quick/items/qquickmousearea.cpp
index 336058c..a52c2ea 100644 (file)
--- a/src/quick/items/qquickmousearea.cpp
+++ b/src/quick/items/qquickmousearea.cpp
@@ -1141,23 +1141,23 @@ void QQuickMouseArea::setHovered(bool h)
 }
 
 /*!
-    \qmlproperty QtQuick2::Qt::MouseButtons MouseArea::acceptedButtons
+    \qmlproperty Qt::MouseButtons MouseArea::acceptedButtons
     This property holds the mouse buttons that the mouse area reacts to.
 
-    The available buttons are:
-    \list
-    \li Qt.LeftButton
-    \li Qt.RightButton
-    \li Qt.MiddleButton
-    \endlist
-
-    To accept more than one button the flags can be combined with the
-    "|" (or) operator:
+    To specify that the MouseArea will react to multiple buttons,
+    Qt::MouseButtons flag values are combined using the "|" (or) operator:
 
     \code
     MouseArea { acceptedButtons: Qt.LeftButton | Qt.RightButton }
     \endcode
 
+    To indicate that all possible mouse buttons are to be accepted,
+    the special value 'Qt.AllButtons' may be used:
+
+    \code
+    MouseArea { acceptedButtons: Qt.AllButtons }
+    \endcode
+
     The default value is \c Qt.LeftButton.
 */
 Qt::MouseButtons QQuickMouseArea::acceptedButtons() const