summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorRick Stockton <rickstockton@reno-computerhelp.com>2012-02-14 08:52:09 -0800
committerQt by Nokia <qt-info@nokia.com>2012-02-17 19:52:30 +0100
commit3ca194eb129c227b81bf1f04bfb879c404dc9f89 (patch)
treee9de70bd113f74735a6fd4423403b78dd3ddfd45 /src
parent1b08a485889aed6f2e9147257595383d60d22e77 (diff)
qnamespace.qdoc: Add doco for new values of Qt::MouseButton
QtTBUG-22642 added about 25 new values for the Qt::MouseButton Enum. This change adds documentation for the new values. Note that the special value 'Qt::AllButtons' is documented at the top (next to the other special value, 'Qt::NoButton'.) The new internal value 'Qt::MaxMouseButton' is listed as a \omitvalue. Task Number: QTBUG-22642 Change-Id: Iaec623754156fff8a2c73e357fef82e1fe36354b Reviewed-by: Alan Alpert <alan.alpert@nokia.com> Reviewed-by: Samuel Rødal <samuel.rodal@nokia.com>
Diffstat (limited to 'src')
-rw-r--r--src/corelib/global/qnamespace.qdoc52
1 files changed, 49 insertions, 3 deletions
diff --git a/src/corelib/global/qnamespace.qdoc b/src/corelib/global/qnamespace.qdoc
index 8c3fa148fc..d50960f68b 100644
--- a/src/corelib/global/qnamespace.qdoc
+++ b/src/corelib/global/qnamespace.qdoc
@@ -172,18 +172,64 @@
This enum type describes the different mouse buttons.
\value NoButton The button state does not refer to any
- button (see QMouseEvent::button()).
+ button (see QMouseEvent::button()).
+
+ \value AllButtons This value corresponds to a mask of all
+ possible mouse buttons. Use to set the 'acceptedButtons'
+ property of a mouseArea to accept ALL mouse buttons.
+
\value LeftButton The left button is pressed, or an event refers
to the left button. (The left button may be the right button on
left-handed mice.)
\value RightButton The right button.
\value MidButton The middle button.
\value MiddleButton The middle button.
- \value XButton1 The first X button.
- \value XButton2 The second X button.
+ \value BackButton The 'Back' button. (Typically present on
+ the 'thumb' side of a mouse with extra buttons. This is NOT
+ the tilt wheel.)
+ \value XButton1 The 'Back' Button.
+ \value ExtraButton1 The 'Back' Button.
+
+ \value ForwardButton The 'Forward' Button. (Typically present
+ beside the 'Back' button, and also pressed by the thumb.)
+ \value XButton2 The 'Forward Button.
+ \value ExtraButton2 The 'Forward' Button.
+
+ \value TaskButton The 'Task' Button.
+ \value ExtraButton3 The 'Task' Button.
+
+ \value ExtraButton4 The 7th non-wheel Mouse Button.
+ \value ExtraButton5 The 8th non-wheel Mouse Button.
+ \value ExtraButton6 The 9th non-wheel Mouse Button.
+ \value ExtraButton7 The 10th non-wheel Mouse Button.
+ \value ExtraButton8 The 11th non-wheel Mouse Button.
+ \value ExtraButton9 The 12th non-wheel Mouse Button.
+ \value ExtraButton10 The 13th non-wheel Mouse Button.
+ \value ExtraButton11 The 14th non-wheel Mouse Button.
+ \value ExtraButton12 The 15th non-wheel Mouse Button.
+ \value ExtraButton13 The 16th non-wheel Mouse Button.
+ \value ExtraButton14 The 17th non-wheel Mouse Button.
+ \value ExtraButton15 The 18th non-wheel Mouse Button.
+ \value ExtraButton16 The 19th non-wheel Mouse Button.
+ \value ExtraButton17 The 20th non-wheel Mouse Button.
+ \value ExtraButton18 The 21st non-wheel Mouse Button.
+ \value ExtraButton19 The 22nd non-wheel Mouse Button.
+ \value ExtraButton20 The 23rd non-wheel Mouse Button.
+ \value ExtraButton21 The 24th non-wheel Mouse Button.
+ \value ExtraButton22 The 25th non-wheel Mouse Button.
+ \value ExtraButton23 The 26th non-wheel Mouse Button.
+ \value ExtraButton44 The 27th non-wheel Mouse Button.
+
+ \omitvalue MaxMouseButton
\omitvalue MouseButtonMask
+ \note Some models of multi-button mice are pre-configured with
+ high-numbered Buttons emulating keyboard sequences, for use in
+ specific games. In order for these Buttons to be seen as
+ actual 'Mouse Buttons', the device must be re-configured (using
+ the vendor's configuration tool).
+
\sa KeyboardModifier Modifier
*/