Mercurial > fife-parpg

comparison ext/guichan-0.8.1/include/guichan/keyevent.hpp @ 0:4a0efb7baf70

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Datasets becomes the new trunk and retires after that :-)
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 29 Jun 2008 18:44:17 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:4a0efb7baf70
1 /* _______ __ __ __ ______ __ __ _______ __ __
2 * / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
3 * / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
4 * / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
5 * / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
6 * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
7 * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
8 *
9 * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
10 *
11 *
12 * Per Larsson a.k.a finalman
13 * Olof Naessén a.k.a jansem/yakslem
14 *
15 * Visit: http://guichan.sourceforge.net
16 *
17 * License: (BSD)
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions
20 * are met:
21 * 1. Redistributions of source code must retain the above copyright
22 * notice, this list of conditions and the following disclaimer.
23 * 2. Redistributions in binary form must reproduce the above copyright
24 * notice, this list of conditions and the following disclaimer in
25 * the documentation and/or other materials provided with the
26 * distribution.
27 * 3. Neither the name of Guichan nor the names of its contributors may
28 * be used to endorse or promote products derived from this software
29 * without specific prior written permission.
30 *
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
37 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
38 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
39 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
40 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
41 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 #ifndef GCN_KEYEVENT_HPP
45 #define GCN_KEYEVENT_HPP
46
47 #include "guichan/inputevent.hpp"
48 #include "guichan/key.hpp"
49 #include "guichan/platform.hpp"
50
51 namespace gcn
52 {
53 class Widget;
54
55 /**
56 * Represents a key event.
57 */
58 class GCN_CORE_DECLSPEC KeyEvent: public InputEvent
59 {
60 public:
61 /**
62 * Key event types.
63 */
64 enum
65 {
66 PRESSED = 0,
67 RELEASED
68 };
69
70 /**
71 * Constructor.
72 *
73 * @param source The source widget of the event.
74 * @param isShiftPressed True if shift is pressed, false otherwise.
75 * @param isControlPressed True if control is pressed, false otherwise.
76 * @param isAltPressed True if alt is pressed, false otherwise.
77 * @param isMetaPressed True if meta is pressed, false otherwise.
78 * @param type The type of the event. A value from KeyEventType.
79 * @param isNumericPad True if the event occured on the numeric pad,
80 * false otherwise.
81 * @param key The key of the event.
82 */
83 KeyEvent(Widget* source,
84 bool isShiftPressed,
85 bool isControlPressed,
86 bool isAltPressed,
87 bool isMetaPressed,
88 unsigned int type,
89 bool isNumericPad,
90 const Key& key);
91
92 /**
93 * Destructor.
94 */
95 virtual ~KeyEvent();
96
97 /**
98 * Gets the type of the event.
99 *
100 * @return The type of the event.
101 */
102 unsigned int getType() const;
103
104 /**
105 * Checks if the key event occured on the numeric pad.
106 *
107 * @return True if key event occured on the numeric pad,
108 * false otherwise.
109 *
110 */
111 bool isNumericPad() const;
112
113 /**
114 * Gets the key of the event.
115 *
116 * @return The key of the event.
117 */
118 const Key& getKey() const;
119
120 protected:
121 /**
122 * Holds the type of the key event.
123 */
124 unsigned int mType;
125
126 /**
127 * True if the numeric pad was used, false otherwise.
128 */
129 bool mIsNumericPad;
130
131 /**
132 * Holds the key of the key event.
133 */
134 Key mKey;
135 };
136 }
137
138 #endif // end GCN_KEYEVENT_HPP