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
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* 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 3 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 COMMON_ACTION_H
#define COMMON_ACTION_H
#include "common/scummsys.h"
#include "common/array.h"
#include "common/events.h"
#include "common/str.h"
#include "common/ustr.h"
namespace Common {
struct KeyActionEntry {
const char *id;
const KeyState ks;
const char *defaultHwId;
const char *description;
};
struct Action {
/** unique id used for saving/loading to config */
const char *id;
/** Human readable description */
U32String description;
/** Event to be sent when mapped key is pressed */
Event event;
private:
Array<String> _defaultInputMapping;
bool _shouldTriggerOnKbdRepeats;
public:
Action(const char *id, const U32String &description);
void setEvent(const Event &evt) {
event = evt;
}
void setEvent(const EventType evtType) {
event = Event();
event.type = evtType;
}
void setCustomBackendActionEvent(const CustomEventType evtType) {
event = Event();
event.type = EVENT_CUSTOM_BACKEND_ACTION_START;
event.customType = evtType;
}
void setCustomBackendActionAxisEvent(const CustomEventType evtType) {
event = Event();
event.type = EVENT_CUSTOM_BACKEND_ACTION_AXIS;
event.customType = evtType;
}
void setCustomEngineActionEvent(const CustomEventType evtType) {
event = Event();
event.type = EVENT_CUSTOM_ENGINE_ACTION_START;
event.customType = evtType;
}
void setKeyEvent(const KeyState &ks) {
event = Event();
event.type = EVENT_KEYDOWN;
event.kbd = ks;
}
void setLeftClickEvent() {
setEvent(EVENT_LBUTTONDOWN);
}
void setMiddleClickEvent() {
setEvent(EVENT_MBUTTONDOWN);
}
void setRightClickEvent() {
setEvent(EVENT_RBUTTONDOWN);
}
void setMouseWheelUpEvent() {
setEvent(EVENT_WHEELUP);
}
void setMouseWheelDownEvent() {
setEvent(EVENT_WHEELDOWN);
}
void setX1ClickEvent() {
setEvent(EVENT_X1BUTTONDOWN);
}
void setX2ClickEvent() {
setEvent(EVENT_X2BUTTONDOWN);
}
/**
* Allows an action bound to a keyboard event to be repeatedly
* triggered by key repeats
*
* Note that key repeat events should probably not be used for anything
* else than text input as they do not trigger when the action is bound
* to something else than a keyboard key. Furthermore, the frequency at
* which they trigger and whether they trigger at all is operating system
* controlled.
*/
void allowKbdRepeats() {
_shouldTriggerOnKbdRepeats = true;
}
bool shouldTriggerOnKbdRepeats() const { return _shouldTriggerOnKbdRepeats; }
/**
* Add a default input mapping for the action
*
* Unknown hardware inputs will be silently ignored.
* Having keyboard bindings by default will not cause trouble
* on devices without a keyboard.
*
* @param hwId Hardware input identifier as registered with the keymapper
*/
void addDefaultInputMapping(const String &hwId);
const Array<String> &getDefaultInputMapping() const {
return _defaultInputMapping;
}
};
} // End of namespace Common
#endif // #ifndef COMMON_ACTION_H
|
