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
|
/*
* Copyright (C) 2001 Peter Kelly (pmk@post.com)
* Copyright (C) 2001 Tobias Anton (anton@stud.fbi.fh-darmstadt.de)
* Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
* Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2013 Apple Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*/
#pragma once
#include "EventModifierInit.h"
#include "KeypressCommand.h"
#include "UIEventWithKeyState.h"
#include <memory>
#include <wtf/Vector.h>
namespace WebCore {
class Node;
class PlatformKeyboardEvent;
class KeyboardEvent final : public UIEventWithKeyState {
public:
enum KeyLocationCode {
DOM_KEY_LOCATION_STANDARD = 0x00,
DOM_KEY_LOCATION_LEFT = 0x01,
DOM_KEY_LOCATION_RIGHT = 0x02,
DOM_KEY_LOCATION_NUMPAD = 0x03
};
static Ref<KeyboardEvent> create(const PlatformKeyboardEvent& platformEvent, DOMWindow* view)
{
return adoptRef(*new KeyboardEvent(platformEvent, view));
}
static Ref<KeyboardEvent> createForBindings()
{
return adoptRef(*new KeyboardEvent);
}
struct Init : public EventModifierInit {
String key;
String code;
unsigned location;
bool repeat;
bool isComposing;
// Legacy.
String keyIdentifier;
std::optional<unsigned> keyLocation;
unsigned charCode;
unsigned keyCode;
unsigned which;
};
static Ref<KeyboardEvent> create(const AtomicString& type, const Init& initializer, IsTrusted isTrusted = IsTrusted::No)
{
return adoptRef(*new KeyboardEvent(type, initializer, isTrusted));
}
// FIXME: This method should be get ride of in the future.
// DO NOT USE IT!
static Ref<KeyboardEvent> createForDummy()
{
return adoptRef(*new KeyboardEvent(WTF::HashTableDeletedValue));
}
virtual ~KeyboardEvent();
WEBCORE_EXPORT void initKeyboardEvent(const AtomicString& type, bool canBubble, bool cancelable, DOMWindow*,
const String& keyIdentifier, unsigned location,
bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, bool altGraphKey = false);
#if ENABLE(KEYBOARD_KEY_ATTRIBUTE)
const String& key() const { return m_key; }
#endif
#if ENABLE(KEYBOARD_CODE_ATTRIBUTE)
const String& code() const { return m_code; }
#endif
const String& keyIdentifier() const { return m_keyIdentifier; }
unsigned location() const { return m_location; }
bool repeat() const { return m_repeat; }
WEBCORE_EXPORT bool getModifierState(const String& keyIdentifier) const;
const PlatformKeyboardEvent* keyEvent() const { return m_keyEvent.get(); }
WEBCORE_EXPORT int keyCode() const; // key code for keydown and keyup, character for keypress
WEBCORE_EXPORT int charCode() const; // character code for keypress, 0 for keydown and keyup
EventInterface eventInterface() const final;
bool isKeyboardEvent() const final;
int which() const final;
bool isComposing() const { return m_isComposing; }
#if PLATFORM(COCOA)
bool handledByInputMethod() const { return m_handledByInputMethod; }
const Vector<KeypressCommand>& keypressCommands() const { return m_keypressCommands; }
// The non-const version is still needed for WebKit1, which doesn't construct a complete KeyboardEvent with interpreted commands yet.
Vector<KeypressCommand>& keypressCommands() { return m_keypressCommands; }
#endif
private:
WEBCORE_EXPORT KeyboardEvent();
WEBCORE_EXPORT KeyboardEvent(const PlatformKeyboardEvent&, DOMWindow*);
KeyboardEvent(const AtomicString&, const Init&, IsTrusted);
// FIXME: This method should be get rid of in the future.
// DO NOT USE IT!
KeyboardEvent(WTF::HashTableDeletedValueType);
std::unique_ptr<PlatformKeyboardEvent> m_keyEvent;
#if ENABLE(KEYBOARD_KEY_ATTRIBUTE)
String m_key;
#endif
#if ENABLE(KEYBOARD_CODE_ATTRIBUTE)
String m_code;
#endif
String m_keyIdentifier;
unsigned m_location { DOM_KEY_LOCATION_STANDARD };
bool m_repeat { false };
bool m_isComposing { false };
std::optional<unsigned> m_charCode;
std::optional<unsigned> m_keyCode;
std::optional<unsigned> m_which;
#if PLATFORM(COCOA)
// Commands that were sent by AppKit when interpreting the event. Doesn't include input method commands.
bool m_handledByInputMethod { false };
Vector<KeypressCommand> m_keypressCommands;
#endif
};
KeyboardEvent* findKeyboardEvent(Event*);
} // namespace WebCore
SPECIALIZE_TYPE_TRAITS_EVENT(KeyboardEvent)
|
