Changed to PlatformMouseEvent constructor to allow construction from a QContextMenuEvent.
[WebKit-https.git] / WebCore / platform / PlatformMouseEvent.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 PlatformMouseEvent_h
27 #define PlatformMouseEvent_h
28
29 #include "IntPoint.h"
30 #include <wtf/Platform.h>
31
32 #if PLATFORM(MAC)
33 #ifdef __OBJC__
34 @class NSEvent;
35 @class NSScreen;
36 @class NSWindow;
37 #else
38 class NSEvent;
39 class NSScreen;
40 class NSWindow;
41 #endif
42 #endif
43
44 #if PLATFORM(WIN)
45 typedef struct HWND__* HWND;
46 typedef unsigned UINT;
47 typedef unsigned WPARAM;
48 typedef long LPARAM;
49 #endif
50
51 #if PLATFORM(GTK)
52 typedef struct _GdkEventButton GdkEventButton;
53 typedef struct _GdkEventMotion GdkEventMotion;
54 #endif
55
56 #if PLATFORM(QT)
57 class QInputEvent;
58 #endif
59
60 #if PLATFORM(WX)
61 class wxMouseEvent;
62 #endif
63
64 namespace WebCore {
65     
66     // These button numbers match the ones used in the DOM API, 0 through 2, except for NoButton which isn't specified.
67     enum MouseButton { NoButton = -1, LeftButton, MiddleButton, RightButton };
68     enum MouseEventType { MouseEventMoved, MouseEventPressed, MouseEventReleased, MouseEventScroll };
69     
70     class PlatformMouseEvent {
71     public:
72         PlatformMouseEvent()
73             : m_button(NoButton)
74             , m_eventType(MouseEventMoved)
75             , m_clickCount(0)
76             , m_shiftKey(false)
77             , m_ctrlKey(false)
78             , m_altKey(false)
79             , m_metaKey(false)
80             , m_timestamp(0)
81             , m_modifierFlags(0)
82         {
83         }
84
85         PlatformMouseEvent(const IntPoint& pos, const IntPoint& globalPos, MouseButton button, MouseEventType eventType,
86                            int clickCount, bool shift, bool ctrl, bool alt, bool meta, double timestamp)
87             : m_position(pos), m_globalPosition(globalPos), m_button(button)
88             , m_eventType(eventType)
89             , m_clickCount(clickCount)
90             , m_shiftKey(shift)
91             , m_ctrlKey(ctrl)
92             , m_altKey(alt)
93             , m_metaKey(meta)
94             , m_timestamp(timestamp)
95             , m_modifierFlags(0)
96         {
97         }
98
99         const IntPoint& pos() const { return m_position; }
100         int x() const { return m_position.x(); }
101         int y() const { return m_position.y(); }
102         int globalX() const { return m_globalPosition.x(); }
103         int globalY() const { return m_globalPosition.y(); }
104         MouseButton button() const { return m_button; }
105         MouseEventType eventType() const { return m_eventType; }
106         int clickCount() const { return m_clickCount; }
107         bool shiftKey() const { return m_shiftKey; }
108         bool ctrlKey() const { return m_ctrlKey; }
109         bool altKey() const { return m_altKey; }
110         bool metaKey() const { return m_metaKey; }
111         unsigned modifierFlags() const { return m_modifierFlags; }
112         
113         //time in seconds
114         double timestamp() const { return m_timestamp; }
115
116 #if PLATFORM(MAC)
117         PlatformMouseEvent(NSEvent*);
118         int eventNumber() const { return m_eventNumber; }
119 #endif
120 #if PLATFORM(WIN)
121         PlatformMouseEvent(HWND, UINT, WPARAM, LPARAM, bool activatedWebView = false);
122         void setClickCount(int count) { m_clickCount = count; }
123         bool activatedWebView() const { return m_activatedWebView; }
124 #endif
125 #if PLATFORM(GTK) 
126         PlatformMouseEvent(GdkEventButton*);
127         PlatformMouseEvent(GdkEventMotion*);
128 #endif
129 #if PLATFORM(QT)
130         PlatformMouseEvent(QInputEvent*, int clickCount);
131 #endif
132
133 #if PLATFORM(WX)
134         PlatformMouseEvent(const wxMouseEvent&, const wxPoint& globalPoint);
135 #endif
136
137
138     private:
139         IntPoint m_position;
140         IntPoint m_globalPosition;
141         MouseButton m_button;
142         MouseEventType m_eventType;
143         int m_clickCount;
144         bool m_shiftKey;
145         bool m_ctrlKey;
146         bool m_altKey;
147         bool m_metaKey;
148         double m_timestamp; // unit: seconds
149         unsigned m_modifierFlags;
150 #if PLATFORM(MAC)
151         int m_eventNumber;
152 #endif
153 #if PLATFORM(WIN)
154         bool m_activatedWebView;
155 #endif
156     };
157
158 #if PLATFORM(MAC)
159     IntPoint globalPoint(const NSPoint& windowPoint, NSWindow *window);
160     IntPoint pointForEvent(NSEvent *event);
161     IntPoint globalPointForEvent(NSEvent *event);
162 #endif
163
164 } // namespace WebCore
165
166 #endif // PlatformMouseEvent_h