KeySequenceItem QML Type

Import Statement: import org.kde.kquickcontrols
Inherits:

RowLayout

Properties

Signals

Methods

Detailed Description

Property Documentation

checkForConflictsAgainst : enumeration

Controls which types of shortcuts are checked for conflicts when the keySequence is set.

If a conflict is detected, a messagebox will be shown asking the user to confirm their input. Valid values are combinations of the following flags:

ConstantDescription
ShortcutType.NoneDo not check for conflicts.
ShortcutType.StandardShortcutsCheck against standard shortcuts.
ShortcutType.GlobalShortcutsCheck against global shortcuts.

The default is ShortcutType.GlobalShortcuts | ShortcutType.StandardShortcut.

See also KStandardShortcut and KGlobalAccel.


currentKeySequence : keySequence


keySequence : alias


multiKeyShortcutsAllowed : alias


patterns : enumeration [since 6.16]

Specifies what components the recorded shortcut must have, for example whether the shortcut must contain only modifier keys (Modifier) or modifiers keys and a normal key (ModifierAndKey).

The patterns property can contain one or more recording patterns. For example, if the recorder accepts both normal and modifier only shortcuts, e.g. Modifier | ModifierAndKey. Valid values are combinations of the following flags:

ConstantDescription
ShortcutPattern.ModifierThe recorded shortcut must contain one or more modifier keys (Meta, Shift, Ctrl, or Alt).
ShortcutPattern.KeyThe recorded shortcut must contain only one regular key, e.g. "A".
ShortcutPattern.ModifierAndKeyThe recorded shortcut must contain one or more modifier keys followed by a regular key, e.g. Meta+A.

The default is ShortcutPattern.ModifierAndKey.

This property was introduced in 6.16.


showCancelButton : bool


showClearButton : bool


Signal Documentation

keySequenceModified()

Emitted whenever the key sequence is modified by the user, interacting with the component.

Either by interacting capturing a key sequence or pressing the clear button.

Note: The corresponding handler is onKeySequenceModified.


Method Documentation

startCapturing()

Start capturing a key sequence.

This is equivalent to the user clicking on the main button of the item.