2006-10-07 Anders Carlsson <acarlsson@apple.com>
[WebKit-https.git] / WebCore / dom / KeyboardEvent.h
1 /*
2  * This file is part of the DOM implementation for KDE.
3  *
4  * Copyright (C) 2001 Peter Kelly (pmk@post.com)
5  * Copyright (C) 2001 Tobias Anton (anton@stud.fbi.fh-darmstadt.de)
6  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
7  * Copyright (C) 2003, 2004, 2005, 2006 Apple Computer, Inc.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public License
20  * along with this library; see the file COPYING.LIB.  If not, write to
21  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22  * Boston, MA 02111-1307, USA.
23  *
24  */
25
26 #ifndef KeyboardEvent_h
27 #define KeyboardEvent_h
28
29 #include "UIEventWithKeyState.h"
30
31 namespace WebCore {
32
33     class PlatformKeyboardEvent;
34
35     // Introduced in DOM Level 3
36     class KeyboardEvent : public UIEventWithKeyState {
37     public:
38         enum KeyLocationCode {
39             DOM_KEY_LOCATION_STANDARD      = 0x00,
40             DOM_KEY_LOCATION_LEFT          = 0x01,
41             DOM_KEY_LOCATION_RIGHT         = 0x02,
42             DOM_KEY_LOCATION_NUMPAD        = 0x03
43         };
44         
45         KeyboardEvent();
46         KeyboardEvent(const PlatformKeyboardEvent&, AbstractView*);
47         KeyboardEvent(const AtomicString& type, bool canBubble, bool cancelable, AbstractView* view,
48                       const String& keyIdentifier, unsigned keyLocation,
49                       bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, bool altGraphKey);
50         virtual ~KeyboardEvent();
51     
52         void initKeyboardEvent(const AtomicString& type, bool canBubble, bool cancelable, AbstractView* view,
53                                const String& keyIdentifier, unsigned keyLocation,
54                                bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, bool altGraphKey = false);
55     
56         String keyIdentifier() const { return m_keyIdentifier; }
57         unsigned keyLocation() const { return m_keyLocation; }
58     
59         bool altGraphKey() const { return m_altGraphKey; }
60     
61         const PlatformKeyboardEvent* keyEvent() const { return m_keyEvent; }
62
63         int keyCode() const; // key code for keydown and keyup, character for other events
64         int charCode() const;
65     
66         virtual bool isKeyboardEvent() const;
67         virtual int which() const;
68
69     private:
70         PlatformKeyboardEvent* m_keyEvent;
71         String m_keyIdentifier;
72         unsigned m_keyLocation;
73         bool m_altGraphKey : 1;
74     };
75
76 } // namespace WebCore
77
78 #endif // KeyboardEvent_h