_________ __                 __
        /   _____//  |_____________ _/  |______     ____  __ __  ______
        \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
        /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ \
       /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
               \/                  \/          \//_____/            \/
    ______________________                           ______________________
                          T H E   W A R   B E G I N S
                   Stratagus - A free fantasy real time strategy game engine

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
key.h
Go to the documentation of this file.
1 /* _______ __ __ __ ______ __ __ _______ __ __
2  * / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
3  * / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
4  * / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
5  * / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
6  * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
7  * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
8  *
9  * Copyright (c) 2004, 2005 darkbits Js_./
10  * Per Larsson a.k.a finalman _RqZ{a<^_aa
11  * Olof Naessén a.k.a jansem/yakslem _asww7!uY`> )\a//
12  * _Qhm`] _f "'c 1!5m
13  * Visit: http://guichan.darkbits.org )Qk<P ` _: :+' .' "{[
14  * .)j(] .d_/ '-( P . S
15  * License: (BSD) <Td/Z <fP"5(\"??"\a. .L
16  * Redistribution and use in source and _dV>ws?a-?' ._/L #'
17  * binary forms, with or without )4d[#7r, . ' )d`)[
18  * modification, are permitted provided _Q-5'5W..j/?' -?!\)cam'
19  * that the following conditions are met: j<<WP+k/);. _W=j f
20  * 1. Redistributions of source code must .$%w\/]Q . ."' . mj$
21  * retain the above copyright notice, ]E.pYY(Q]>. a J@\
22  * this list of conditions and the j(]1u<sE"L,. . ./^ ]{a
23  * following disclaimer. 4'_uomm\. )L);-4 (3=
24  * 2. Redistributions in binary form must )_]X{Z('a_"a7'<a"a, ]"[
25  * reproduce the above copyright notice, #}<]m7`Za??4,P-"'7. ).m
26  * this list of conditions and the ]d2e)Q(<Q( ?94 b- LQ/
27  * following disclaimer in the <B!</]C)d_, '(<' .f. =C+m
28  * documentation and/or other materials .Z!=J ]e []('-4f _ ) -.)m]'
29  * provided with the distribution. .w[5]' _[ /.)_-"+? _/ <W"
30  * 3. Neither the name of Guichan nor the :$we` _! + _/ . j?
31  * names of its contributors may be used =3)= _f (_yQmWW$#( "
32  * to endorse or promote products derived - W, sQQQQmZQ#Wwa]..
33  * from this software without specific (js, \[QQW$QWW#?!V"".
34  * prior written permission. ]y:.<\.. .
35  * -]n w/ ' [.
36  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT )/ )/ !
37  * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY < (; sac , '
38  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, ]^ .- %
39  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF c < r
40  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR aga< <La
41  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 5% )P'-3L
42  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR _bQf` y`..)a
43  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, ,J?4P'.P"_(\?d'.,
44  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES _Pa,)!f/<[]/ ?"
45  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT _2-..:. .r+_,.. .
46  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, ?a.<%"' " -'.a_ _,
47  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ^
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
49  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
50  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
51  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
52  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
53  */
54 
55 #ifndef GCN_KEY_HPP
56 #define GCN_KEY_HPP
57 
58 #include <string>
59 
60 #include "guichan/platform.h"
61 
62 namespace gcn
63 {
68  {
69  public:
73  Key();
74 
80  Key(int value);
81 
87  bool isCharacter() const;
88 
94  bool isNumber() const;
95 
101  bool isLetter() const;
102 
108  bool isShiftPressed() const;
109 
115  void setShiftPressed(bool pressed);
116 
121  bool isControlPressed() const;
122 
128  void setControlPressed(bool pressed);
129 
135  bool isAltPressed() const;
136 
142  void setAltPressed(bool pressed);
143 
149  bool isMetaPressed() const;
150 
156  void setMetaPressed(bool pressed);
157 
163  bool isNumericPad() const;
164 
170  void setNumericPad(bool numpad);
171 
178  int getValue() const;
179 
185  void setValue(int value);
186 
190  std::string toString() const;
191 
195  enum
196  {
197  K_SPACE = ' ',
198  K_TAB = '\t',
199  K_ENTER = '\n',
200  K_LEFT_ALT = 1000,
242  K_DOWN
243  };
244 
245  protected:
246  int mValue;
252  };
253 }
254 
255 #endif // end GCN_KEY_HPP
Definition: key.h:237
Definition: key.h:212
Definition: key.h:206
Definition: key.h:217
Definition: key.h:204
Definition: key.h:221
Definition: key.h:222
bool mControlPressed
Definition: key.h:248
Definition: key.h:213
Definition: key.h:225
Definition: key.h:234
Definition: key.h:202
bool mNumericPad
Definition: key.h:251
Definition: key.h:208
Definition: key.h:231
Definition: key.h:224
Definition: key.h:216
Definition: key.h:201
Definition: key.h:235
Definition: key.h:230
bool mMetaPressed
Definition: key.h:250
Definition: key.h:211
Definition: key.h:220
Definition: key.h:241
Definition: key.h:239
Definition: key.h:203
Definition: key.h:215
Definition: key.h:232
Definition: key.h:210
Definition: key.h:209
Definition: key.h:219
Definition: key.h:233
bool mShiftPressed
Definition: key.h:247
Definition: cliprectangle.cpp:61
#define GCN_CORE_DECLSPEC
Definition: platform.h:59
Definition: key.h:240
Definition: key.h:229
Definition: key.h:218
Definition: key.h:238
Definition: key.h:67
int mValue
Definition: key.h:246
Definition: key.h:226
Definition: key.h:227
Definition: key.h:205
bool mAltPressed
Definition: key.h:249
Definition: key.h:207
Definition: key.h:228
Definition: key.h:223
Definition: key.h:236
Definition: key.h:214
(C) Copyright 1998-2012 by The Stratagus Project under the GNU General Public License.
All trademarks and copyrights on this page are owned by their respective owners.