QMouseEventTransition Class

The QMouseEventTransition class provides a transition for mouse events. More...

Header: #include <QMouseEventTransition>
CMake: find_package(Qt6 REQUIRED COMPONENTS StateMachine)
target_link_libraries(mytarget PRIVATE Qt6::StateMachine)
qmake: QT += statemachine
Inherits: QEventTransition

Properties

Public Functions

QMouseEventTransition(QState *sourceState = nullptr)
QMouseEventTransition(QObject *object, QEvent::Type type, Qt::MouseButton button, QState *sourceState = nullptr)
virtual ~QMouseEventTransition()
QBindable<Qt::MouseButton> bindableButton()
QBindable<Qt::KeyboardModifiers> bindableModifierMask()
Qt::MouseButton button() const
QPainterPath hitTestPath() const
Qt::KeyboardModifiers modifierMask() const
void setButton(Qt::MouseButton button)
void setHitTestPath(const QPainterPath &path)
void setModifierMask(Qt::KeyboardModifiers modifierMask)

Reimplemented Protected Functions

virtual bool eventTest(QEvent *event) override
virtual void onTransition(QEvent *event) override

Detailed Description

QMouseEventTransition is part of Qt State Machine Framework.

See also QState::addTransition().

Property Documentation

[bindable] button : Qt::MouseButton

Note: This property supports QProperty bindings.

This property holds the button that this mouse event transition is associated with

[bindable] modifierMask : Qt::KeyboardModifiers

Note: This property supports QProperty bindings.

This property holds the keyboard modifier mask that this mouse event transition checks for

Member Function Documentation

QMouseEventTransition::QMouseEventTransition(QState *sourceState = nullptr)

Constructs a new mouse event transition with the given sourceState.

QMouseEventTransition::QMouseEventTransition(QObject *object, QEvent::Type type, Qt::MouseButton button, QState *sourceState = nullptr)

Constructs a new mouse event transition for events of the given type for the given object, with the given button and sourceState.

[virtual noexcept] QMouseEventTransition::~QMouseEventTransition()

Destroys this mouse event transition.

Qt::MouseButton QMouseEventTransition::button() const

Returns the button that this mouse event transition checks for.

Note: Getter function for property button.

See also setButton().

[override virtual protected] bool QMouseEventTransition::eventTest(QEvent *event)

Reimplements: QEventTransition::eventTest(QEvent *event).

QPainterPath QMouseEventTransition::hitTestPath() const

Returns the hit test path for this mouse event transition.

See also setHitTestPath().

Qt::KeyboardModifiers QMouseEventTransition::modifierMask() const

Returns the keyboard modifier mask that this mouse event transition checks for.

Note: Getter function for property modifierMask.

See also setModifierMask().

[override virtual protected] void QMouseEventTransition::onTransition(QEvent *event)

Reimplements: QEventTransition::onTransition(QEvent *event).

void QMouseEventTransition::setButton(Qt::MouseButton button)

Sets the button that this mouse event transition will check for.

Note: Setter function for property button.

See also button().

void QMouseEventTransition::setHitTestPath(const QPainterPath &path)

Sets the hit test path for this mouse event transition to path. If a valid path has been set, the transition will only trigger if the mouse event position (QMouseEvent::pos()) is inside the path.

See also hitTestPath() and QPainterPath::contains().

void QMouseEventTransition::setModifierMask(Qt::KeyboardModifiers modifierMask)

Sets the keyboard modifier mask that this mouse event transition will check for to modifierMask.

Note: Setter function for property modifierMask.

See also modifierMask().