org::kde::kquickcontrols::KeySequenceItem

Search for usage in LXR

org::kde::kquickcontrols::KeySequenceItem Class Reference

Inherits RowLayout.

Properties

alias checkForConflictsAgainst
 
alias keySequence
 
alias modifierlessAllowed
 
alias modifierOnlyAllowed
 
alias multiKeyShortcutsAllowed
 
bool showCancelButton
 
bool showClearButton
 

Signals

void captureFinished ()
 
void keySequenceModified ()
 

Public Member Functions

void startCapturing ()
 

Detailed Description

Import Statement

import org.kde.kquickcontrols
Version
2.0

Definition at line 8 of file KeySequenceItem.qml.

Property Documentation

◆ checkForConflictsAgainst

alias org::kde::kquickcontrols::KeySequenceItem::checkForConflictsAgainst
read

This property 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:

  • ShortcutType.None Do not check for conflicts.
  • ShortcutType.StandardShortcuts Check against standard shortcuts.
    See also
    KStandardshortcut
  • ShortcutType.GlobalShortcuts Check against global shortcuts.
    See also
    KGlobalAccel
    The default is ShortcutType.GlobalShortcuts | ShortcutType.StandardShortcut
    Since
    5.74

Definition at line 33 of file KeySequenceItem.qml.

◆ keySequence

alias org::kde::kquickcontrols::KeySequenceItem::keySequence
read

Definition at line 21 of file KeySequenceItem.qml.

◆ modifierlessAllowed

alias org::kde::kquickcontrols::KeySequenceItem::modifierlessAllowed
read

Definition at line 17 of file KeySequenceItem.qml.

◆ modifierOnlyAllowed

alias org::kde::kquickcontrols::KeySequenceItem::modifierOnlyAllowed
read

TODO KF6 default to true.

Definition at line 15 of file KeySequenceItem.qml.

◆ multiKeyShortcutsAllowed

alias org::kde::kquickcontrols::KeySequenceItem::multiKeyShortcutsAllowed
read

Definition at line 19 of file KeySequenceItem.qml.

◆ showCancelButton

bool org::kde::kquickcontrols::KeySequenceItem::showCancelButton
read

Definition at line 13 of file KeySequenceItem.qml.

◆ showClearButton

bool org::kde::kquickcontrols::KeySequenceItem::showClearButton
read

Definition at line 11 of file KeySequenceItem.qml.

Member Function Documentation

◆ captureFinished

void org::kde::kquickcontrols::KeySequenceItem::captureFinished ( )
signal

This signal is emitted after the user introduces a new key sequence.

Since
5.68
Deprecated
Use keySequenceModified()

◆ startCapturing()

void org::kde::kquickcontrols::KeySequenceItem::startCapturing ( )

Start capturing a key sequence.

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

Since
5.70

The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 17 2024 11:48:19 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.