MouseEvent QML Type | Qt Quick 5.9

Qt 5.9 | Qt Quick | QML Types | MouseEvent QML Type

Qt 5.9.2 Reference Documentation

# MouseEvent QML Type

Provides information about a mouse event More...

Import Statement: | import QtQuick 2.7

- List of all members, including inherited members

## Properties

- accepted : bool
- button : enumeration
- buttons : int
- modifiers : int
- source : int
- wasHeld : bool
- x : real
- y : real

## Detailed Description

The position of the mouse can be found via the x and y properties. The button that caused the event is available via the button property.

See also MouseArea.

## Property Documentation

accepted : bool

Setting accepted to true prevents the mouse event from being propagated to items below this item.

Generally, if the item acts on the mouse event then it should be accepted so that items lower in the stacking order do not also respond to the same event.

button : enumeration

This property holds the button that caused the event. It can be one of:

- Qt.LeftButton
- Qt.RightButton
- Qt.MiddleButton

buttons : int

This property holds the mouse buttons pressed when the event was generated. For mouse move events, this is all buttons that are pressed down. For mouse press and double click events this includes the button that caused the event. For mouse release events this excludes the button that caused the event.

It contains a bitwise combination of:

- Qt.LeftButton
- Qt.RightButton
- Qt.MiddleButton

modifiers : int

This property holds the keyboard modifier flags that existed immediately before the event occurred.

It contains a bitwise combination of:

- Qt.NoModifier - No modifier key is pressed.
- Qt.ShiftModifier - A Shift key on the keyboard is pressed.
- Qt.ControlModifier - A Ctrl key on the keyboard is pressed.
- Qt.AltModifier - An Alt key on the keyboard is pressed.
- Qt.MetaModifier - A Meta key on the keyboard is pressed.
- Qt.KeypadModifier - A keypad button is pressed.

For example, to react to a Shift key + Left mouse button click:

      MouseArea {
          onClicked: {
              if ((mouse.button == Qt.LeftButton) && (mouse.modifiers & Qt.ShiftModifier))
                  doSomething();
          }
      }

source : int

This property holds the source of the mouse event.

The mouse event source can be used to distinguish between genuine and artificial mouse events. When using other pointing devices such as touchscreens and graphics tablets, if the application does not make use of the actual touch or tablet events, mouse events may be synthesized by the operating system or by Qt itself.

The value can be one of:

Constant | Description
--- | ---
`Qt.MouseEventNotSynthesized` | The most common value. On platforms where such information is available, this value indicates that the event represents a genuine mouse event from the system.
`Qt.MouseEventSynthesizedBySystem` | Indicates that the mouse event was synthesized from a touch or tablet event by the platform.
`Qt.MouseEventSynthesizedByQt` | Indicates that the mouse event was synthesized from an unhandled touch or tablet event by Qt.
`Qt.MouseEventSynthesizedByApplication` | Indicates that the mouse event was synthesized by the application. This allows distinguishing application-generated mouse events from the ones that are coming from the system or are synthesized by Qt.

For example, to react only to events which come from an actual mouse:

      MouseArea {
          onPressed: if (mouse.source !== Qt.MouseEventNotSynthesized) {
              mouse.accepted = false
          }

          onClicked: doSomething()
      }

If the handler for the press event rejects the event, it will be propagated further, and then another Item underneath can handle synthesized events from touchscreens. For example, if a Flickable is used underneath (and the MouseArea is not a child of the Flickable), it can be useful for the MouseArea to handle genuine mouse events in one way, while allowing touch events to fall through to the Flickable underneath, so that the ability to flick on a touchscreen is retained. In that case the ability to drag the Flickable via mouse would be lost, but it does not prevent Flickable from receiving mouse wheel events.

This QML property was introduced in Qt 5.7.

wasHeld : bool

This property is true if the mouse button has been held pressed longer the threshold (800ms).

x : real

These properties hold the coordinates of the position supplied by the mouse event.

y : real

These properties hold the coordinates of the position supplied by the mouse event.