LeechCraft  0.6.70-13729-g7046a9d2a7
Modular cross-platform feature rich live environment.
shortcutmanager.h
Go to the documentation of this file.
1 /**********************************************************************
2  * LeechCraft - modular cross-platform feature rich internet client.
3  * Copyright (C) 2006-2014 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 "shortcutsconfig.h"
37 #include "interfaces/structures.h"
38 
39 class QAction;
40 class QShortcut;
41 class IShortcutProxy;
42 
43 namespace LC
44 {
45 struct Entity;
46 
47 namespace Util
48 {
75  class UTIL_SHORTCUTS_API ShortcutManager : public QObject
76  {
77  Q_OBJECT
78 
79  ICoreProxy_ptr CoreProxy_;
80  QObject *ContextObj_ = nullptr;
81 
82  QHash<QString, QList<QAction*>> Actions_;
83 
84  QHash<QString, QList<QShortcut*>> Shortcuts_;
85  QHash<QShortcut*, QList<QShortcut*>> Shortcut2Subs_;
86 
87  QHash<QString, Entity> Globals_;
88 
89  QMap<QString, ActionInfo> ActionInfo_;
90  public:
97  ShortcutManager (ICoreProxy_ptr proxy, QObject *parent = nullptr);
98 
106  void SetObject (QObject *pluginObj);
107 
120  void RegisterAction (const QString& id, QAction *action);
121 
122  using IDPair_t = QPair<QString, QAction*>;
123 
124  void RegisterActions (const std::initializer_list<IDPair_t>& actions);
125 
134  void RegisterShortcut (const QString& id,
135  const ActionInfo& info, QShortcut *shortcut);
136 
151  void RegisterActionInfo (const QString& id, const ActionInfo& info);
152 
168  void RegisterGlobalShortcut (const QString& id,
169  QObject *target, const QByteArray& method,
170  const ActionInfo& info);
171 
181  void AnnounceGlobalShorcuts ();
182 
193  void SetShortcut (const QString& id, const QKeySequences_t& sequences);
194 
202  QMap<QString, ActionInfo> GetActionInfo () const;
203 
212  ShortcutManager& operator<< (const QPair<QString, QAction*>& pair);
213  private:
214  bool HasActionInfo (const QString&) const;
215  private slots:
216  void handleActionDestroyed ();
217  void handleShortcutDestroyed ();
218  };
219 }
220 }
Describes an action exposed in shortcut manager.
QPair< QString, QAction * > IDPair_t
#define UTIL_SHORTCUTS_API
std::shared_ptr< ICoreProxy > ICoreProxy_ptr
Definition: icoreproxy.h:202
Proxy for requesting shortcuts from the shortcut manager in the Core.
Aids in providing configurable shortcuts.
Definition: constants.h:35
Definition: anutil.h:38