Search for usage in LXR

#include <KShortcutsEditor>

Inheritance diagram for KShortcutsEditor:

Public Types

enum  ActionType {
  WidgetAction = Qt::WidgetShortcut, WindowAction = Qt::WindowShortcut, ApplicationAction = Qt::ApplicationShortcut, GlobalAction = 4,
  AllActions = 0xffffffff
typedef QFlags< ActionTypeActionTypes
enum  LetterShortcuts { LetterShortcutsDisallowed = 0, LetterShortcutsAllowed }
- Public Types inherited from QWidget
enum  RenderFlag
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric


ActionTypes actionTypes
- Properties inherited from QWidget
- Properties inherited from QObject


void keyChange ()

Public Slots

void allDefault ()
void printShortcuts () const
void resizeColumns ()

Public Member Functions

 KShortcutsEditor (KActionCollection *collection, QWidget *parent, ActionTypes actionTypes=AllActions, LetterShortcuts allowLetterShortcuts=LetterShortcutsAllowed)
 KShortcutsEditor (QWidget *parent, ActionTypes actionTypes=AllActions, LetterShortcuts allowLetterShortcuts=LetterShortcutsAllowed)
 ~KShortcutsEditor () override
ActionTypes actionTypes () const
void addCollection (KActionCollection *, const QString &title=QString())
void clearCollections ()
void clearConfiguration ()
void commit ()
void exportConfiguration (KConfigBase *config) const
void exportConfiguration (KConfig *config) const
void importConfiguration (KConfigBase *config)
void importConfiguration (KConfig *config)
bool isModified () const
void save ()
void setActionTypes (ActionTypes actionTypes)
void undo ()
void undoChanges ()
void writeConfiguration (KConfigGroup *config=nullptr) const
- 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 ()
void addAction (QAction *action)
void addActions (QList< QAction * > actions)
void adjustSize ()
bool autoFillBackground () const const
QPalette::ColorRole backgroundRole () const const
QBackingStorebackingStore () const const
QSize baseSize () const const
QWidgetchildAt (int x, int y) const const
QWidgetchildAt (const QPoint &p) 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
QWidgetfocusProxy () const const
QWidgetfocusWidget () const const
const QFontfont () const const
QFontInfo fontInfo () const const
QFontMetrics fontMetrics () const const
QPalette::ColorRole foregroundRole () const const
QRect frameGeometry () const const
QSize frameSize () const const
const QRectgeometry () const const
void getContentsMargins (int *left, int *top, int *right, int *bottom) 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)
QGraphicsEffectgraphicsEffect () const const
QGraphicsProxyWidgetgraphicsProxyWidget () 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, 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 isEnabledToTLW () 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
QLayoutlayout () const const
Qt::LayoutDirection layoutDirection () const const
QLocale locale () const const
void lower ()
QPoint mapFrom (const QWidget *parent, const QPoint &pos) const const
QPoint mapFromGlobal (const QPoint &pos) const const
QPoint mapFromParent (const QPoint &pos) const const
QPoint mapTo (const QWidget *parent, const QPoint &pos) const const
QPoint mapToGlobal (const QPoint &pos) const const
QPoint mapToParent (const QPoint &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 (int x, int y)
void move (const QPoint &)
QWidgetnativeParentWidget () const const
QWidgetnextInFocusChain () const const
QRect normalGeometry () const const
void overrideWindowFlags (Qt::WindowFlags flags)
virtual QPaintEnginepaintEngine () const const override
const QPalettepalette () const const
QWidgetparentWidget () const const
QPoint pos () const const
QWidgetpreviousInFocusChain () const const
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, QWidget::RenderFlags renderFlags)
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
void repaint ()
void repaint (int x, int y, int w, int h)
void repaint (const QRect &rect)
void repaint (const QRegion &rgn)
void resize (int w, int h)
void resize (const QSize &)
bool restoreGeometry (const QByteArray &geometry)
QByteArray saveGeometry () const const
QScreenscreen () 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 (int basew, int baseh)
void setBaseSize (const QSize &)
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 (Qt::FocusReason reason)
void setFocus ()
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 (int maxw, int maxh)
void setMaximumSize (const QSize &)
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, Qt::WindowFlags f)
void setParent (QWidget *parent)
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
QStylestyle () const const
QString styleSheet () const const
bool testAttribute (Qt::WidgetAttribute attribute) const const
QString toolTip () const const
int toolTipDuration () const const
QWidgettopLevelWidget () const const
bool underMouse () const const
void ungrabGesture (Qt::GestureType gesture)
void unsetCursor ()
void unsetLayoutDirection ()
void unsetLocale ()
void update (int x, int y, int w, int h)
void update (const QRect &rect)
void update (const QRegion &rgn)
void update ()
void updateGeometry ()
bool updatesEnabled () const const
QRegion visibleRegion () const const
QString whatsThis () const const
int width () const const
QWidgetwindow () const const
QString windowFilePath () const const
Qt::WindowFlags windowFlags () const const
QWindowwindowHandle () 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)
bool blockSignals (bool block)
const QObjectListchildren () 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< QByteArraydynamicPropertyNames () const const
virtual bool eventFilter (QObject *watched, QEvent *event)
findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T > findChildren (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
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 QMetaObjectmetaObject () const const
void moveToThread (QThread *targetThread)
QString objectName () const const
void objectNameChanged (const QString &objectName)
QObjectparent () const const
QVariant property (const char *name) const const
 Q_CLASSINFO (Name, Value)
 Q_ENUM (...)
 Q_ENUM_NS (...)
 Q_ENUMS (...)
 Q_FLAG (...)
 Q_FLAG_NS (...)
 Q_FLAGS (...)
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)
qobject_cast (QObject *object)
qobject_cast (const QObject *object)
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)
QThreadthread () const const
- Public Member Functions inherited from QPaintDevice
int colorCount () const const
int depth () const const
int 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

Additional Inherited Members

- Static Public Member Functions inherited from QWidget
QWidgetcreateWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags)
QWidgetfind (WId id)
QWidgetkeyboardGrabber ()
QWidgetmouseGrabber ()
void setTabOrder (QWidget *first, QWidget *second)
- 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &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 QWidget
typedef RenderFlags
- Public Attributes inherited from QObject
typedef QObjectList
- Public Attributes inherited from QPaintDevice
- 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 (QEvent *event)
virtual bool event (QEvent *event) override
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 (QPaintDevice::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, long *result)
virtual void paintEvent (QPaintEvent *event)
virtual void resizeEvent (QResizeEvent *event)
virtual void showEvent (QShowEvent *event)
virtual void tabletEvent (QTabletEvent *event)
void updateMicroFocus ()
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
QObjectsender () const const
int senderSignalIndex () const const
virtual void timerEvent (QTimerEvent *event)

Detailed Description

Widget for configuration of KAccel and KGlobalAccel.

Configure dictionaries of key/action associations for QActions, including global shortcuts.

The class takes care of all aspects of configuration, including handling key conflicts internally. Connect to the allDefault() slot if you want to set all configurable shortcuts to their default values.

See also
Nicolas Hadacek hadac[email protected][email protected][email protected]ia.ec[email protected]p.fr
Hamish Rodda rodda[email protected]@kde[email protected].org (KDE 4 porting)
Michael Jansen [email protected][email protected]icha[email protected]el-ja[email protected]nsen[email protected].biz

Definition at line 49 of file kshortcutseditor.h.

Member Typedef Documentation

Stores a combination of ActionType values.

Definition at line 73 of file kshortcutseditor.h.

Member Enumeration Documentation

See also

Actions which are triggered by any keypress in a widget which has the action added to it.


Actions which are triggered by any keypress in a window which has the action added to it or its child widget(s)


Actions which are triggered by any keypress in the application.


Actions which are triggered by any keypress in the windowing system.


All actions.

Definition at line 58 of file kshortcutseditor.h.


Shortcuts without a modifier are not allowed, so 'A' would not be valid, whereas 'Ctrl+A' would be.

This only applies to printable characters, however. 'F1', 'Insert' etc. could still be used.


Letter shortcuts are allowed.

Definition at line 75 of file kshortcutseditor.h.

Constructor & Destructor Documentation

KShortcutsEditor::KShortcutsEditor ( KActionCollection collection,
QWidget parent,
ActionTypes  actionTypes = AllActions,
LetterShortcuts  allowLetterShortcuts = LetterShortcutsAllowed 


collectionthe KActionCollection to configure
parentparent widget
actionTypestypes of actions to display in this widget.
allowLetterShortcutsset to LetterShortcutsDisallowed if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts.

Definition at line 48 of file kshortcutseditor.cpp.

KShortcutsEditor::KShortcutsEditor ( QWidget parent,
ActionTypes  actionTypes = AllActions,
LetterShortcuts  allowLetterShortcuts = LetterShortcutsAllowed 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Creates a key chooser without a starting action collection.

parentparent widget
actionTypestypes of actions to display in this widget.
allowLetterShortcutsset to LetterShortcutsDisallowed if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts.

Definition at line 56 of file kshortcutseditor.cpp.

KShortcutsEditor::~KShortcutsEditor ( )


Member Function Documentation

ActionTypes KShortcutsEditor::actionTypes ( ) const
The types of actions currently displayed in this widget.
void KShortcutsEditor::addCollection ( KActionCollection collection,
const QString title = QString() 

Insert an action collection, i.e.

add all its actions to the ones already associated with the KShortcutsEditor object.

titlesubtree title of this collection of shortcut.

Definition at line 87 of file kshortcutseditor.cpp.

void KShortcutsEditor::allDefault ( )

Set all shortcuts to their default values (bindings).

Definition at line 252 of file kshortcutseditor.cpp.

void KShortcutsEditor::clearCollections ( )

Removes all action collections from the editor.

Definition at line 79 of file kshortcutseditor.cpp.

void KShortcutsEditor::clearConfiguration ( )

Removes all configured shortcuts.

Definition at line 149 of file kshortcutseditor.cpp.

void KShortcutsEditor::commit ( )

Commit the changes without saving.

This commits the changes without saving.


Definition at line 211 of file kshortcutseditor.cpp.

void KShortcutsEditor::exportConfiguration ( KConfigBase config) const

Export the current setting to configuration config.

This initializes the configuration object. This will export the global configuration too.

configConfig object

Definition at line 173 of file kshortcutseditor.cpp.

void KShortcutsEditor::importConfiguration ( KConfigBase config)

Import the settings from configuration config.

This will remove all current setting before importing. All shortcuts are set to QList<QKeySequence>() prior to importing from config!

configConfig object

Definition at line 161 of file kshortcutseditor.cpp.

bool KShortcutsEditor::isModified ( ) const

Are the unsaved changes?

Definition at line 65 of file kshortcutseditor.cpp.

void KShortcutsEditor::keyChange ( )

Emitted when an action's shortcut has been changed.

void KShortcutsEditor::printShortcuts ( ) const

Opens a printing dialog to print all the shortcuts.

Definition at line 257 of file kshortcutseditor.cpp.

void KShortcutsEditor::resizeColumns ( )

Resize columns to width required.

Definition at line 204 of file kshortcutseditor.cpp.

void KShortcutsEditor::save ( )

Save the changes.

Before saving the changes are committed. This saves the actions to disk. Any KActionCollection objects with the xmlFile() value set will be written to an XML file. All other will be written to the application's rc file.

Definition at line 220 of file kshortcutseditor.cpp.

void KShortcutsEditor::setActionTypes ( ActionTypes  actionTypes)

Sets the types of actions to display in this widget.

actionTypesNew types of actions

Definition at line 267 of file kshortcutseditor.cpp.

void KShortcutsEditor::undo ( )

Undo all change made since the last commit().


Definition at line 237 of file kshortcutseditor.cpp.

void KShortcutsEditor::undoChanges ( )

Undo all change made since the last commit().

Since 5.75, use undo()

Definition at line 231 of file kshortcutseditor.cpp.

void KShortcutsEditor::writeConfiguration ( KConfigGroup config = nullptr) const

Write the current settings to the config object.

This does not initialize the config object. It adds the configuration.

This will not save the global configuration! globalaccel holds that part of the configuration.
See also
configConfig object to save to or, or null to use the applications config object

Definition at line 196 of file kshortcutseditor.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Tue Nov 30 2021 22:46:21 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.