LeechCraft  %{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
shortcutmanager.h
Go to the documentation of this file.
1 /**********************************************************************
2  * LeechCraft - modular cross-platform feature rich internet client.
3  * Copyright (C) 2006-2013 Georg Rudoy
4  *
5  * Boost Software License - Version 1.0 - August 17th, 2003
6  *
7  * Permission is hereby granted, free of charge, to any person or organization
8  * obtaining a copy of the software and accompanying documentation covered by
9  * this license (the "Software") to use, reproduce, display, distribute,
10  * execute, and transmit the Software, and to prepare derivative works of the
11  * Software, and to permit third-parties to whom the Software is furnished to
12  * do so, all subject to the following:
13  *
14  * The copyright notices in the Software and this entire statement, including
15  * the above license grant, this restriction and the following disclaimer,
16  * must be included in all copies of the Software, in whole or in part, and
17  * all derivative works of the Software, unless such copies or derivative
18  * works are solely in the form of machine-executable object code generated by
19  * a source language processor.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
24  * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
25  * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
26  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  **********************************************************************/
29 
30 #pragma once
31 
32 #include <QObject>
33 #include <QHash>
34 #include <util/utilconfig.h>
37 
38 class QAction;
39 class QShortcut;
40 class IShortcutProxy;
41 
42 namespace LeechCraft
43 {
44 namespace Util
45 {
67  class ShortcutManager : public QObject
68  {
69  Q_OBJECT
70 
71  ICoreProxy_ptr CoreProxy_;
72  QObject *ContextObj_;
73 
74  QHash<QString, QList<QAction*>> Actions_;
75  QHash<QString, QList<QShortcut*>> Shortcuts_;
76 
77  QMap<QString, ActionInfo> ActionInfo_;
78  public:
85  UTIL_API ShortcutManager (ICoreProxy_ptr proxy, QObject *parent = 0);
86 
94  UTIL_API void SetObject (QObject *pluginObj);
95 
122  UTIL_API void RegisterAction (const QString& id, QAction *action, bool update = false);
123 
146  UTIL_API void RegisterShortcut (const QString& id,
147  const ActionInfo& info, QShortcut *shortcut, bool update = false);
148 
163  UTIL_API void RegisterActionInfo (const QString& id, const ActionInfo& info);
164 
175  UTIL_API void SetShortcut (const QString& id, const QKeySequences_t& sequences) const;
176 
184  UTIL_API QMap<QString, ActionInfo> GetActionInfo () const;
185 
186  typedef QPair<QString, QAction*> IDPair_t;
195  UTIL_API ShortcutManager& operator<< (const QPair<QString, QAction*>& pair);
196  private slots:
197  void handleActionDestroyed ();
198  void handleShortcutDestroyed ();
199  };
200 }
201 }
UTIL_API QMap< QString, ActionInfo > GetActionInfo() const
Returns the map with information about actions.
UTIL_API ShortcutManager(ICoreProxy_ptr proxy, QObject *parent=0)
Creates the shortcut manager.
UTIL_API void SetObject(QObject *pluginObj)
Sets the plugin instance object of this manager.
std::shared_ptr< ICoreProxy > ICoreProxy_ptr
Definition: icoreproxy.h:192
QList< QKeySequence > QKeySequences_t
UTIL_API void SetShortcut(const QString &id, const QKeySequences_t &sequences) const
Sets the key sequence for the given action.
#define UTIL_API
Definition: utilconfig.h:37
UTIL_API void RegisterAction(const QString &id, QAction *action, bool update=false)
Registers the given QAction by the given id.
Describes an action exposed in shortcut manager.
QPair< QString, QAction * > IDPair_t
Aids in providing configurable shortcuts.
Proxy for requesting shortcuts from the shortcut manager in the Core.
UTIL_API void RegisterShortcut(const QString &id, const ActionInfo &info, QShortcut *shortcut, bool update=false)
Registers the given QShortcut with the given id.
UTIL_API void RegisterActionInfo(const QString &id, const ActionInfo &info)
Registers the given action info with the given id.