QWheelEvent Class

class Qt3DInput::QWheelEvent

The QWheelEvent class contains parameters that describe a mouse wheel event. More...

Header: #include <Qt3DInput/QWheelEvent>
qmake: QT += 3dinput
Since: Qt 5.5
Instantiated By: WheelEvent
Inherits: QObject

This class was introduced in Qt 5.5.

Public Types

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

Properties

  • modifiers : const Qt3DInput::QWheelEvent::Modifiers
  • x : const int
  • y : const int

Public Functions

QWheelEvent(const ::QWheelEvent &e)
QPoint angleDelta() const
int buttons() const
bool isAccepted() const
Modifiers modifiers() const
void setAccepted(bool accepted)
QEvent::Type type() const
int x() const
int y() const
typedef QWheelEventPtr

Detailed Description

Mouse wheel events occur when the mouse is rotated.

See also QKeyEvent, QMouseEvent, and QMouseHandler.

Member Type Documentation

enum QWheelEvent::Buttons

ConstantValue
Qt3DInput::QWheelEvent::LeftButtonQt::LeftButton
Qt3DInput::QWheelEvent::RightButtonQt::RightButton
Qt3DInput::QWheelEvent::MiddleButtonQt::MiddleButton
Qt3DInput::QWheelEvent::BackButtonQt::BackButton
Qt3DInput::QWheelEvent::NoButtonQt::NoButton

enum QWheelEvent::Modifiers

ConstantValue
Qt3DInput::QWheelEvent::NoModifierQt::NoModifier
Qt3DInput::QWheelEvent::ShiftModifierQt::ShiftModifier
Qt3DInput::QWheelEvent::ControlModifierQt::ControlModifier
Qt3DInput::QWheelEvent::AltModifierQt::AltModifier
Qt3DInput::QWheelEvent::MetaModifierQt::MetaModifier
Qt3DInput::QWheelEvent::KeypadModifierQt::KeypadModifier

Property Documentation

accepted : bool

Specifies if the mouse wheel event has been accepted

Access functions:

bool isAccepted() const
void setAccepted(bool accepted)

angleDelta : const QPoint

Specifies The change wheel angle of the mouse wheel event

Access functions:

QPoint angleDelta() const

buttons : const int

Specifies the button if present in the mouse wheel event

Access functions:

int buttons() const

modifiers : const Qt3DInput::QWheelEvent::Modifiers

Specifies if any modifiers were applied to the mouse wheel event

Access functions:

Modifiers modifiers() const

x : const int

Specifies The X coordinate of the mouse wheel event

Access functions:

int x() const

y : const int

Specifies The Y coordinate of the mouse wheel event

Access functions:

int y() const

Member Function Documentation

QWheelEvent::QWheelEvent(const ::QWheelEvent &e)

Constructs a new QWheelEvent instance from the QWheelEvent e.

QPoint QWheelEvent::angleDelta() const

Returns the distance that the wheel is rotated, in eighths of a degree. A positive value indicates that the wheel was rotated forward (away from the user), a negative value indicates the wheel was rotated backward (toward the user).

Note: Getter function for property angleDelta.

int QWheelEvent::buttons() const

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

Note: Getter function for property buttons.

bool QWheelEvent::isAccepted() const

Returns whether the event was accepted.

Note: Getter function for property accepted.

Modifiers QWheelEvent::modifiers() const

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

Note: Getter function for property modifiers.

void QWheelEvent::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 QWheelEvent::type() const

Returns the QEvent::Type of the event.

int QWheelEvent::x() const

Returns the x position of the mouse event.

Note: Getter function for property x.

int QWheelEvent::y() const

Returns the x position of the mouse event.

Note: Getter function for property y.

Related Non-Members

typedef QWheelEventPtr

A shared pointer for QWheelEvent.