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
|
/* _______ __ __ __ ______ __ __ _______ __ __
* / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
* / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
* / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
* / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
* /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
* \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
*
* Copyright (c) 2004 - 2008 Olof Naess�n and Per Larsson
* Copyright (C) 2011-2012 The ManaPlus Developers
*
*
* 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 GCN_INPUTEVENT_HPP
#define GCN_INPUTEVENT_HPP
#include "guichan/event.hpp"
#include "guichan/platform.hpp"
namespace gcn
{
/**
* Base class for all events concerning input.
*
* @author Olof Naess�n
* @since 0.6.0
*/
class GCN_CORE_DECLSPEC InputEvent: public Event
{
public:
/**
* Constructor.
*
* @param source The source widget of the event.
* @param isShiftPressed True if shift is pressed, false otherwise.
* @param isControlPressed True if control is pressed, false otherwise.
* @param isAltPressed True if alt is pressed, false otherwise.
* @param isMetaPressed True if meta is pressed, false otherwise.
*/
InputEvent(Widget *const source,
const bool shiftPressed,
const bool controlPressed,
const bool altPressed,
const bool metaPressed);
/**
* Checks if shift is pressed.
*
* @return True if shift was pressed at the same time as the key,
* false otherwise.
*/
bool isShiftPressed() const A_WARN_UNUSED;
/**
* Checks if control is pressed.
*
* @return True if control was pressed at the same time as the key,
* false otherwise.
*/
bool isControlPressed() const A_WARN_UNUSED;
/**
* Checks if alt is pressed.
*
* @return True if alt was pressed at the same time as the key,
* false otherwise.
*/
bool isAltPressed() const A_WARN_UNUSED;
/**
* Checks whether meta is pressed.
*
* @return True if meta was pressed at the same time as the key,
* false otherwise.
*/
bool isMetaPressed() const A_WARN_UNUSED;
/**
* Marks the event as consumed. Input event listeners may discard
* consumed input or act on consumed input. An example of a widget
* that discards consumed input is the ScrollArea widget that
* discards consumed mouse wheel events so the ScrollArea will not
* scroll if for instance a Slider's value inside the ScrollArea was
* changed with the mouse wheel.
*
* @see isConsumed
*/
void consume();
/**
* Checks if the input event is consumed.
*
* @return True if the input event is consumed,
* false otherwise.
* @see consume
*/
bool isConsumed() const A_WARN_UNUSED;
protected:
/**
* True if shift is pressed, false otherwise.
*/
bool mShiftPressed;
/**
* True if control is pressed, false otherwise.
*/
bool mControlPressed;
/**
* True if alt is pressed, false otherwise.
*/
bool mAltPressed;
/**
* True if meta is pressed, false otherwise.
*/
bool mMetaPressed;
/**
* True if the input event is consumed,
* false otherwise.
*/
bool mIsConsumed;
};
}
#endif // end GCN_INPUTEVENT_HPP
|
