2b95dddc6d0bfdbdfdd03a543f5a064a02c0415f
[WebKit-https.git] / WebCore / platform / PlatformKeyboardEvent.h
1 /*
2  * Copyright (C) 2004, 2005, 2006 Apple Computer, Inc.  All rights reserved.
3  * Copyright (C) 2008 Collabora, Ltd.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #ifndef PlatformKeyboardEvent_h
28 #define PlatformKeyboardEvent_h
29
30 #include "PlatformString.h"
31 #include <wtf/Platform.h>
32
33 #if PLATFORM(MAC)
34 #include <wtf/RetainPtr.h>
35 #ifdef __OBJC__
36 @class NSEvent;
37 #else
38 class NSEvent;
39 #endif
40 #endif
41
42 #if PLATFORM(WIN)
43 typedef struct HWND__ *HWND;
44 typedef unsigned WPARAM;
45 typedef long LPARAM;
46 #endif
47
48 #if PLATFORM(GTK)
49 typedef struct _GdkEventKey GdkEventKey;
50 #endif
51
52 #if PLATFORM(QT)
53 QT_BEGIN_NAMESPACE
54 class QKeyEvent;
55 QT_END_NAMESPACE
56 #endif
57
58 #if PLATFORM(WX)
59 class wxKeyEvent;
60 #endif
61
62 namespace WebCore {
63
64     class PlatformKeyboardEvent {
65     public:
66         enum Type {
67             // KeyDown is sent by platforms such as Mac OS X, gtk and Qt, and has information about both physical pressed key, and its translation.
68             // For DOM processing, it needs to be disambiguated as RawKeyDown or Char event.
69             KeyDown,
70
71             // KeyUp is sent by all platforms.
72             KeyUp,
73
74             // These events are sent by platforms such as Windows and wxWidgets. RawKeyDown only has information about a physical key, and Char
75             // only has information about a character it was translated into.
76             RawKeyDown,
77             Char
78         };
79
80         enum ModifierKey {
81             AltKey = 1 << 0,
82             CtrlKey = 1 << 1,
83             MetaKey = 1 << 2,
84             ShiftKey = 1 << 3,
85         };
86
87         Type type() const { return m_type; }
88         void disambiguateKeyDownEvent(Type, bool backwardCompatibilityMode = false); // Only used on platforms that need it, i.e. those that generate KeyDown events.
89
90         // Text as as generated by processing a virtual key code with a keyboard layout
91         // (in most cases, just a character code, but the layout can emit several
92         // characters in a single keypress event on some platforms).
93         // This may bear no resemblance to the ultimately inserted text if an input method
94         // processes the input.
95         // Will be null for KeyUp and RawKeyDown events.
96         String text() const { return m_text; }
97
98         // Text that would have been generated by the keyboard if no modifiers were pressed
99         // (except for Shift); useful for shortcut (accelerator) key handling.
100         // Otherwise, same as text().
101         String unmodifiedText() const { return m_unmodifiedText; }
102
103         // Most compatible Windows virtual key code associated with the event.
104         // Zero for Char events.
105         int windowsVirtualKeyCode() const { return m_windowsVirtualKeyCode; }
106         void setWindowsVirtualKeyCode(int code) { m_windowsVirtualKeyCode = code; }
107
108         String keyIdentifier() const { return m_keyIdentifier; }
109         bool isAutoRepeat() const { return m_autoRepeat; }
110         void setIsAutoRepeat(bool in) { m_autoRepeat = in; }
111         bool isKeypad() const { return m_isKeypad; }
112         bool shiftKey() const { return m_shiftKey; }
113         bool ctrlKey() const { return m_ctrlKey; }
114         bool altKey() const { return m_altKey; }
115         bool metaKey() const { return m_metaKey; }
116         unsigned modifiers() const {
117             return (altKey() ? AltKey : 0)
118                 | (ctrlKey() ? CtrlKey : 0)
119                 | (metaKey() ? MetaKey : 0)
120                 | (shiftKey() ? ShiftKey : 0);
121         }
122
123         static bool currentCapsLockState();
124
125 #if PLATFORM(MAC)
126         PlatformKeyboardEvent(NSEvent*);
127         NSEvent* macEvent() const { return m_macEvent.get(); }
128 #endif
129
130 #if PLATFORM(WIN)
131         PlatformKeyboardEvent(HWND, WPARAM, LPARAM, Type, bool);
132         bool isSystemKey() const { return m_isSystemKey; }
133 #endif
134
135 #if PLATFORM(GTK)
136         PlatformKeyboardEvent(GdkEventKey*);
137         GdkEventKey* gdkEventKey() const;
138 #endif
139
140 #if PLATFORM(QT)
141         PlatformKeyboardEvent(QKeyEvent*);
142 #endif
143
144 #if PLATFORM(WX)
145         PlatformKeyboardEvent(wxKeyEvent&);
146 #endif
147
148     private:
149         Type m_type;
150         String m_text;
151         String m_unmodifiedText;
152         String m_keyIdentifier;
153         bool m_autoRepeat;
154         int m_windowsVirtualKeyCode;
155         bool m_isKeypad;
156         bool m_shiftKey;
157         bool m_ctrlKey;
158         bool m_altKey;
159         bool m_metaKey;
160
161 #if PLATFORM(MAC)
162         RetainPtr<NSEvent> m_macEvent;
163 #endif
164 #if PLATFORM(WIN)
165         bool m_isSystemKey;
166 #endif
167 #if PLATFORM(GTK)
168         GdkEventKey* m_gdkEventKey;
169 #endif
170     };
171
172 } // namespace WebCore
173
174 #endif // PlatformKeyboardEvent_h