aboutsummaryrefslogtreecommitdiff
path: root/backends/common/virtual-keyboard.h
blob: a0a678ba86c8768d0c79fc5a6a648ddf793cf5b5 (plain)
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
/* 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 "common/image-map.h"
#include "common/keyboard.h"
#include "common/str.h"
#include "graphics/surface.h"

namespace Common {

class VirtualKeyboardParser;



class VirtualKeyboard {

	/** Type of key event */
	enum EventType {
		kEventKey,
		kEventSwitchMode,
		kEventClose,

		kEventMax
	};

	struct Event {
		Common::String name;
		EventType type;
		void *data;
	};
	
	typedef Common::HashMap<Common::String, Event, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> EventMap; 

	struct Mode {
		Common::String     name;
		Common::String     resolution;
		Common::String     bitmapName;
		Graphics::Surface *image;
		Common::ImageMap   imageMap;
		EventMap           events;
		Mode() : image(0) {}
	};
	
	typedef Common::HashMap<Common::String, Mode, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> ModeMap;

	enum HorizontalAlignment {
		kAlignLeft,
		kAlignCentre,
		kAlignRight
	};

	enum VerticalAlignment {
		kAlignTop,
		kAlignMiddle,
		kAlignBottom
	};

public:
	VirtualKeyboard();
	virtual ~VirtualKeyboard();

	bool loadKeyboardPack(Common::String packName);
	void show();
	void hide();
	bool isDisplaying() { 
		return _displaying;
	}
	bool isLoaded() {
		return _loaded;
	}

	/**
	  * Get the next virtual key event in the event queue.
	  * @param event	point to an Event struct, which will be filled with the event data.
	  * @return true if an event was retrieved.
	  */
	bool pollEvent(Common::Event &event);

private:
	OSystem	*_system;
	
	friend class VirtualKeyboardParser;
	VirtualKeyboardParser *_parser;

	// TODO : sort order of all this stuff
	void reset();
	void reposition();
	void switchMode(Mode *newMode);
	void switchMode(const Common::String& newMode);
	void processClick(int16 x, int16 y);
	void runLoop();
	void redraw();

	bool _loaded;
	bool _displaying;
	bool _needRedraw;

	ModeMap _modes;
	Mode *_initialMode;
	Mode *_currentMode;

	Common::Point _pos;
	HorizontalAlignment  _hAlignment;
	VerticalAlignment    _vAlignment;

	Common::Point _mouseDown;

	Common::Array<Common::KeyState> _keyQueue;
	Common::KeyState *_keyDown;

};


} // End of namespace GUI


#endif