Reviewed by Darin.
[WebKit-https.git] / WebCore / dom / KeyboardEvent.h
1 /*
2  * Copyright (C) 2001 Peter Kelly (pmk@post.com)
3  * Copyright (C) 2001 Tobias Anton (anton@stud.fbi.fh-darmstadt.de)
4  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
5  * Copyright (C) 2003, 2004, 2005, 2006, 2007 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #ifndef KeyboardEvent_h
25 #define KeyboardEvent_h
26
27 #include "UIEventWithKeyState.h"
28 #include <wtf/Vector.h>
29
30 namespace WebCore {
31
32     class PlatformKeyboardEvent;
33
34 #if PLATFORM(MAC)
35     struct KeypressCommand {
36         KeypressCommand(const String& commandName) : commandName(commandName) {}
37         KeypressCommand(const String& commandName, const String& text) : commandName(commandName), text(text) { ASSERT(commandName == "insertText:"); }
38
39         String commandName;
40         String text;
41     };
42 #endif
43     
44     // Introduced in DOM Level 3
45     class KeyboardEvent : public UIEventWithKeyState {
46     public:
47         enum KeyLocationCode {
48             DOM_KEY_LOCATION_STANDARD      = 0x00,
49             DOM_KEY_LOCATION_LEFT          = 0x01,
50             DOM_KEY_LOCATION_RIGHT         = 0x02,
51             DOM_KEY_LOCATION_NUMPAD        = 0x03
52         };
53         
54         KeyboardEvent();
55         KeyboardEvent(const PlatformKeyboardEvent&, AbstractView*);
56         KeyboardEvent(const AtomicString& type, bool canBubble, bool cancelable, AbstractView*,
57                       const String& keyIdentifier, unsigned keyLocation,
58                       bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, bool altGraphKey);
59         virtual ~KeyboardEvent();
60     
61         void initKeyboardEvent(const AtomicString& type, bool canBubble, bool cancelable, AbstractView*,
62                                const String& keyIdentifier, unsigned keyLocation,
63                                bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, bool altGraphKey = false);
64     
65         String keyIdentifier() const { return m_keyIdentifier; }
66         unsigned keyLocation() const { return m_keyLocation; }
67
68         bool getModifierState(const String& keyIdentifier) const;
69
70         bool altGraphKey() const { return m_altGraphKey; }
71     
72         const PlatformKeyboardEvent* keyEvent() const { return m_keyEvent; }
73
74         int keyCode() const; // key code for keydown and keyup, character for keypress
75         int charCode() const; // character code for keypress, 0 for keydown and keyup
76     
77         virtual bool isKeyboardEvent() const;
78         virtual int which() const;
79
80 #if PLATFORM(MAC)
81         // We only have this need to store keypress command info on the Mac.
82         Vector<KeypressCommand>& keypressCommands() { return m_keypressCommands; }
83 #endif
84
85     private:
86         PlatformKeyboardEvent* m_keyEvent;
87         String m_keyIdentifier;
88         unsigned m_keyLocation;
89         bool m_altGraphKey : 1;
90
91 #if PLATFORM(MAC)        
92         Vector<KeypressCommand> m_keypressCommands;
93 #endif
94     };
95
96     KeyboardEvent* findKeyboardEvent(Event*);
97
98 } // namespace WebCore
99
100 #endif // KeyboardEvent_h