QKeyEventTransition Class | Qt Widgets 5.12.12

- Qt 5.12
- Qt Widgets
- C++ Classes
- QKeyEventTransition
- Qt 5.12.12 Reference Documentation

# QKeyEventTransition Class

The QKeyEventTransition class provides a transition for key events. More...

Header: | #include <QKeyEventTransition>
qmake: | QT += widgets
Since: | Qt 4.6
Inherits: | QEventTransition

- List of all members, including inherited members
- Obsolete members

## Properties

- key : int
- modifierMask : Qt::KeyboardModifiers

- 2 properties inherited from QEventTransition
- 4 properties inherited from QAbstractTransition
- 1 property inherited from QObject

## Public Functions

| QKeyEventTransition(QState *sourceState = nullptr)
| QKeyEventTransition(QObject *object, QEvent::Type type, int key, QState *sourceState = nullptr)
virtual | ~QKeyEventTransition()
int | key() const
Qt::KeyboardModifiers | modifierMask() const
void | setKey(int key)
void | setModifierMask(Qt::KeyboardModifiers modifierMask)

- 4 public functions inherited from QEventTransition
- 11 public functions inherited from QAbstractTransition
- 31 public functions inherited from QObject

## Static Public Members

const QMetaObject | staticMetaObject

- 9 static public members inherited from QObject

## Reimplemented Protected Functions

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

- 3 protected functions inherited from QEventTransition
- 3 protected functions inherited from QAbstractTransition
- 9 protected functions inherited from QObject

### Additional Inherited Members

- 1 public slot inherited from QObject
- 3 signals inherited from QAbstractTransition
- 2 signals inherited from QObject
- 3 protected functions inherited from QEventTransition
- 3 protected functions inherited from QAbstractTransition
- 9 protected functions inherited from QObject

## Detailed Description

The QKeyEventTransition class provides a transition for key events.

QKeyEventTransition is part of The State Machine Framework.

See also QState::addTransition().

## Property Documentation

### key : int

This property holds the key that this key event transition is associated with

Access functions:

int | key() const
void | setKey(int key)

### modifierMask : Qt::KeyboardModifiers

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

Access functions:

Qt::KeyboardModifiers | modifierMask() const
void | setModifierMask(Qt::KeyboardModifiers modifierMask)

## Member Function Documentation

### QKeyEventTransition::QKeyEventTransition(QState *sourceState = nullptr)

Constructs a new key event transition with the given sourceState.

### QKeyEventTransition::QKeyEventTransition(QObject *object, QEvent::Type type, int key, QState *sourceState = nullptr)

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

### `[virtual]` QKeyEventTransition::~QKeyEventTransition()

Destroys this key event transition.

### `[override virtual protected]` bool QKeyEventTransition::eventTest(QEvent *event)

Reimplemented from QEventTransition::eventTest().

### int QKeyEventTransition::key() const

Returns the key that this key event transition checks for.

Note: Getter function for property key.

See also setKey().

### Qt::KeyboardModifiers QKeyEventTransition::modifierMask() const

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

Note: Getter function for property modifierMask.

See also setModifierMask().

### `[override virtual protected]` void QKeyEventTransition::onTransition(QEvent *event)

Reimplemented from QEventTransition::onTransition().

### void QKeyEventTransition::setKey(int key)

Sets the key that this key event transition will check for.

Note: Setter function for property key.

See also key().

### void QKeyEventTransition::setModifierMask(Qt::KeyboardModifiers modifierMask)

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

Note: Setter function for property modifierMask.

See also modifierMask().