1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
Copyright (C) 2013 Martin Gräßlin <mgraesslin@kde.org>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#ifndef KWIN_GLOBALSHORTCUTS_H
#define KWIN_GLOBALSHORTCUTS_H
// KWin
#include <kwinglobals.h>
// KDE
#include <KSharedConfig>
// Qt
#include <QKeySequence>
class QAction;
class KGlobalAccelD;
class KGlobalAccelInterface;
namespace KWin
{
class GlobalShortcut;
/**
* @brief Manager for the global shortcut system inside KWin.
*
* This class is responsible for holding all the global shortcuts and to process a key press event.
* That is trigger a shortcut if there is a match.
*
* For internal shortcut handling (those which are delivered inside KWin) QActions are used and
* triggered if the shortcut matches. For external shortcut handling a DBus interface is used.
**/
class GlobalShortcutsManager : public QObject
{
Q_OBJECT
public:
explicit GlobalShortcutsManager(QObject *parent = nullptr);
virtual ~GlobalShortcutsManager();
void init();
/**
* @brief Registers an internal global shortcut
*
* @param action The action to trigger if the shortcut is pressed
* @param shortcut The key sequence which triggers this shortcut
*/
void registerShortcut(QAction *action, const QKeySequence &shortcut);
/**
* @brief Registers an internal global pointer shortcut
*
* @param action The action to trigger if the shortcut is pressed
* @param modifiers The modifiers which need to be hold to trigger the action
* @param pointerButtons The pointer button which needs to be pressed
*/
void registerPointerShortcut(QAction *action, Qt::KeyboardModifiers modifiers, Qt::MouseButtons pointerButtons);
/**
* @brief Registers an internal global axis shortcut
*
* @param action The action to trigger if the shortcut is triggered
* @param modifiers The modifiers which need to be hold to trigger the action
* @param pointerButtons The pointer axis
*/
void registerAxisShortcut(QAction *action, Qt::KeyboardModifiers modifiers, PointerAxisDirection axis);
/**
* @brief Processes a key event to decide whether a shortcut needs to be triggered.
*
* If a shortcut triggered this method returns @c true to indicate to the caller that the event
* should not be further processed. If there is no shortcut which triggered for the key, then
* @c false is returned.
*
* @param modifiers The current hold modifiers
* @param key The keysymbol which has been pressed
* @param keyQt The Qt::Key which got pressed
* @return @c true if a shortcut triggered, @c false otherwise
*/
bool processKey(Qt::KeyboardModifiers modifiers, uint32_t key, int keyQt);
bool processPointerPressed(Qt::KeyboardModifiers modifiers, Qt::MouseButtons pointerButtons);
/**
* @brief Processes a pointer axis event to decide whether a shortcut needs to be triggered.
*
* If a shortcut triggered this method returns @c true to indicate to the caller that the event
* should not be further processed. If there is no shortcut which triggered for the key, then
* @c false is returned.
*
* @param modifiers The current hold modifiers
* @param axis The axis direction which has triggered this event
* @return @c true if a shortcut triggered, @c false otherwise
*/
bool processAxis(Qt::KeyboardModifiers modifiers, PointerAxisDirection axis);
void setKGlobalAccelInterface(KGlobalAccelInterface *interface) {
m_kglobalAccelInterface = interface;
}
private:
void objectDeleted(QObject *object);
QKeySequence getShortcutForAction(const QString &componentName, const QString &actionName, const QKeySequence &defaultShortcut);
QHash<Qt::KeyboardModifiers, QHash<uint32_t, GlobalShortcut*> > m_shortcuts;
QHash<Qt::KeyboardModifiers, QHash<Qt::MouseButtons, GlobalShortcut*> > m_pointerShortcuts;
QHash<Qt::KeyboardModifiers, QHash<PointerAxisDirection, GlobalShortcut*> > m_axisShortcuts;
KSharedConfigPtr m_config;
KGlobalAccelD *m_kglobalAccel = nullptr;
KGlobalAccelInterface *m_kglobalAccelInterface = nullptr;
};
class GlobalShortcut
{
public:
virtual ~GlobalShortcut();
const QKeySequence &shortcut() const;
Qt::KeyboardModifiers pointerButtonModifiers() const;
Qt::MouseButtons pointerButtons() const;
virtual void invoke() = 0;
protected:
GlobalShortcut(const QKeySequence &shortcut);
GlobalShortcut(Qt::KeyboardModifiers pointerButtonModifiers, Qt::MouseButtons pointerButtons);
GlobalShortcut(Qt::KeyboardModifiers axisModifiers, PointerAxisDirection axis);
private:
QKeySequence m_shortcut;
Qt::KeyboardModifiers m_pointerModifiers;
Qt::MouseButtons m_pointerButtons;
PointerAxisDirection m_axis;
};
class InternalGlobalShortcut : public GlobalShortcut
{
public:
InternalGlobalShortcut(Qt::KeyboardModifiers modifiers, const QKeySequence &shortcut, QAction *action);
InternalGlobalShortcut(Qt::KeyboardModifiers pointerButtonModifiers, Qt::MouseButtons pointerButtons, QAction *action);
InternalGlobalShortcut(Qt::KeyboardModifiers axisModifiers, PointerAxisDirection axis, QAction *action);
virtual ~InternalGlobalShortcut();
void invoke() override;
QAction *action() const;
private:
QAction *m_action;
};
inline
QAction *InternalGlobalShortcut::action() const
{
return m_action;
}
inline
const QKeySequence &GlobalShortcut::shortcut() const
{
return m_shortcut;
}
inline
Qt::KeyboardModifiers GlobalShortcut::pointerButtonModifiers() const
{
return m_pointerModifiers;
}
inline
Qt::MouseButtons GlobalShortcut::pointerButtons() const
{
return m_pointerButtons;
}
} // namespace
#endif
|
