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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
/*
* Copyright (C) 2009 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * 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.
* * Neither the name of Google Inc. 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 WebInputEvent_h
#define WebInputEvent_h
#include <string.h>
#include "WebCommon.h"
namespace WebKit {
// The classes defined in this file are intended to be used with
// WebWidget's handleInputEvent method. These event types are cross-
// platform and correspond closely to WebCore's Platform*Event classes.
//
// WARNING! These classes must remain PODs (plain old data). They are
// intended to be "serializable" by copying their raw bytes, so they must
// not contain any non-bit-copyable member variables!
// WebInputEvent --------------------------------------------------------------
class WebInputEvent {
public:
WebInputEvent() : type(None), modifiers(0) { }
// There are two schemes used for keyboard input. On Windows (and,
// interestingly enough, on Mac Carbon) there are two events for a
// keypress. One is a raw keydown, which provides the keycode only.
// If the app doesn't handle that, then the system runs key translation
// to create an event containing the generated character and pumps that
// event. In such a scheme, those two events are translated to
// RAW_KEY_DOWN and CHAR events respectively. In Cocoa and Gtk, key
// events contain both the keycode and any translation into actual
// text. In such a case, WebCore will eventually need to split the
// events (see disambiguateKeyDownEvent and its callers) but we don't
// worry about that here. We just use a different type (KEY_DOWN) to
// indicate this.
enum Type {
None = -1,
// WebMouseEvent
MouseDown,
MouseUp,
MouseMove,
MouseLeave,
// WebMouseWheelEvent
MouseWheel,
// WebKeyboardEvent
RawKeyDown,
KeyDown,
KeyUp,
Char
};
enum Modifiers {
// modifiers for all events:
ShiftKey = 1 << 0,
ControlKey = 1 << 1,
AltKey = 1 << 2,
MetaKey = 1 << 3,
// modifiers for keyboard events:
IsKeyPad = 1 << 4,
IsAutoRepeat = 1 << 5
};
Type type;
int modifiers;
// Returns true if the WebInputEvent |type| is a keyboard event.
static bool isKeyboardEventType(int type)
{
return type == RawKeyDown
|| type == KeyDown
|| type == KeyUp
|| type == Char;
}
};
// WebKeyboardEvent -----------------------------------------------------------
class WebKeyboardEvent : public WebInputEvent {
public:
// Caps on string lengths so we can make them static arrays and keep
// them PODs.
static const size_t textLengthCap = 4;
// http://www.w3.org/TR/DOM-Level-3-Events/keyset.html lists the
// identifiers. The longest is 18 characters, so we round up to the
// next multiple of 4.
static const size_t keyIdentifierLengthCap = 20;
// |windowsKeyCode| is the Windows key code associated with this key
// event. Sometimes it's direct from the event (i.e. on Windows),
// sometimes it's via a mapping function. If you want a list, see
// webkit/port/platform/chromium/KeyboardCodes* .
int windowsKeyCode;
// The actual key code genenerated by the platform. The DOM spec runs
// on Windows-equivalent codes (thus |windowsKeyCode| above) but it
// doesn't hurt to have this one around.
int nativeKeyCode;
// |text| is the text generated by this keystroke. |unmodifiedText| is
// |text|, but unmodified by an concurrently-held modifiers (except
// shift). This is useful for working out shortcut keys. Linux and
// Windows guarantee one character per event. The Mac does not, but in
// reality that's all it ever gives. We're generous, and cap it a bit
// longer.
WebUChar text[textLengthCap];
WebUChar unmodifiedText[textLengthCap];
// This is a string identifying the key pressed.
char keyIdentifier[keyIdentifierLengthCap];
// This identifies whether this event was tagged by the system as being
// a "system key" event (see
// http://msdn.microsoft.com/en-us/library/ms646286(VS.85).aspx for
// details). Other platforms don't have this concept, but it's just
// easier to leave it always false than ifdef.
bool isSystemKey;
WebKeyboardEvent()
: windowsKeyCode(0)
, nativeKeyCode(0)
, isSystemKey(false)
{
memset(&text, 0, sizeof(text));
memset(&unmodifiedText, 0, sizeof(unmodifiedText));
memset(&keyIdentifier, 0, sizeof(keyIdentifier));
}
// Sets keyIdentifier based on the value of windowsKeyCode. This is
// handy for generating synthetic keyboard events.
WEBKIT_API void setKeyIdentifierFromWindowsKeyCode();
};
// WebMouseEvent --------------------------------------------------------------
class WebMouseEvent : public WebInputEvent {
public:
// These values defined for WebCore::MouseButton
enum Button {
ButtonNone = -1,
ButtonLeft,
ButtonMiddle,
ButtonRight
};
Button button;
int x;
int y;
int globalX;
int globalY;
double timeStampSeconds; // Seconds since epoch.
int clickCount;
WebMouseEvent()
: button(ButtonNone)
, x(0)
, y(0)
, globalX(0)
, globalY(0)
, timeStampSeconds(0.0)
, clickCount(0)
{
}
};
// WebMouseWheelEvent ---------------------------------------------------------
class WebMouseWheelEvent : public WebMouseEvent {
public:
float deltaX;
float deltaY;
float wheelTicksX;
float wheelTicksY;
bool scrollByPage;
WebMouseWheelEvent()
: deltaX(0.0f)
, deltaY(0.0f)
, wheelTicksX(0.0f)
, wheelTicksY(0.0f)
, scrollByPage(false)
{
}
};
} // namespace WebKit
#endif
|
