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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
/* 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 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* $URL$
* $Id$
*
*/
#ifndef COMMON_VIRTUAL_KEYBOARD_H
#define COMMON_VIRTUAL_KEYBOARD_H
class OSystem;
#include "common/events.h"
#include "common/hashmap.h"
#include "common/hash-str.h"
#include "backends/vkeybd/image-map.h"
#include "common/keyboard.h"
#include "common/list.h"
#include "common/str.h"
namespace Common {
class VirtualKeyboardGUI;
class VirtualKeyboardParser;
class VirtualKeyboard {
protected:
enum EventType {
kEventKey,
kEventModifier,
kEventSwitchMode,
kEventSubmit,
kEventCancel,
kEventClear,
kEventDelete,
kEventMoveLeft,
kEventMoveRight
};
struct Event {
Common::String name;
EventType type;
void *data;
Event() : data(0) {}
~Event() {
if (data) free(data);
}
};
typedef Common::HashMap<Common::String, Event*> EventMap;
struct Mode {
Common::String name;
Common::String resolution;
Common::String bitmapName;
Graphics::Surface *image;
OverlayColor transparentColor;
Common::ImageMap imageMap;
EventMap events;
Common::Rect *displayArea;
OverlayColor displayFontColor;
Mode() : image(0), displayArea(0) {}
~Mode() { delete displayArea; }
};
typedef Common::HashMap<Common::String, Mode, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> ModeMap;
enum HorizontalAlignment {
kAlignLeft,
kAlignCentre,
kAlignRight
};
enum VerticalAlignment {
kAlignTop,
kAlignMiddle,
kAlignBottom
};
struct VirtualKeyPress {
Common::KeyState key;
uint strLen;
};
class KeyPressQueue {
public:
KeyPressQueue();
void toggleFlags(byte fl);
void clearFlags();
void insertKey(KeyState key);
void deleteKey();
void moveLeft();
void moveRight();
KeyState pop();
void clear();
bool empty();
String getString();
uint getInsertIndex();
bool hasStringChanged();
private:
byte _flags;
String _flagsStr;
List<VirtualKeyPress> _keys;
String _keysStr;
bool _strChanged;
List<VirtualKeyPress>::iterator _keyPos;
uint _strPos;
};
public:
VirtualKeyboard();
virtual ~VirtualKeyboard();
/**
* Loads the keyboard pack with the given name.
* The system first looks for an uncompressed keyboard pack by searching
* for packName.xml in the filesystem, if this does not exist then it
* searches for a compressed keyboard pack by looking for packName.zip.
* @param packName name of the keyboard pack
*/
bool loadKeyboardPack(Common::String packName);
/**
* Shows the keyboard, starting an event loop that will intercept all
* user input (like a modal GUI dialog).
* It is assumed that the game has been paused, before this is called
*/
void show();
/**
* Hides the keyboard, ending the event loop.
* @param submit if true all accumulated key presses are submitted to
* the event manager
*/
void close(bool submit);
/**
* Returns true if the keyboard is currently being shown
*/
bool isDisplaying();
/**
* Returns true if the keyboard is loaded and ready to be shown
*/
bool isLoaded() {
return _loaded;
}
protected: // TODO : clean up all this stuff
OSystem *_system;
friend class VirtualKeyboardGUI;
VirtualKeyboardGUI *_kbdGUI;
KeyPressQueue _keyQueue;
friend class VirtualKeyboardParser;
VirtualKeyboardParser *_parser;
void reset();
void deleteEvents();
bool checkModeResolutions();
void switchMode(Mode *newMode);
void switchMode(const Common::String& newMode);
void handleMouseDown(int16 x, int16 y);
void handleMouseUp(int16 x, int16 y);
String findArea(int16 x, int16 y);
void processAreaClick(const Common::String &area);
bool _loaded;
ModeMap _modes;
Mode *_initialMode;
Mode *_currentMode;
HorizontalAlignment _hAlignment;
VerticalAlignment _vAlignment;
String _areaDown;
bool _submitKeys;
};
} // End of namespace GUI
#endif
|
