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
|
/*
* The ManaPlus Client
* Copyright (C) 2011-2014 The ManaPlus Developers
*
* This file is part of The ManaPlus Client.
*
* 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
* 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/>.
*/
/* _______ __ __ __ ______ __ __ _______ __ __
* / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
* / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
* / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
* / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
* /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
* \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
*
* Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
*
*
* Per Larsson a.k.a finalman
* Olof Naessén a.k.a jansem/yakslem
*
* Visit: http://guichan.sourceforge.net
*
* License: (BSD)
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name of Guichan nor the names of its contributors may
* be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef EVENTS_KEYEVENT_HPP
#define EVENTS_KEYEVENT_HPP
#include "events/inputguievent.h"
#include "gui/base/key.hpp"
namespace gcn
{
class Widget;
}
/**
* Represents a key event.
*/
class KeyEvent: public InputGuiEvent
{
public:
/**
* Key event types.
*/
enum
{
PRESSED = 0,
RELEASED
};
/**
* Constructor.
*
* @param source The source widget of the event.
* @param shiftPressed True if shift is pressed, false otherwise.
* @param controlPressed True if control is pressed, false otherwise.
* @param altPressed True if alt is pressed, false otherwise.
* @param metaPressed True if meta is pressed, false otherwise.
* @param type The type of the event. A value from KeyEventType.
* @param numericPad True if the event occured on the numeric pad,
* false otherwise.
* @param key The key of the event.
*/
KeyEvent(gcn::Widget *const source,
const bool shiftPressed,
const bool controlPressed,
const bool altPressed,
const bool metaPressed,
const unsigned int type,
const bool numericPad,
const int actionId,
const gcn::Key &key) :
InputGuiEvent(source,
shiftPressed,
controlPressed,
altPressed,
metaPressed),
mKey(key),
#ifdef USE_SDL2
mText(),
#endif
mType(type),
mActionId(actionId),
mIsNumericPad(numericPad)
{ }
/**
* Destructor.
*/
virtual ~KeyEvent()
{ }
/**
* Gets the type of the event.
*
* @return The type of the event.
*/
unsigned int getType() const A_WARN_UNUSED
{ return mType; }
/**
* Checks if the key event occured on the numeric pad.
*
* @return True if key event occured on the numeric pad,
* false otherwise.
*
*/
bool isNumericPad() const A_WARN_UNUSED
{ return mIsNumericPad; }
/**
* Gets the key of the event.
*
* @return The key of the event.
*/
const gcn::Key &getKey() const A_WARN_UNUSED
{ return mKey; }
int getActionId() const A_WARN_UNUSED
{ return mActionId; }
#ifdef USE_SDL2
void setText(const std::string &text)
{ mText = text; }
std::string getText() const
{ return mText; }
#endif
protected:
/**
* Holds the key of the key event.
*/
gcn::Key mKey;
#ifdef USE_SDL2
std::string mText;
#endif
/**
* Holds the type of the key event.
*/
unsigned int mType;
int mActionId;
/**
* True if the numeric pad was used, false otherwise.
*/
bool mIsNumericPad;
};
#endif // EVENTS_KEYEVENT_HPP
|
