QGIS API Documentation  3.18.1-Zürich (202f1bf7e5)
Public Member Functions | List of all members
QgsShortcutsManager Class Reference

Shortcuts manager is a class that contains a list of QActions and QShortcuts that have been registered and their shortcuts can be changed. More...

#include <qgsshortcutsmanager.h>

Inheritance diagram for QgsShortcutsManager:
Inheritance graph
[legend]

Public Member Functions

 QgsShortcutsManager (QObject *parent=nullptr, const QString &settingsRoot="/shortcuts/")
 Constructor for QgsShortcutsManager. More...
 
QAction * actionByName (const QString &name) const
 Returns an action by its name, or nullptr if nothing found. More...
 
QAction * actionForSequence (const QKeySequence &sequence) const
 Returns the action which is associated for a shortcut sequence, or nullptr if no action is associated. More...
 
QString defaultKeySequence (QAction *action) const
 Returns the default sequence for an action. More...
 
QString defaultKeySequence (QShortcut *shortcut) const
 Returns the default sequence for a shortcut. More...
 
QList< QAction * > listActions () const
 Returns a list of all actions in the manager. More...
 
QList< QObject * > listAll () const
 Returns a list of both actions and shortcuts in the manager. More...
 
QList< QShortcut * > listShortcuts () const
 Returns a list of shortcuts in the manager. More...
 
QString objectDefaultKeySequence (QObject *object) const
 Returns the default sequence for an object (either a QAction or QShortcut). More...
 
QObject * objectForSequence (const QKeySequence &sequence) const
 Returns the object (QAction or QShortcut) matching the specified key sequence,. More...
 
bool registerAction (QAction *action, const QString &defaultShortcut=QString())
 Registers an action with the manager so the shortcut can be configured in GUI. More...
 
void registerAllChildActions (QObject *object, bool recursive=false)
 Automatically registers all QActions which are children of the passed object. More...
 
void registerAllChildren (QObject *object, bool recursive=false)
 Automatically registers all QActions and QShortcuts which are children of the passed object. More...
 
void registerAllChildShortcuts (QObject *object, bool recursive=false)
 Automatically registers all QShortcuts which are children of the passed object. More...
 
bool registerShortcut (QShortcut *shortcut, const QString &defaultSequence=QString())
 Registers a QShortcut with the manager so the shortcut can be configured in GUI. More...
 
bool setKeySequence (const QString &name, const QString &sequence)
 Modifies an action or shortcut's key sequence. More...
 
bool setKeySequence (QAction *action, const QString &sequence)
 Modifies an action's key sequence. More...
 
bool setKeySequence (QShortcut *shortcut, const QString &sequence)
 Modifies a shortcuts's key sequence. More...
 
bool setObjectKeySequence (QObject *object, const QString &sequence)
 Modifies an object's (either a QAction or a QShortcut) key sequence. More...
 
QString settingsPath () const
 Returns the root settings path used to store shortcut customization. More...
 
QShortcut * shortcutByName (const QString &name) const
 Returns a shortcut by its name, or nullptr if nothing found. More...
 
QShortcut * shortcutForSequence (const QKeySequence &sequence) const
 Returns the shortcut which is associated for a key sequence, or nullptr if no shortcut is associated. More...
 
bool unregisterAction (QAction *action)
 Removes an action from the manager. More...
 
bool unregisterShortcut (QShortcut *shortcut)
 Removes a shortcut from the manager. More...
 

Detailed Description

Shortcuts manager is a class that contains a list of QActions and QShortcuts that have been registered and their shortcuts can be changed.

QgsShortcutsManager is not usually directly created, but rather accessed through QgsGui::shortcutsManager().

Since
QGIS 2.16

Definition at line 37 of file qgsshortcutsmanager.h.

Constructor & Destructor Documentation

◆ QgsShortcutsManager()

QgsShortcutsManager::QgsShortcutsManager ( QObject *  parent = nullptr,
const QString &  settingsRoot = "/shortcuts/" 
)

Constructor for QgsShortcutsManager.

Parameters
parentparent object
settingsRootroot QgsSettings path for storing settings, e.g., "/myplugin/shortcuts". Leave as the default value to store settings alongside built in QGIS shortcuts, but care must be taken to not register actions which conflict with the built in QGIS actions.

Definition at line 22 of file qgsshortcutsmanager.cpp.

Member Function Documentation

◆ actionByName()

QAction * QgsShortcutsManager::actionByName ( const QString &  name) const

Returns an action by its name, or nullptr if nothing found.

Parameters
nameaction name. Must match QAction's text.
See also
shortcutByName()

Definition at line 291 of file qgsshortcutsmanager.cpp.

◆ actionForSequence()

QAction * QgsShortcutsManager::actionForSequence ( const QKeySequence &  sequence) const

Returns the action which is associated for a shortcut sequence, or nullptr if no action is associated.

Parameters
sequenceshortcut key sequence
See also
objectForSequence()
shortcutForSequence()

Definition at line 263 of file qgsshortcutsmanager.cpp.

◆ defaultKeySequence() [1/2]

QString QgsShortcutsManager::defaultKeySequence ( QAction *  action) const

Returns the default sequence for an action.

An empty return string indicates no default sequence.

Parameters
actionaction to return default key sequence for
See also
objectDefaultKeySequence()

Definition at line 197 of file qgsshortcutsmanager.cpp.

◆ defaultKeySequence() [2/2]

QString QgsShortcutsManager::defaultKeySequence ( QShortcut *  shortcut) const

Returns the default sequence for a shortcut.

An empty return string indicates no default sequence.

Parameters
shortcutshortcut to return default key sequence for
See also
objectDefaultKeySequence()

Definition at line 202 of file qgsshortcutsmanager.cpp.

◆ listActions()

QList< QAction * > QgsShortcutsManager::listActions ( ) const

Returns a list of all actions in the manager.

See also
listShortcuts()
listAll()

Definition at line 161 of file qgsshortcutsmanager.cpp.

◆ listAll()

QList< QObject * > QgsShortcutsManager::listAll ( ) const

Returns a list of both actions and shortcuts in the manager.

See also
listActions()
listShortcuts()

Definition at line 171 of file qgsshortcutsmanager.cpp.

◆ listShortcuts()

QList< QShortcut * > QgsShortcutsManager::listShortcuts ( ) const

Returns a list of shortcuts in the manager.

See also
listActions()
listAll()

Definition at line 166 of file qgsshortcutsmanager.cpp.

◆ objectDefaultKeySequence()

QString QgsShortcutsManager::objectDefaultKeySequence ( QObject *  object) const

Returns the default sequence for an object (either a QAction or QShortcut).

An empty return string indicates no shortcut.

Parameters
objectQAction or QShortcut to return default key sequence for
See also
defaultKeySequence()

Definition at line 187 of file qgsshortcutsmanager.cpp.

◆ objectForSequence()

QObject * QgsShortcutsManager::objectForSequence ( const QKeySequence &  sequence) const

Returns the object (QAction or QShortcut) matching the specified key sequence,.

Parameters
sequencekey sequence to find
Returns
object with matching sequence, or nullptr if not found
See also
actionForSequence()
shortcutForSequence()

Definition at line 253 of file qgsshortcutsmanager.cpp.

◆ registerAction()

bool QgsShortcutsManager::registerAction ( QAction *  action,
const QString &  defaultShortcut = QString() 
)

Registers an action with the manager so the shortcut can be configured in GUI.

Parameters
actionaction to register. The action must have a unique text string for identification.
defaultShortcutdefault key sequence for action
Returns
true if action was successfully registered
See also
registerShortcut()
unregisterAction()
registerAllChildActions()

Definition at line 82 of file qgsshortcutsmanager.cpp.

◆ registerAllChildActions()

void QgsShortcutsManager::registerAllChildActions ( QObject *  object,
bool  recursive = false 
)

Automatically registers all QActions which are children of the passed object.

Parameters
objectparent object containing actions to register
recursiveset to true to recursively add child actions
See also
registerAction()
registerAllChildren()
registerAllChildShortcuts()

Definition at line 34 of file qgsshortcutsmanager.cpp.

◆ registerAllChildren()

void QgsShortcutsManager::registerAllChildren ( QObject *  object,
bool  recursive = false 
)

Automatically registers all QActions and QShortcuts which are children of the passed object.

Parameters
objectparent object containing actions and shortcuts to register
recursiveset to true to recursively add child actions and shortcuts
See also
registerAllChildActions()
registerAllChildShortcuts()

Definition at line 28 of file qgsshortcutsmanager.cpp.

◆ registerAllChildShortcuts()

void QgsShortcutsManager::registerAllChildShortcuts ( QObject *  object,
bool  recursive = false 
)

Automatically registers all QShortcuts which are children of the passed object.

Parameters
objectparent object containing shortcuts to register
recursiveset to true to recursively add child shortcuts
See also
registerShortcut()
registerAllChildren()
registerAllChildActions()

Definition at line 58 of file qgsshortcutsmanager.cpp.

◆ registerShortcut()

bool QgsShortcutsManager::registerShortcut ( QShortcut *  shortcut,
const QString &  defaultSequence = QString() 
)

Registers a QShortcut with the manager so the shortcut can be configured in GUI.

Parameters
shortcutQShortcut to register. The shortcut must have a unique QObject::objectName() for identification.
defaultSequencedefault key sequence for shortcut
Returns
true if shortcut was successfully registered
See also
registerAction()
registerAllChildShortcuts()

Definition at line 121 of file qgsshortcutsmanager.cpp.

◆ setKeySequence() [1/3]

bool QgsShortcutsManager::setKeySequence ( const QString &  name,
const QString &  sequence 
)

Modifies an action or shortcut's key sequence.

Parameters
namename of action or shortcut to modify. Must match the action's QAction::text() or the shortcut's QObject::objectName()
sequencenew shortcut key sequence
See also
setObjectKeySequence()

Definition at line 207 of file qgsshortcutsmanager.cpp.

◆ setKeySequence() [2/3]

bool QgsShortcutsManager::setKeySequence ( QAction *  action,
const QString &  sequence 
)

Modifies an action's key sequence.

Parameters
actionaction to modify
sequencenew shortcut key sequence
See also
setObjectKeySequence()

Definition at line 227 of file qgsshortcutsmanager.cpp.

◆ setKeySequence() [3/3]

bool QgsShortcutsManager::setKeySequence ( QShortcut *  shortcut,
const QString &  sequence 
)

Modifies a shortcuts's key sequence.

Parameters
shortcutQShortcut to modify
sequencenew shortcut key sequence
See also
setObjectKeySequence()

Definition at line 241 of file qgsshortcutsmanager.cpp.

◆ setObjectKeySequence()

bool QgsShortcutsManager::setObjectKeySequence ( QObject *  object,
const QString &  sequence 
)

Modifies an object's (either a QAction or a QShortcut) key sequence.

Parameters
objectQAction or QShortcut to modify
sequencenew shortcut key sequence
See also
setKeySequence()

Definition at line 217 of file qgsshortcutsmanager.cpp.

◆ settingsPath()

QString QgsShortcutsManager::settingsPath ( ) const
inline

Returns the root settings path used to store shortcut customization.

Definition at line 243 of file qgsshortcutsmanager.h.

◆ shortcutByName()

QShortcut * QgsShortcutsManager::shortcutByName ( const QString &  name) const

Returns a shortcut by its name, or nullptr if nothing found.

Parameters
nameshortcut name. Must match QShortcut's QObject::objectName() property.
See also
actionByName()

Definition at line 302 of file qgsshortcutsmanager.cpp.

◆ shortcutForSequence()

QShortcut * QgsShortcutsManager::shortcutForSequence ( const QKeySequence &  sequence) const

Returns the shortcut which is associated for a key sequence, or nullptr if no shortcut is associated.

Parameters
sequenceshortcut key sequence
See also
objectForSequence()
actionForSequence()

Definition at line 277 of file qgsshortcutsmanager.cpp.

◆ unregisterAction()

bool QgsShortcutsManager::unregisterAction ( QAction *  action)

Removes an action from the manager.

Parameters
actionaction to remove
Returns
true if action was previously registered in manager and has been removed, or false if action was not previously registered in manager
See also
registerAction()
unregisterShortcut()

Definition at line 143 of file qgsshortcutsmanager.cpp.

◆ unregisterShortcut()

bool QgsShortcutsManager::unregisterShortcut ( QShortcut *  shortcut)

Removes a shortcut from the manager.

Parameters
shortcutshortcut to remove
Returns
true if shortcut was previously registered in manager and has been removed, or false if shortcut was not previously registered in manager
See also
registerShortcut()
unregisterAction()

Definition at line 152 of file qgsshortcutsmanager.cpp.


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