KKeySequenceWidget

#include <KKeySequenceWidget>

Inheritance diagram for KKeySequenceWidget:

[legend]

Public Types
enum	Validation { Validate = 0 , NoValidate = 1 }

Public Types inherited from QWidget
enum	RenderFlag

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric

Properties
ShortcutTypes	checkForConflictsAgainst

QKeySequence	keySequence

bool	modifierlessAllowed

bool	modifierOnlyAllowed

bool	multiKeyShortcutsAllowed

KKeySequenceRecorder::Patterns	patterns

bool	recording

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	tabletTracking

	toolTip

	toolTipDuration

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Public Member Functions
	KKeySequenceWidget (QWidget *parent=nullptr)

	~KKeySequenceWidget () override

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, Qt::WindowFlags f)

bool	acceptDrops () const const

QString	accessibleDescription () const const

QString	accessibleName () const const

QList< QAction * >	actions () const const

void	activateWindow ()

QAction *	addAction (const QIcon &icon, const QString &text)

QAction *	addAction (const QIcon &icon, const QString &text, Args &&... args)

QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut)

QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, Args &&... args)

QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, const QObject receiver, const char member, Qt::ConnectionType type)

QAction *	addAction (const QIcon &icon, const QString &text, const QObject receiver, const char member, Qt::ConnectionType type)

QAction *	addAction (const QString &text)

QAction *	addAction (const QString &text, Args &&... args)

QAction *	addAction (const QString &text, const QKeySequence &shortcut)

QAction *	addAction (const QString &text, const QKeySequence &shortcut, Args &&... args)

QAction *	addAction (const QString &text, const QKeySequence &shortcut, const QObject receiver, const char member, Qt::ConnectionType type)

QAction *	addAction (const QString &text, const QObject receiver, const char member, Qt::ConnectionType type)

void	addAction (QAction *action)

void	addActions (const QList< QAction * > &actions)

void	adjustSize ()

bool	autoFillBackground () const const

QPalette::ColorRole	backgroundRole () const const

QBackingStore *	backingStore () const const

QSize	baseSize () const const

QWidget *	childAt (const QPoint &p) const const

QWidget *	childAt (int x, int y) const const

QRect	childrenRect () const const

QRegion	childrenRegion () const const

void	clearFocus ()

void	clearMask ()

bool	close ()

QMargins	contentsMargins () const const

QRect	contentsRect () const const

Qt::ContextMenuPolicy	contextMenuPolicy () const const

QCursor	cursor () const const

void	customContextMenuRequested (const QPoint &pos)

WId	effectiveWinId () const const

void	ensurePolished () const const

Qt::FocusPolicy	focusPolicy () const const

QWidget *	focusProxy () const const

QWidget *	focusWidget () const const

const QFont &	font () const const

QFontInfo	fontInfo () const const

QFontMetrics	fontMetrics () const const

QPalette::ColorRole	foregroundRole () const const

QRect	frameGeometry () const const

QSize	frameSize () const const

const QRect &	geometry () const const

QPixmap	grab (const QRect &rectangle)

void	grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const const

QGraphicsProxyWidget *	graphicsProxyWidget () const const

bool	hasEditFocus () const const

bool	hasFocus () const const

virtual bool	hasHeightForWidth () const const

bool	hasMouseTracking () const const

bool	hasTabletTracking () const const

int	height () const const

virtual int	heightForWidth (int w) const const

void	hide ()

Qt::InputMethodHints	inputMethodHints () const const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, const QList< QAction > &actions)

bool	isActiveWindow () const const

bool	isAncestorOf (const QWidget *child) const const

bool	isEnabled () const const

bool	isEnabledTo (const QWidget *ancestor) const const

bool	isFullScreen () const const

bool	isHidden () const const

bool	isMaximized () const const

bool	isMinimized () const const

bool	isModal () const const

bool	isTopLevel () const const

bool	isVisible () const const

bool	isVisibleTo (const QWidget *ancestor) const const

bool	isWindow () const const

bool	isWindowModified () const const

QLayout *	layout () const const

Qt::LayoutDirection	layoutDirection () const const

QLocale	locale () const const

void	lower ()

QPoint	mapFrom (const QWidget *parent, const QPoint &pos) const const

QPointF	mapFrom (const QWidget *parent, const QPointF &pos) const const

QPoint	mapFromGlobal (const QPoint &pos) const const

QPointF	mapFromGlobal (const QPointF &pos) const const

QPoint	mapFromParent (const QPoint &pos) const const

QPointF	mapFromParent (const QPointF &pos) const const

QPoint	mapTo (const QWidget *parent, const QPoint &pos) const const

QPointF	mapTo (const QWidget *parent, const QPointF &pos) const const

QPoint	mapToGlobal (const QPoint &pos) const const

QPointF	mapToGlobal (const QPointF &pos) const const

QPoint	mapToParent (const QPoint &pos) const const

QPointF	mapToParent (const QPointF &pos) const const

QRegion	mask () const const

int	maximumHeight () const const

QSize	maximumSize () const const

int	maximumWidth () const const

int	minimumHeight () const const

QSize	minimumSize () const const

virtual QSize	minimumSizeHint () const const

int	minimumWidth () const const

void	move (const QPoint &)

void	move (int x, int y)

QWidget *	nativeParentWidget () const const

QWidget *	nextInFocusChain () const const

QRect	normalGeometry () const const

void	overrideWindowFlags (Qt::WindowFlags flags)

virtual QPaintEngine *	paintEngine () const const override

const QPalette &	palette () const const

QWidget *	parentWidget () const const

QPoint	pos () const const

QWidget *	previousInFocusChain () const const

	QWIDGETSIZE_MAX QWIDGETSIZE_MAX

void	raise ()

QRect	rect () const const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, RenderFlags renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, RenderFlags renderFlags)

void	repaint ()

void	repaint (const QRect &rect)

void	repaint (const QRegion &rgn)

void	repaint (int x, int y, int w, int h)

void	resize (const QSize &)

void	resize (int w, int h)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const const

QScreen *	screen () const const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setContentsMargins (const QMargins &margins)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus ()

void	setFocus (Qt::FocusReason reason)

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (const QRect &)

void	setGeometry (int x, int y, int w, int h)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setInputMethodHints (Qt::InputMethodHints hints)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, Qt::WindowFlags f)

void	setScreen (QScreen *screen)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

void	setStyleSheet (const QString &styleSheet)

void	setTabletTracking (bool enable)

void	setToolTip (const QString &)

void	setToolTipDuration (int msec)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

virtual void	setVisible (bool visible)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlag (Qt::WindowType flag, bool on)

void	setWindowFlags (Qt::WindowFlags type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (Qt::WindowStates windowState)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const const

virtual QSize	sizeHint () const const

QSize	sizeIncrement () const const

QSizePolicy	sizePolicy () const const

void	stackUnder (QWidget *w)

QString	statusTip () const const

QStyle *	style () const const

QString	styleSheet () const const

bool	testAttribute (Qt::WidgetAttribute attribute) const const

QString	toolTip () const const

int	toolTipDuration () const const

QWidget *	topLevelWidget () const const

bool	underMouse () const const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	update ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	updateGeometry ()

bool	updatesEnabled () const const

QRegion	visibleRegion () const const

QString	whatsThis () const const

int	width () const const

QWidget *	window () const const

QString	windowFilePath () const const

Qt::WindowFlags	windowFlags () const const

QWindow *	windowHandle () const const

QIcon	windowIcon () const const

void	windowIconChanged (const QIcon &icon)

QString	windowIconText () const const

void	windowIconTextChanged (const QString &iconText)

Qt::WindowModality	windowModality () const const

qreal	windowOpacity () const const

QString	windowRole () const const

Qt::WindowStates	windowState () const const

QString	windowTitle () const const

void	windowTitleChanged (const QString &title)

Qt::WindowType	windowType () const const

WId	winId () const const

int	x () const const

int	y () const const

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

QBindable< QString >	bindableObjectName ()

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 () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, 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

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

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_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	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	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	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

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

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

bool	signalsBlocked () const const

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

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

QThread *	thread () const const

Public Member Functions inherited from QPaintDevice
int	colorCount () const const

int	depth () const const

qreal	devicePixelRatio () const const

qreal	devicePixelRatioF () const const

int	height () const const

int	heightMM () const const

int	logicalDpiX () const const

int	logicalDpiY () const const

bool	paintingActive () const const

int	physicalDpiX () const const

int	physicalDpiY () const const

int	width () const const

int	widthMM () const const

Configuration
Configuration options for the widget. See also ShortcutTypes
enum	ShortcutType { None = 0x00 , LocalShortcuts = 0x01 , StandardShortcuts = 0x02 , GlobalShortcuts = 0x04 }

typedef QFlags< ShortcutType >	ShortcutTypes

void	setCheckForConflictsAgainst (ShortcutTypes types)

ShortcutTypes	checkForConflictsAgainst () const

void	setMultiKeyShortcutsAllowed (bool)

bool	multiKeyShortcutsAllowed () const

void	setModifierlessAllowed (bool allow)

bool	isModifierlessAllowed ()

void	setModifierOnlyAllowed (bool allow)

bool	modifierOnlyAllowed () const

void	setClearButtonShown (bool show)

bool	isKeySequenceAvailable (const QKeySequence &seq) const

QKeySequence	keySequence () const

void	setCheckActionCollections (const QList< KActionCollection * > &actionCollections)

void	setComponentName (const QString &componentName)

bool	isRecording () const

void	setPatterns (KKeySequenceRecorder::Patterns patterns)

KKeySequenceRecorder::Patterns	patterns () const

void	keySequenceChanged (const QKeySequence &seq)

void	stealShortcut (const QKeySequence &seq, QAction *action)

void	recordingChanged ()

void	captureKeySequence ()

void	setKeySequence (const QKeySequence &seq, Validation val=NoValidate)

void	clearKeySequence ()

void	applyStealShortcut ()

Additional Inherited Members
Static Public Member Functions inherited from QWidget
QWidget *	createWindowContainer (QWindow window, QWidget parent, Qt::WindowFlags flags)

QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

void	setTabOrder (std::initializer_list< QWidget * > widgets)

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)

Public Attributes inherited from QWidget
	DrawChildren

	DrawWindowBackground

	IgnoreMask

typedef	RenderFlags

Public Attributes inherited from QObject
typedef	QObjectList

Public Attributes inherited from QPaintDevice
	PdmDepth

	PdmDevicePixelRatio

	PdmDevicePixelRatioScaled

	PdmDpiX

	PdmDpiY

	PdmHeight

	PdmHeightMM

	PdmNumColors

	PdmPhysicalDpiX

	PdmPhysicalDpiY

	PdmWidth

	PdmWidthMM

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	changeEvent (QEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEnterEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	initPainter (QPainter *painter) const const override

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	leaveEvent (QEvent *event)

virtual int	metric (PaintDeviceMetric m) const const override

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual bool	nativeEvent (const QByteArray &eventType, void message, qintptr result)

virtual void	paintEvent (QPaintEvent *event)

virtual void	resizeEvent (QResizeEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus (Qt::InputMethodQuery query)

virtual void	wheelEvent (QWheelEvent *event)

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

A widget to input a QKeySequence.

This widget lets the user choose a QKeySequence, which is usually used as a shortcut key. The recording is initiated by calling captureKeySequence() or the user clicking into the widget.

The widgets provides support for conflict handling. See setCheckForConflictsAgainst() for more information.

KKeySequenceWidget

Author: Mark Donohoe donoh.nosp@m.oe@k.nosp@m.de.or.nosp@m.g

Definition at line 39 of file kkeysequencewidget.h.

Member Typedef Documentation

◆ ShortcutTypes

typedef QFlags< ShortcutType > KKeySequenceWidget::ShortcutTypes

Stores a combination of ShortcutType values.

Definition at line 114 of file kkeysequencewidget.h.

Member Enumeration Documentation

◆ ShortcutType

enum KKeySequenceWidget::ShortcutType

Enumerator
None	No checking for conflicts.
LocalShortcuts	Check with local shortcuts. See also setCheckActionCollections()
StandardShortcuts	Check against standard shortcuts. See also KStandardShortcut
GlobalShortcuts	Check against global shortcuts. See also KGlobalAccel

Definition at line 105 of file kkeysequencewidget.h.

◆ Validation

enum KKeySequenceWidget::Validation

An enum about validation when setting a key sequence.

See also: setKeySequence()

Enumerator
Validate	Validate key sequence.
NoValidate	Use key sequence without validation.

Definition at line 80 of file kkeysequencewidget.h.

Property Documentation

◆ checkForConflictsAgainst

ShortcutTypes KKeySequenceWidget::checkForConflictsAgainst

readwrite

Definition at line 48 of file kkeysequencewidget.h.

◆ keySequence

QKeySequence KKeySequenceWidget::keySequence

readwrite

Since: 5.65

Definition at line 44 of file kkeysequencewidget.h.

◆ modifierlessAllowed

bool KKeySequenceWidget::modifierlessAllowed

readwrite

Deprecated: since 6.12, use the patterns property

Definition at line 53 of file kkeysequencewidget.h.

◆ modifierOnlyAllowed

bool KKeySequenceWidget::modifierOnlyAllowed

readwrite

Since: 6.1

Deprecated: since 6.12, use the patterns property

Definition at line 59 of file kkeysequencewidget.h.

◆ multiKeyShortcutsAllowed

bool KKeySequenceWidget::multiKeyShortcutsAllowed

readwrite

Definition at line 46 of file kkeysequencewidget.h.

◆ patterns

KKeySequenceRecorder::Patterns KKeySequenceWidget::patterns

readwrite

Specifies the accepted shortcut formats.

Default is KKeySequenceRecorder::ModifierAndKey.

Since: 6.12

Definition at line 75 of file kkeysequencewidget.h.

◆ recording

bool KKeySequenceWidget::recording

read

Indicates whether a key sequence is currently being recorded.

Since: 6.12

Definition at line 66 of file kkeysequencewidget.h.

Constructor & Destructor Documentation

◆ KKeySequenceWidget()

KKeySequenceWidget::KKeySequenceWidget ( QWidget * parent = nullptr )

explicit

Constructor.

Definition at line 408 of file kkeysequencewidget.cpp.

◆ ~KKeySequenceWidget()

KKeySequenceWidget::~KKeySequenceWidget ( )

override

Destructs the widget.

Definition at line 428 of file kkeysequencewidget.cpp.

Member Function Documentation

◆ applyStealShortcut

void KKeySequenceWidget::applyStealShortcut ( )

slot

Actually remove the shortcut that the user wanted to steal, from the action that was using it.

This only applies to actions provided to us by setCheckActionCollections() and setCheckActionList().

Global and Standard Shortcuts have to be stolen immediately when the user gives his consent (technical reasons). That means those changes will be active even if you never call applyStealShortcut().

To be called before you apply your changes. No local shortcuts are stolen until this function is called.

Definition at line 556 of file kkeysequencewidget.cpp.

◆ captureKeySequence

void KKeySequenceWidget::captureKeySequence ( )

slot

Capture a shortcut from the keyboard.

This call will only return once a key sequence has been captured or input was aborted. If a key sequence was input, keySequenceChanged() will be emitted.

See also: setModifierlessAllowed()

Definition at line 524 of file kkeysequencewidget.cpp.

◆ checkForConflictsAgainst()

KKeySequenceWidget::ShortcutTypes KKeySequenceWidget::checkForConflictsAgainst ( ) const

The shortcut types we check for conflicts.

See also: setCheckForConflictsAgainst()

Since: 4.2

Definition at line 433 of file kkeysequencewidget.cpp.

◆ clearKeySequence

void KKeySequenceWidget::clearKeySequence ( )

slot

Clear the key sequence.

Definition at line 550 of file kkeysequencewidget.cpp.

◆ isKeySequenceAvailable()

bool KKeySequenceWidget::isKeySequenceAvailable ( const QKeySequence & seq ) const

Checks whether the key sequence seq is available to grab.

The sequence is checked under the same rules as if it has been typed by the user. This method is useful if you get key sequences from another input source and want to check if it is save to set them.

Since: 4.2

Definition at line 473 of file kkeysequencewidget.cpp.

◆ isModifierlessAllowed()

bool KKeySequenceWidget::isModifierlessAllowed ( )

See also: setModifierlessAllowed()

Deprecated: since 6.12, use patterns() instead

Definition at line 484 of file kkeysequencewidget.cpp.

◆ isRecording()

bool KKeySequenceWidget::isRecording ( ) const

Returns true if a key sequence is currently being recorded; otherwise returns false.

Since: 6.12

Definition at line 443 of file kkeysequencewidget.cpp.

◆ keySequence()

QKeySequence KKeySequenceWidget::keySequence ( ) const

Return the currently selected key sequence.

Definition at line 530 of file kkeysequencewidget.cpp.

◆ keySequenceChanged

void KKeySequenceWidget::keySequenceChanged ( const QKeySequence & seq )

signal

This signal is emitted when the current key sequence has changed, be it by user input or programmatically.

◆ modifierOnlyAllowed()

bool KKeySequenceWidget::modifierOnlyAllowed ( ) const

Deprecated: since 6.12, use patterns() instead

Definition at line 498 of file kkeysequencewidget.cpp.

◆ multiKeyShortcutsAllowed()

bool KKeySequenceWidget::multiKeyShortcutsAllowed ( ) const

Definition at line 448 of file kkeysequencewidget.cpp.

◆ patterns()

KKeySequenceRecorder::Patterns KKeySequenceWidget::patterns ( ) const

Returns the accepted shortcut patterns.

Default is Modifier | Key.

Since: 6.12

Definition at line 468 of file kkeysequencewidget.cpp.

◆ recordingChanged

void KKeySequenceWidget::recordingChanged ( )

signal

This signal is emitted when the user begins or finishes recording a key sequence.

It is not emitted when the current key sequence is changed using setKeySequence().

Since: 6.12

◆ setCheckActionCollections()

void KKeySequenceWidget::setCheckActionCollections ( const QList< KActionCollection * > & actionCollections )

Set a list of action collections to check against for conflictuous shortcut.

See also: setCheckForConflictsAgainst()

If a QAction with a conflicting shortcut is found inside this list and its shortcut can be configured (KActionCollection::isShortcutConfigurable() returns true) the user will be prompted whether to steal the shortcut from this action.

Since: 4.1

Definition at line 518 of file kkeysequencewidget.cpp.

◆ setCheckForConflictsAgainst()

void KKeySequenceWidget::setCheckForConflictsAgainst ( ShortcutTypes types )

Configure if the widget should check for conflicts with existing shortcuts.

When capturing a key sequence for local shortcuts you should check against GlobalShortcuts and your other local shortcuts. This is the default.

You have to provide the local actions to check against with setCheckActionCollections().

When capturing a key sequence for a global shortcut you should check against StandardShortcuts, GlobalShortcuts and your local shortcuts.

There are two ways to react to a user agreeing to steal a shortcut:

Listen to the stealShortcut() signal and steal the shortcuts manually. It's your responsibility to save that change later when you think it is appropriate.
Call applyStealShortcut() and KKeySequenceWidget will steal the shortcut. This will save the actionCollections the shortcut is part of so make sure it doesn't inadvertly save some unwanted changes too. Read its documentation for some limitation when handling global shortcuts.

If you want to do the conflict checking yourself here are some code snippets for global ...

QStringList conflicting = KGlobalAccel::findActionNameSystemwide(keySequence);
if (!conflicting.isEmpty()) {
    // Inform and ask the user about the conflict and reassigning
    // the keys sequence
    if (!KGlobalAccel::promptStealShortcutSystemwide(q, conflicting, keySequence)) {
        return true;
    }
    KGlobalAccel::stealShortcutSystemwide(keySequence);
}

... and standard shortcuts

KStandardShortcut::StandardShortcut ssc = KStandardShortcut::find(keySequence);
if (ssc != KStandardShortcut::AccelNone) {
    // We have a conflict
}

Since: 4.2

Definition at line 458 of file kkeysequencewidget.cpp.

◆ setClearButtonShown()

void KKeySequenceWidget::setClearButtonShown ( bool show )

Set whether a small button to set an empty key sequence should be displayed next to the main input widget.

The default is to show the clear button.

Definition at line 513 of file kkeysequencewidget.cpp.

◆ setComponentName()

void KKeySequenceWidget::setComponentName ( const QString & componentName )

If the component using this widget supports shortcuts contexts, it has to set its component name so we can check conflicts correctly.

Definition at line 438 of file kkeysequencewidget.cpp.

◆ setKeySequence

void KKeySequenceWidget::setKeySequence	(	const QKeySequence &	seq,
		Validation	val = NoValidate )

slot

Set the key sequence.

If val == Validate, and the call is actually changing the key sequence, conflictuous shortcut will be checked.

Definition at line 536 of file kkeysequencewidget.cpp.

◆ setModifierlessAllowed()

void KKeySequenceWidget::setModifierlessAllowed ( bool allow )

This only applies to user input, not to setKeySequence().

Set whether to accept "plain" keys without modifiers (like Ctrl, Alt, Meta). Plain keys by our definition include letter and symbol keys and text editing keys (Return, Space, Tab, Backspace, Delete). "Special" keys like F1, Cursor keys, Insert, PageDown will always work.

Deprecated: since 6.12, use setPatterns() instead

Definition at line 489 of file kkeysequencewidget.cpp.

◆ setModifierOnlyAllowed()

void KKeySequenceWidget::setModifierOnlyAllowed ( bool allow )

Whether to allow modifier-only key sequences.

Since: 6.1

Deprecated: since 6.12, use setPatterns() instead

Definition at line 503 of file kkeysequencewidget.cpp.

◆ setMultiKeyShortcutsAllowed()

void KKeySequenceWidget::setMultiKeyShortcutsAllowed ( bool allowed )

Allow multikey shortcuts?

Definition at line 453 of file kkeysequencewidget.cpp.

◆ setPatterns()

void KKeySequenceWidget::setPatterns ( KKeySequenceRecorder::Patterns patterns )

Sets the accepted shortcut patterns to patterns.

A shortcut pattern specifies what components the recoreded shortcut must have, e.g. whether it should include modifier keys, etc.

Since: 6.12

Definition at line 463 of file kkeysequencewidget.cpp.

◆ stealShortcut

void KKeySequenceWidget::stealShortcut	(	const QKeySequence &	seq,
		QAction *	action )

signal

This signal is emitted after the user agreed to steal a shortcut from an action.

This is only done for local shortcuts. So you can be sure action is one of the actions you provided with setCheckActionList() or setCheckActionCollections().

If you listen to that signal and don't call applyStealShortcut() you are supposed to steal the shortcut and save this change.

The documentation for this class was generated from the following files:

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KXmlGui

KKeySequenceWidget

Public Types

Properties

Public Member Functions

Configuration

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ShortcutTypes

Member Enumeration Documentation

◆ ShortcutType

◆ Validation

Property Documentation

◆ checkForConflictsAgainst

◆ keySequence

◆ modifierlessAllowed

◆ modifierOnlyAllowed

◆ multiKeyShortcutsAllowed

◆ patterns

◆ recording

Constructor & Destructor Documentation

◆ KKeySequenceWidget()

◆ ~KKeySequenceWidget()

Member Function Documentation

◆ applyStealShortcut

◆ captureKeySequence

◆ checkForConflictsAgainst()

◆ clearKeySequence

◆ isKeySequenceAvailable()

◆ isModifierlessAllowed()

◆ isRecording()

◆ keySequence()

◆ keySequenceChanged

◆ modifierOnlyAllowed()

◆ multiKeyShortcutsAllowed()

◆ patterns()

◆ recordingChanged

◆ setCheckActionCollections()

◆ setCheckForConflictsAgainst()

◆ setClearButtonShown()

◆ setComponentName()

◆ setKeySequence

◆ setModifierlessAllowed()

◆ setModifierOnlyAllowed()

◆ setMultiKeyShortcutsAllowed()

◆ setPatterns()

◆ stealShortcut