Reviewed by Eric. Landed by rwlbuis.
[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 __APPLE__
33 #ifdef __OBJC__
34 @class NSEvent;
35 #else
36 class NSEvent;
37 #endif
38 #endif
39
40 #if PLATFORM(WIN)
41 typedef struct HWND__* HWND;
42 typedef unsigned WPARAM;
43 typedef long LPARAM;
44 #endif
45
46 #if PLATFORM(GDK)
47 typedef union _GdkEvent GdkEvent;
48 #endif
49
50 #if PLATFORM(QT)
51 class QMouseEvent;
52 #endif
53
54 namespace WebCore {
55
56     // These button numbers match the one used in the DOM API.
57     enum MouseButton { LeftButton, MiddleButton, RightButton };
58
59     class PlatformMouseEvent {
60     public:
61         static const struct CurrentEventTag {} currentEvent;
62     
63         PlatformMouseEvent()
64             : m_button(LeftButton)
65             , m_clickCount(0)
66             , m_shiftKey(false)
67             , m_ctrlKey(false)
68             , m_altKey(false)
69             , m_metaKey(false)
70         {
71         }
72
73         PlatformMouseEvent(const CurrentEventTag&);
74
75         PlatformMouseEvent(const IntPoint& pos, const IntPoint& globalPos, MouseButton button,
76                            int clickCount, bool shift, bool ctrl, bool alt, bool meta)
77             : m_position(pos), m_globalPosition(globalPos), m_button(button)
78             , m_clickCount(clickCount)
79             , m_shiftKey(shift)
80             , m_ctrlKey(ctrl)
81             , m_altKey(alt)
82             , m_metaKey(meta)
83         {
84         }
85
86         const IntPoint& pos() const { return m_position; }
87         int x() const { return m_position.x(); }
88         int y() const { return m_position.y(); }
89         int globalX() const { return m_globalPosition.x(); }
90         int globalY() const { return m_globalPosition.y(); }
91         MouseButton button() const { return m_button; }
92         int clickCount() const { return m_clickCount; }
93         bool shiftKey() const { return m_shiftKey; }
94         bool ctrlKey() const { return m_ctrlKey; }
95         bool altKey() const { return m_altKey; }
96         bool metaKey() const { return m_metaKey; }
97
98 #if __APPLE__
99         PlatformMouseEvent(NSEvent*);
100 #endif
101 #if PLATFORM(WIN)
102         PlatformMouseEvent(HWND, WPARAM, LPARAM, int clickCount);
103 #endif
104 #if PLATFORM(GDK) 
105         PlatformMouseEvent(GdkEvent*);
106 #endif
107 #if PLATFORM(QT)
108         PlatformMouseEvent(QMouseEvent*, int clickCount);
109 #endif
110
111     private:
112         IntPoint m_position;
113         IntPoint m_globalPosition;
114         MouseButton m_button;
115         int m_clickCount;
116         bool m_shiftKey;
117         bool m_ctrlKey;
118         bool m_altKey;
119         bool m_metaKey;
120     };
121
122 } // namespace WebCore
123
124 #endif // PlatformMouseEvent_h