LeechCraft  %{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
ihaveshortcuts.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 #ifndef INTERFACES_IHAVESHORTCUTS_H
31 #define INTERFACES_IHAVESHORTCUTS_H
32 #include <QtPlugin>
33 #include <QMultiMap>
34 #include <QString>
35 #include <QKeySequence>
36 #include <QIcon>
37 #include <QMetaType>
38 
39 class QAction;
40 
41 typedef QList<QKeySequence> QKeySequences_t;
43 
44 namespace LeechCraft
45 {
52  struct ActionInfo
53  {
59  QIcon Icon_;
60 
62  {
63  }
64 
65  ActionInfo (const QString& uvt,
66  const QKeySequence& seq,
67  const QIcon& icon)
68  : UserVisibleText_ (uvt)
69  , Icon_ (icon)
70  {
71  Seqs_ << seq;
72  }
73 
74  ActionInfo (const QString& uvt,
75  const QKeySequences_t& seqs,
76  const QIcon& icon)
77  : UserVisibleText_ (uvt)
78  , Seqs_ (seqs)
79  , Icon_ (icon)
80  {
81  }
82  };
83 };
84 
86 
94 class Q_DECL_EXPORT IShortcutProxy
95 {
96 public:
112  virtual QKeySequences_t GetShortcuts (QObject *object, const QString& id) = 0;
113 
114  virtual ~IShortcutProxy () { }
115 };
116 
124 class Q_DECL_EXPORT IHaveShortcuts
125 {
126 public:
134  virtual void SetShortcut (const QString& id, const QKeySequences_t& sequences) = 0;
135 
144  virtual QMap<QString, LeechCraft::ActionInfo> GetActionInfo () const = 0;
145 
146  virtual ~IHaveShortcuts () { }
147 };
148 
149 Q_DECLARE_INTERFACE (IShortcutProxy, "org.Deviant.LeechCraft.IShortcutProxy/1.0");
150 Q_DECLARE_INTERFACE (IHaveShortcuts, "org.Deviant.LeechCraft.IHaveShortcuts/1.0");
151 
152 #endif
153 
virtual ~IHaveShortcuts()
QList< QKeySequence > QKeySequences_t
Q_DECLARE_INTERFACE(IColorThemeManager,"org.Deviant.LeechCraft.IColorThemeManager/1.0")
Interface for plugins that support configuring shortcuts.
Describes an action exposed in shortcut manager.
QKeySequences_t Seqs_
List of key sequences for this action.
QString UserVisibleText_
User-visible name of the action.
Proxy for requesting shortcuts from the shortcut manager in the Core.
QIcon Icon_
Icon of the action.
ActionInfo(const QString &uvt, const QKeySequence &seq, const QIcon &icon)
virtual ~IShortcutProxy()
ActionInfo(const QString &uvt, const QKeySequences_t &seqs, const QIcon &icon)
Q_DECLARE_METATYPE(LeechCraft::IHookProxy_ptr)