Reviewed by Eric. Landed by rwlbuis.
[WebKit-https.git] / WebCore / platform / PlatformKeyboardEvent.h
1 /*
2  * Copyright (C) 2004, 2005, 2006 Apple Computer, Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef PlatformKeyboardEvent_h
27 #define PlatformKeyboardEvent_h
28
29 #include "PlatformString.h"
30 #include <wtf/Platform.h>
31
32 #ifdef __OBJC__
33 @class NSEvent;
34 #else
35 class NSEvent;
36 #endif
37
38 #if PLATFORM(WIN)
39 typedef struct HWND__ *HWND;
40 typedef unsigned    WPARAM;
41 typedef long        LPARAM;
42 #endif
43
44 #if PLATFORM(GDK)
45 typedef union _GdkEvent GdkEvent;
46 #endif
47
48 #if PLATFORM(QT)
49 class QKeyEvent;
50 #endif
51
52 namespace WebCore {
53
54     class PlatformKeyboardEvent {
55     public:
56         String text() const { return m_text; }
57         String unmodifiedText() const { return m_unmodifiedText; }
58         String keyIdentifier() const { return m_keyIdentifier; }
59         bool isKeyUp() const { return m_isKeyUp; }
60         bool isAutoRepeat() const { return m_autoRepeat; }
61         int WindowsKeyCode() const { return m_WindowsKeyCode; }
62         bool isKeypad() const { return m_isKeypad; }
63         bool shiftKey() const { return m_shiftKey; }
64         bool ctrlKey() const { return m_ctrlKey; }
65         bool altKey() const { return m_altKey; }
66         bool metaKey() const { return m_metaKey; }
67
68 #ifdef __APPLE__
69         PlatformKeyboardEvent(NSEvent*, bool forceAutoRepeat = false);
70 #endif
71
72 #if PLATFORM(WIN)
73         PlatformKeyboardEvent(HWND, WPARAM, LPARAM);
74 #endif
75
76 #if PLATFORM(GDK)
77         PlatformKeyboardEvent(GdkEvent*);
78 #endif
79
80 #if PLATFORM(QT)
81         PlatformKeyboardEvent(QKeyEvent*, bool isKeyUp);
82 #endif
83
84     private:
85         String m_text;
86         String m_unmodifiedText;
87         String m_keyIdentifier;
88         bool m_isKeyUp;
89         bool m_autoRepeat;
90         int m_WindowsKeyCode;
91         bool m_isKeypad;
92         bool m_shiftKey;
93         bool m_ctrlKey;
94         bool m_altKey;
95         bool m_metaKey;
96     };
97
98 } // namespace WebCore
99
100 #endif // PlatformKeyboardEvent_h