Qt Reference Documentation

QML MouseEvent Element

The MouseEvent object provides information about a mouse event. More...

  • List of all members, including inherited members
  • Properties

    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.

    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.


    read-onlybutton : enumeration

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

    • Qt.LeftButton
    • Qt.RightButton
    • Qt.MiddleButton

    read-onlybuttons : 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

    read-onlymodifiers : 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(); }
     }

    read-onlywasHeld : bool

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


    read-onlyx : int

    read-onlyy : int

    These properties hold the position of the mouse event.


    X

    Thank you for giving your feedback.

    Make sure it is related to this specific page. For more general bugs and requests, please use the Qt Bug Tracker.

    [0]; s.parentNode.insertBefore(ga, s); })();