![]() |
LeechCraft
%{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
|
Aids in providing configurable shortcuts. More...
#include "shortcutmanager.h"
Public Types | |
typedef QPair< QString, QAction * > | IDPair_t |
Public Member Functions | |
UTIL_API | ShortcutManager (ICoreProxy_ptr proxy, QObject *parent=0) |
Creates the shortcut manager. More... | |
UTIL_API void | SetObject (QObject *pluginObj) |
Sets the plugin instance object of this manager. More... | |
UTIL_API void | RegisterAction (const QString &id, QAction *action, bool update=false) |
Registers the given QAction by the given id. More... | |
UTIL_API void | RegisterShortcut (const QString &id, const ActionInfo &info, QShortcut *shortcut, bool update=false) |
Registers the given QShortcut with the given id. More... | |
UTIL_API void | RegisterActionInfo (const QString &id, const ActionInfo &info) |
Registers the given action info with the given id. More... | |
UTIL_API void | SetShortcut (const QString &id, const QKeySequences_t &sequences) const |
Sets the key sequence for the given action. More... | |
UTIL_API QMap< QString, ActionInfo > | GetActionInfo () const |
Returns the map with information about actions. More... | |
UTIL_API ShortcutManager & | operator<< (const QPair< QString, QAction * > &pair) |
Utility function equivalent to RegisterAction(). More... | |
Aids in providing configurable shortcuts.
This class serves as a "collector" for different QActions and QShortcuts. One typically instantiates an object of this class as a per-plugin global object (via a singleton, for example), registers all required actions via the RegisterShortcut(), RegisterAction() and RegisterActionInfo() functions and relays calls to the IHaveShortcuts::SetShortcut() and IHaveShortcuts::GetActionInfo() functions to this class.
Though one can register actions at arbitrary points of time, only those "kinds" of actions registered during the IInfo::Init() will be visible to the LeechCraft core. Actions added later will still have customized shortcuts (if any), but only if another action with the same ID has been added during IInfo::Init().
See the documentation for IHaveShortcuts for more information about actions and their IDs.
Definition at line 67 of file shortcutmanager.h.
typedef QPair<QString, QAction*> LeechCraft::Util::ShortcutManager::IDPair_t |
Definition at line 186 of file shortcutmanager.h.
LeechCraft::Util::ShortcutManager::ShortcutManager | ( | ICoreProxy_ptr | proxy, |
QObject * | parent = 0 |
||
) |
Creates the shortcut manager.
[in] | proxy | The proxy object passed to IInfo::Init() of your plugin. |
[in] | parent | The parent object of this object. |
Definition at line 39 of file shortcutmanager.cpp.
QMap< QString, ActionInfo > LeechCraft::Util::ShortcutManager::GetActionInfo | ( | ) | const |
Returns the map with information about actions.
The return result is suitable to be returned from IHaveShortcuts::GetActionInfo().
Definition at line 100 of file shortcutmanager.cpp.
ShortcutManager & LeechCraft::Util::ShortcutManager::operator<< | ( | const QPair< QString, QAction * > & | pair | ) |
Utility function equivalent to RegisterAction().
This function is equivalent to calling RegisterAction (pair.first, pair.second);
.
[in] | pair | The pair of action ID and the action itself. |
Definition at line 105 of file shortcutmanager.cpp.
void LeechCraft::Util::ShortcutManager::RegisterAction | ( | const QString & | id, |
QAction * | action, | ||
bool | update = false |
||
) |
Registers the given QAction by the given id.
This function registers the given action at the given id and updates it if necessary. The ActionInfo structure is created automatically, and ActionIcon property of the action is used to fetch its icon.
If update is set to true, the shortcut manager will request an actual and up-to-date shortcut from the LeechCraft core. There is no need to update an action registered during IInfo::Init() as the Core will update actions with custom shortcuts later on anyway.
[in] | id | The ID of action to register. |
[in] | action | The action to register. |
[in] | update | Whether action shortcut should be updated immediately. |
Definition at line 51 of file shortcutmanager.cpp.
References RegisterActionInfo(), and SetShortcut().
void LeechCraft::Util::ShortcutManager::RegisterActionInfo | ( | const QString & | id, |
const ActionInfo & | info | ||
) |
Registers the given action info with the given id.
This function can be used to register an action info with the given ID before any actions or shortcuts with this ID are really created. This function can be used, for example, to register shortcuts that will be available during some time after IInfo::Init(), like a reload action in a web page (as there are no web pages during plugin initialization).
[in] | id | The ID of an action or QShortcut to register. |
[in] | info | The ActionInfo about this shortcut. |
Definition at line 85 of file shortcutmanager.cpp.
Referenced by RegisterAction(), and RegisterShortcut().
void LeechCraft::Util::ShortcutManager::RegisterShortcut | ( | const QString & | id, |
const ActionInfo & | info, | ||
QShortcut * | shortcut, | ||
bool | update = false |
||
) |
Registers the given QShortcut with the given id.
If update is set to true, the shortcut manager will request an actual and up-to-date shortcut from the LeechCraft core. There is no need to update an action registered during IInfo::Init() as the Core will update actions with custom shortcuts later on anyway.
[in] | id | The ID of QShortcut to register. |
[in] | info | The additional ActionInfo about this shortcut. |
[in] | shortcut | The QShortcut to register. |
[in] | update | Whether action shortcut should be updated immediately. |
Definition at line 70 of file shortcutmanager.cpp.
References RegisterActionInfo(), and SetShortcut().
void LeechCraft::Util::ShortcutManager::SetObject | ( | QObject * | pluginObj | ) |
Sets the plugin instance object of this manager.
The plugin instance object serves as a kind of "context" for the shortcut manager.
[in] | pluginObj | The plugin instance object. |
Definition at line 46 of file shortcutmanager.cpp.
void LeechCraft::Util::ShortcutManager::SetShortcut | ( | const QString & | id, |
const QKeySequences_t & | sequences | ||
) | const |
Sets the key sequence for the given action.
This function updates all the registered actions with the given ID. It is intended to be called only from IHaveShortcuts::SetShortcut(), user code should hardly ever need to call it elsewhere.
[in] | id | The ID of the action to update. |
[in] | sequences | The list of sequences to for the action. |
Definition at line 91 of file shortcutmanager.cpp.
Referenced by RegisterAction(), and RegisterShortcut().