Component
#include <component.h>

Properties | |
QString | friendlyName |
QString | uniqueName |
![]() | |
objectName | |
Signals | |
Q_SCRIPTABLE void | globalShortcutPressed (const QString &componentUnique, const QString &shortcutUnique, qlonglong timestamp) |
Q_SCRIPTABLE void | globalShortcutReleased (const QString &componentUnique, const QString &shortcutUnique, qlonglong timestamp) |
Public Slots | |
Q_SCRIPTABLE QList< KGlobalShortcutInfo > | allShortcutInfos (const QString &context=QStringLiteral("default")) const |
virtual Q_SCRIPTABLE bool | cleanUp () |
virtual void | emitGlobalShortcutPressed (const GlobalShortcut &shortcut) |
virtual void | emitGlobalShortcutReleased (const GlobalShortcut &shortcut) |
Q_SCRIPTABLE QStringList | getShortcutContexts () const |
Q_SCRIPTABLE void | invokeShortcut (const QString &shortcutName, const QString &context=QStringLiteral("default")) |
Q_SCRIPTABLE bool | isActive () const |
Q_SCRIPTABLE QStringList | shortcutNames (const QString &context=QStringLiteral("default")) const |
Public Member Functions | |
bool | activateGlobalShortcutContext (const QString &uniqueName) |
void | activateShortcuts () |
QList< GlobalShortcut * > | allShortcuts (const QString &context=QStringLiteral("default")) const |
bool | createGlobalShortcutContext (const QString &context, const QString &friendlyName=QString()) |
GlobalShortcutContext * | currentContext () |
QDBusObjectPath | dbusPath () const |
void | deactivateShortcuts (bool temporarily=false) |
QString | friendlyName () const |
GlobalShortcut * | getShortcutByKey (const QKeySequence &key, KGlobalAccel::MatchType type) const |
GlobalShortcut * | getShortcutByName (const QString &uniqueName, const QString &context=QStringLiteral("default")) const |
QList< GlobalShortcut * > | getShortcutsByKey (const QKeySequence &key, KGlobalAccel::MatchType type) const |
bool | isShortcutAvailable (const QKeySequence &key, const QString &component, const QString &context) const |
void | loadSettings (KConfigGroup &config) |
void | setFriendlyName (const QString &) |
GlobalShortcutContext * | shortcutContext (const QString &name) |
const GlobalShortcutContext * | shortcutContext (const QString &name) const |
QString | uniqueName () const |
void | unregisterShortcut (const QString &uniqueName) |
void | writeSettings (KConfigGroup &config) const |
![]() | |
QObject (QObject *parent) | |
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 () |
void | dumpObjectInfo () const const |
void | dumpObjectTree () |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegExp ®Exp, 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 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_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 | |
T | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
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 | 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) |
QThread * | thread () const const |
Protected Member Functions | |
Component (const QString &uniqueName, const QString &friendlyName) | |
GlobalShortcut * | registerShortcut (const QString &uniqueName, const QString &friendlyName, const QString &shortcutString, const QString &defaultShortcutString) |
![]() | |
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) |
Additional Inherited Members | |
![]() | |
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) |
![]() | |
typedef | QObjectList |
Detailed Description
Definition at line 26 of file component.h.
Constructor & Destructor Documentation
◆ Component()
Constructs a component.
This is a private constructor, to create a component use GlobalShortcutsRegistry::self()->createComponent().
Definition at line 56 of file component.cpp.
Member Function Documentation
◆ allShortcutInfos
|
slot |
Returns all shortcut in context.
Definition at line 104 of file component.cpp.
◆ allShortcuts()
QList< GlobalShortcut * > Component::allShortcuts | ( | const QString & | context = QStringLiteral("default") | ) | const |
Returns all shortcuts in context @context.
Definition at line 98 of file component.cpp.
◆ cleanUp
|
virtualslot |
Remove all currently not used global shortcuts registrations for this component and if nothing is left the component too.
If the method returns true consider all information previously acquired from this component as void.
The method will cleanup in all contexts.
- Returns
true
if a change was made,false
if not.
Reimplemented in KServiceActionComponent.
Definition at line 110 of file component.cpp.
◆ createGlobalShortcutContext()
bool Component::createGlobalShortcutContext | ( | const QString & | context, |
const QString & | friendlyName = QString() |
||
) |
Creates the new global shortcut context context
.
Definition at line 131 of file component.cpp.
◆ currentContext()
GlobalShortcutContext * Component::currentContext | ( | ) |
Return the current context.
Definition at line 141 of file component.cpp.
◆ dbusPath()
QDBusObjectPath Component::dbusPath | ( | ) | const |
Return uniqueName converted to a valid dbus path.
Definition at line 146 of file component.cpp.
◆ deactivateShortcuts()
void Component::deactivateShortcuts | ( | bool | temporarily = false | ) |
Deactivate all currently active shortcuts.
Definition at line 166 of file component.cpp.
◆ friendlyName()
QString Component::friendlyName | ( | ) | const |
Returns the friendly name.
◆ getShortcutByKey()
GlobalShortcut * Component::getShortcutByKey | ( | const QKeySequence & | key, |
KGlobalAccel::MatchType | type | ||
) | const |
Returns the currently active shortcut for key.
Definition at line 237 of file component.cpp.
◆ getShortcutByName()
GlobalShortcut * Component::getShortcutByName | ( | const QString & | uniqueName, |
const QString & | context = QStringLiteral("default") |
||
) | const |
Returns the shortcut by unique name.
Only the active context is searched.
Definition at line 254 of file component.cpp.
◆ getShortcutContexts
|
slot |
Returns the shortcut contexts available for the component.
Definition at line 260 of file component.cpp.
◆ getShortcutsByKey()
QList< GlobalShortcut * > Component::getShortcutsByKey | ( | const QKeySequence & | key, |
KGlobalAccel::MatchType | type | ||
) | const |
Returns the list of shortcuts (different context) registered with key
.
Definition at line 242 of file component.cpp.
◆ globalShortcutPressed
|
signal |
Signals that a action for this component was triggered.
◆ globalShortcutReleased
|
signal |
Signals that a action for this component is not triggered anymore.
◆ isActive
|
slot |
Check if the component is currently active.
A component is active if at least one of it's global shortcuts is currently present.
Definition at line 265 of file component.cpp.
◆ isShortcutAvailable()
bool Component::isShortcutAvailable | ( | const QKeySequence & | key, |
const QString & | component, | ||
const QString & | context | ||
) | const |
Check if key is available for component component
.
Definition at line 277 of file component.cpp.
◆ loadSettings()
void Component::loadSettings | ( | KConfigGroup & | config | ) |
Load the settings from config group config
.
Definition at line 320 of file component.cpp.
◆ registerShortcut()
|
protected |
Create a new globalShortcut by its name.
- Parameters
-
uniqueName internal unique name to identify the shortcut friendlyName name for the shortcut to be presented to the user shortcutString string representation of the shortcut, such as "CTRL+S" defaultShortcutString string representation of the default shortcut, such as "CTRL+S", when the user choses to reset to default the keyboard shortcut will return to this one.
Definition at line 297 of file component.cpp.
◆ setFriendlyName()
void Component::setFriendlyName | ( | const QString & | name | ) |
Sets the human readable name for this component.
Definition at line 337 of file component.cpp.
◆ shortcutContext()
GlobalShortcutContext * Component::shortcutContext | ( | const QString & | name | ) |
Returns the shortcut context name
or nullptr.
Definition at line 342 of file component.cpp.
◆ shortcutNames
|
slot |
Get all shortcutnames living in context.
Definition at line 352 of file component.cpp.
◆ unregisterShortcut()
void Component::unregisterShortcut | ( | const QString & | uniqueName | ) |
Unregister shortcut. This will remove its siblings from all contexts.
Definition at line 363 of file component.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sun Feb 5 2023 03:55:51 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.