GlobalShortcutsRegistry

Search for usage in LXR

#include <globalshortcutsregistry.h>

Inheritance diagram for GlobalShortcutsRegistry:

Public Slots

void clear ()
 
void grabKeys ()
 
void loadSettings ()
 
void ungrabKeys ()
 
void writeSettings () const
 

Public Member Functions

 GlobalShortcutsRegistry ()
 
void activateShortcuts ()
 
const std::vector< KdeDGlobalAccel::Component * > & allMainComponents () const
 
QDBusObjectPath dbusPath () const
 
void deactivateShortcuts (bool temporarily=false)
 
KdeDGlobalAccel::ComponentgetComponent (const QString &uniqueName)
 
GlobalShortcutgetShortcutByKey (const QKeySequence &key, KGlobalAccel::MatchType type=KGlobalAccel::MatchType::Equal) const
 
QList< GlobalShortcut * > getShortcutsByKey (const QKeySequence &key, KGlobalAccel::MatchType type) const
 
bool isShortcutAvailable (const QKeySequence &shortcut, const QString &component, const QString &context) const
 
bool registerKey (const QKeySequence &key, GlobalShortcut *shortcut)
 
void setAccelManager (KGlobalAccelInterface *manager)
 
void setDBusPath (const QDBusObjectPath &path)
 
bool unregisterKey (const QKeySequence &key, GlobalShortcut *shortcut)
 
- 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 event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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 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_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
 
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 (const QObject *object)
 
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)
 
QThreadthread () const const
 

Static Public Member Functions

static GlobalShortcutsRegistryself ()
 
- 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)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Global Shortcut Registry.

Shortcuts are registered by component. A component is for example kmail or amarok.

A component can have contexts. Currently on plasma is planned to support that feature. A context enables plasma to keep track of global shortcut settings when switching containments.

A shortcut (WIN+x) can be registered by one component only. The component is allowed to register it more than once in different contexts.

Author
Michael Jansen [email protected][email protected]icha[email protected]el-ja[email protected]nsen[email protected].biz

Definition at line 42 of file globalshortcutsregistry.h.

Constructor & Destructor Documentation

◆ GlobalShortcutsRegistry()

GlobalShortcutsRegistry::GlobalShortcutsRegistry ( )

Use GlobalShortcutsRegistry::self()

Definition at line 75 of file globalshortcutsregistry.cpp.

Member Function Documentation

◆ activateShortcuts()

void GlobalShortcutsRegistry::activateShortcuts ( )

Activate all shortcuts having their application present.

Definition at line 129 of file globalshortcutsregistry.cpp.

◆ allMainComponents()

const std::vector< KdeDGlobalAccel::Component * > & GlobalShortcutsRegistry::allMainComponents ( ) const

Return a list of all main components.

Definition at line 136 of file globalshortcutsregistry.cpp.

◆ dbusPath()

QDBusObjectPath GlobalShortcutsRegistry::dbusPath ( ) const

Return the root dbus path for the registry.

Definition at line 150 of file globalshortcutsregistry.cpp.

◆ deactivateShortcuts()

void GlobalShortcutsRegistry::deactivateShortcuts ( bool  temporarily = false)

Deactivate all currently active shortcuts.

Definition at line 155 of file globalshortcutsregistry.cpp.

◆ getShortcutByKey()

GlobalShortcut * GlobalShortcutsRegistry::getShortcutByKey ( const QKeySequence key,
KGlobalAccel::MatchType  type = KGlobalAccel::MatchType::Equal 
) const

Get the shortcut corresponding to key.

Active and inactive shortcuts are considered. But if the matching application uses contexts only one shortcut is returned.

See also
getShortcutsByKey(int key)

Definition at line 168 of file globalshortcutsregistry.cpp.

◆ getShortcutsByKey()

QList< GlobalShortcut * > GlobalShortcutsRegistry::getShortcutsByKey ( const QKeySequence key,
KGlobalAccel::MatchType  type 
) const

Get the shortcuts corresponding to key.

Active and inactive shortcuts are considered.

See also
getShortcutsByKey(int key)

Definition at line 179 of file globalshortcutsregistry.cpp.

◆ isShortcutAvailable()

bool GlobalShortcutsRegistry::isShortcutAvailable ( const QKeySequence shortcut,
const QString component,
const QString context 
) const

Checks if shortcut is available for component.

It is available if not used by another component in any context or used by component only in not active contexts.

Definition at line 191 of file globalshortcutsregistry.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Wed Aug 10 2022 03:56:08 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.