KeySequenceRecorder

#include <KeySequenceRecorder>

Inheritance diagram for KeySequenceRecorder:

Properties
QKeySequence	currentKeySequence

bool	isRecording

bool	modifierlessAllowed

bool	modifierOnlyAllowed

bool	multiKeyShortcutsAllowed

QWindow	window

Properties inherited from QObject
	objectName

Signals
void	currentKeySequenceChanged ()

void	gotKeySequence (const QKeySequence &keySequence)

void	modifierlessAllowedChanged ()

void	modifierOnlyAllowedChanged ()

void	multiKeyShortcutsAllowedChanged ()

void	recordingChanged ()

void	windowChanged ()

Public Slots
void	cancelRecording ()

Public Member Functions
	KeySequenceRecorder (QWindow window, QObject parent=nullptr)

QKeySequence	currentKeySequence () const

bool	isRecording () const

bool	modifierlessAllowed () const

bool	modifierOnlyAllowed () const

bool	multiKeyShortcutsAllowed () const

void	setCurrentKeySequence (const QKeySequence &sequence)

void	setModifierlessAllowed (bool allowed)

void	setModifierOnlyAllowed (bool allowed)

void	setMultiKeyShortcutsAllowed (bool allowed)

void	setWindow (QWindow *window)

Q_INVOKABLE void	startRecording ()

QWindow *	window () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

Additional Inherited Members
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Record a QKeySequence by listening to key events in a window.

After calling startRecording key events in the set window will be captured until a valid QKeySequence has been recorded and gotKeySequence is emitted. See multiKeyShortcutsAllowed and modifierlessAllowed for what constitutes a valid key sequence.

During recording any shortcuts are inhibited and cannot be triggered. Either by using the keyboard-shortcuts-inhibit protocol on Wayland or grabbing the keyboard.

For graphical elements that record key sequences and can optionally perform conflict checking against existing shortcuts see KKeySequenceWidget and KeySequenceItem.

Since: 5.77

See also: KKeySequenceWidget, KeySequenceItem

Definition at line 41 of file keysequencerecorder.h.

Property Documentation

◆ currentKeySequence

QKeySequence KeySequenceRecorder::currentKeySequence

readwrite

The recorded key sequence.

After construction this is empty.

During recording it is continuously updated with the newest user input.

After recording it contains the last recorded QKeySequence

Definition at line 57 of file keysequencerecorder.h.

◆ isRecording

bool KeySequenceRecorder::isRecording

read

Whether key events are currently recorded.

Definition at line 48 of file keysequencerecorder.h.

◆ modifierlessAllowed

bool KeySequenceRecorder::modifierlessAllowed

readwrite

If key presses of "plain" keys without a modifier are considered to be a valid finished key combination.

Plain keys include letter and symbol keys and text editing keys (Return, Space, Tab, Backspace, Delete). Other keys like F1, Cursor keys, Insert, PageDown will always work.

By default this is false.

Definition at line 70 of file keysequencerecorder.h.

◆ modifierOnlyAllowed

bool KeySequenceRecorder::modifierOnlyAllowed

readwrite

It makes it acceptable for the key sequence to be just a modifier (e.g.

Shift or Control)

By default, if only a modifier is pressed and then released, the component will remain waiting for the sequence. When enabled, it will take the modifier key as the key sequence.

By default this is false.

Definition at line 91 of file keysequencerecorder.h.

◆ multiKeyShortcutsAllowed

bool KeySequenceRecorder::multiKeyShortcutsAllowed

readwrite

Controls the amount of key combinations that are captured until recording stops and gotKeySequence is emitted.

By default this is true and "Emacs-style" key sequences are recorded. Recording does not stop until four valid key combination have been recorded. Afterwards currentKeySequence().count() will be 4.

Otherwise only one key combination is recorded before gotKeySequence is emitted with a QKeySequence with a count() of 1.

See also: QKeySequence

Definition at line 81 of file keysequencerecorder.h.

◆ window

QWindow * KeySequenceRecorder::window

readwrite

The window in which the key events are happening that should be recorded.

Definition at line 61 of file keysequencerecorder.h.

Constructor & Destructor Documentation