QKeySequenceEdit Class | Qt Widgets 6.4.3

- Qt 6.4
- Qt Widgets
- C++ Classes
- QKeySequenceEdit
- Qt 6.4.3 Reference Documentation

# QKeySequenceEdit Class

The QKeySequenceEdit widget allows to input a QKeySequence. More...

Header: | #include <QKeySequenceEdit>
CMake: | find_package(Qt6 REQUIRED COMPONENTS Widgets) target_link_libraries(mytarget PRIVATE Qt6::Widgets)
qmake: | QT += widgets
Since: | Qt 5.2
Inherits: | QWidget

- List of all members, including inherited members

## Properties

- clearButtonEnabled : bool
- keySequence : QKeySequence

## Public Functions

| QKeySequenceEdit(const QKeySequence &keySequence, QWidget *parent = nullptr)
| QKeySequenceEdit(QWidget *parent = nullptr)
virtual | ~QKeySequenceEdit()
bool | isClearButtonEnabled() const
QKeySequence | keySequence() const
void | setClearButtonEnabled(bool enable)

## Public Slots

void | clear()
void | setKeySequence(const QKeySequence &keySequence)

## Signals

void | editingFinished()
void | keySequenceChanged(const QKeySequence &keySequence)

## Reimplemented Protected Functions

virtual bool | event(QEvent *e) override
virtual void | focusOutEvent(QFocusEvent *e) override
virtual void | keyPressEvent(QKeyEvent *e) override
virtual void | keyReleaseEvent(QKeyEvent *e) override
virtual void | timerEvent(QTimerEvent *e) override

## Detailed Description

This widget lets the user choose a QKeySequence, which is usually used as a shortcut. The recording is initiated when the widget receives the focus and ends one second after the user releases the last key.

See also QKeySequenceEdit::keySequence.

## Property Documentation

### `[since 6.4]` clearButtonEnabled : bool

This property holds whether the key sequence edit displays a clear button when it is not empty.

If enabled, the key sequence edit displays a trailing clear button when it contains some text, otherwise the line edit does not show a clear button (the default).

This property was introduced in Qt 6.4.

Access functions:

bool | isClearButtonEnabled() const
void | setClearButtonEnabled(bool enable)

### keySequence : QKeySequence

This property contains the currently chosen key sequence.

The shortcut can be changed by the user or via setter function.

Access functions:

QKeySequence | keySequence() const
void | setKeySequence(const QKeySequence &keySequence)

Notifier signal:

void | keySequenceChanged(const QKeySequence &keySequence)

## Member Function Documentation

### QKeySequenceEdit::QKeySequenceEdit(const QKeySequence &keySequence, QWidget *parent = nullptr)

Constructs a QKeySequenceEdit widget with the given keySequence and parent.

### QKeySequenceEdit::QKeySequenceEdit(QWidget *parent = nullptr)

Constructs a QKeySequenceEdit widget with the given parent.

### `[slot]` void QKeySequenceEdit::clear()

Clears the current key sequence.

### `[signal]` void QKeySequenceEdit::editingFinished()

This signal is emitted when the user finishes entering the shortcut.

Note: there is a one second delay before releasing the last key and emitting this signal.

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

Destroys the QKeySequenceEdit object.

### `[override virtual protected]` bool QKeySequenceEdit::event(QEvent *e)

Reimplements: QWidget::event(QEvent *event).

### `[override virtual protected]` void QKeySequenceEdit::focusOutEvent(QFocusEvent *e)

Reimplements: QWidget::focusOutEvent(QFocusEvent *event).

### `[override virtual protected]` void QKeySequenceEdit::keyPressEvent(QKeyEvent *e)

Reimplements: QWidget::keyPressEvent(QKeyEvent *event).

### `[override virtual protected]` void QKeySequenceEdit::keyReleaseEvent(QKeyEvent *e)

Reimplements: QWidget::keyReleaseEvent(QKeyEvent *event).

### `[override virtual protected]` void QKeySequenceEdit::timerEvent(QTimerEvent *e)

Reimplements: QObject::timerEvent(QTimerEvent *event).