- Qt 5.15
- Qt 3D
- C++ Classes
- QMouseEvent
- Qt 5.15.11 Reference Documentation

# QMouseEvent Class

class Qt3DInput::QMouseEvent

The Qt3DCore::QMouseEvent contains parameters that describe a mouse event. More...

Header: | #include <Qt3DInput/QMouseEvent>
qmake: | QT += 3dinput
Since: | Qt 5.5
Instantiated By: | MouseEvent

This class was introduced in Qt 5.5.

- List of all members, including inherited members

## Public Types

enum | Buttons { LeftButton, RightButton, MiddleButton, BackButton, NoButton }
enum | Modifiers { NoModifier, ShiftModifier, ControlModifier, AltModifier, MetaModifier, KeypadModifier }

## Properties

- accepted : bool
- button : const Qt3DInput::QMouseEvent::Buttons
- buttons : const int
- modifiers : const Qt3DInput::QMouseEvent::Modifiers

- wasHeld : const bool
- x : const int
- y : const int

## Public Functions

| QMouseEvent(const ::QMouseEvent &e)
Buttons | button() const
int | buttons() const
bool | isAccepted() const
Modifiers | modifiers() const
void | setAccepted(bool accepted)
QEvent::Type | type() const
bool | wasHeld() const
int | x() const
int | y() const

## Related Non-Members

typedef | QMouseEventPtr

## Detailed Description

Mouse events occur when a mouse button is pressed and the ray traversing the view, originating from the mouse position intersects with one or more elements of the scene.

See also QKeyEvent, QWheelEvent, and QMouseHandler.

## Member Type Documentation

### enum QMouseEvent::Buttons

Constant | Value
--- | ---
`Qt3DInput::QMouseEvent::LeftButton` | `Qt::LeftButton`
`Qt3DInput::QMouseEvent::RightButton` | `Qt::RightButton`
`Qt3DInput::QMouseEvent::MiddleButton` | `Qt::MiddleButton`
`Qt3DInput::QMouseEvent::BackButton` | `Qt::BackButton`
`Qt3DInput::QMouseEvent::NoButton` | `Qt::NoButton`

### enum QMouseEvent::Modifiers

Constant | Value
--- | ---
`Qt3DInput::QMouseEvent::NoModifier` | `Qt::NoModifier`
`Qt3DInput::QMouseEvent::ShiftModifier` | `Qt::ShiftModifier`
`Qt3DInput::QMouseEvent::ControlModifier` | `Qt::ControlModifier`
`Qt3DInput::QMouseEvent::AltModifier` | `Qt::AltModifier`
`Qt3DInput::QMouseEvent::MetaModifier` | `Qt::MetaModifier`
`Qt3DInput::QMouseEvent::KeypadModifier` | `Qt::KeypadModifier`

## Property Documentation

### accepted : bool

Specifies if the mouse event has been accepted

Access functions:

bool | isAccepted() const
void | setAccepted(bool accepted)

### button : const Qt3DInput::QMouseEvent::Buttons

Specifies the button triggering the mouse event

Access functions:

Buttons | button() const

### buttons : const int

Specifies the button triggering the mouse event

Access functions:

int | buttons() const

### modifiers : const Qt3DInput::QMouseEvent::Modifiers

Specifies if any modifiers were applied to the mouse event

Access functions:

Modifiers | modifiers() const

### wasHeld : const bool

Specifies if a mouse button was held down during the mouse event

Access functions:

bool | wasHeld() const

### x : const int

Specifies The X coordinate of the mouse event

Access functions:

int | x() const

### y : const int

Specifies The y coordinate of the mouse event

Access functions:

int | y() const

## Member Function Documentation

### QMouseEvent::QMouseEvent(const ::QMouseEvent &e)

Constructs a new QMouseEvent instance for the QMouseEvent e.

### Buttons QMouseEvent::button() const

Returns the mouse button of the mouse event.

Note: Getter function for property button.

### int QMouseEvent::buttons() const

Returns a bitfield to be used to check for mouse buttons that may be accompanying the mouse event.

Note: Getter function for property buttons.

### bool QMouseEvent::isAccepted() const

Returns whether the event was accepted.

Note: Getter function for property accepted.

### Modifiers QMouseEvent::modifiers() const

Returns the keyboard modifiers that may be accompanying the mouse event.

Note: Getter function for property modifiers.

### void QMouseEvent::setAccepted(bool accepted)

Sets the event as accepted if accepted is true.

Note: When an event is accepted, it will prevent further propagation to other listeners.

Note: Setter function for property accepted.

See also isAccepted().

### QEvent::Type QMouseEvent::type() const

Returns the QEvent::Type of the event.

### int QMouseEvent::x() const

Returns the x position of the mouse event.

Note: Getter function for property x.

### int QMouseEvent::y() const

Returns the y position of the mouse event.

Note: Getter function for property y.

## Related Non-Members

### typedef QMouseEventPtr

A shared pointer for QMouseEvent.