WebCore:
[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 MouseEvent_h
27 #define MouseEvent_h
28
29 #include "IntPoint.h"
30
31 #if __APPLE__
32 #ifdef __OBJC__
33 @class NSEvent;
34 #else
35 class NSEvent;
36 #endif
37 #endif
38
39 #if WIN32
40 typedef struct HWND__* HWND;
41 typedef unsigned WPARAM;
42 typedef long LPARAM;
43 #endif
44
45 namespace WebCore {
46
47     // These button numbers match the one used in the DOM API.
48     enum MouseButton { LeftButton, MiddleButton, RightButton };
49
50     class PlatformMouseEvent {
51     public:
52         PlatformMouseEvent(); // "current event"
53         PlatformMouseEvent(const IntPoint& pos, const IntPoint& globalPos, MouseButton button,
54                 int clickCount, bool shift, bool ctrl, bool alt, bool meta)
55             : m_position(pos), m_globalPosition(globalPos), m_button(button)
56             , m_clickCount(clickCount)
57             , m_shiftKey(shift), m_ctrlKey(ctrl), m_altKey(alt), m_metaKey(meta)
58             { }
59
60         const IntPoint& pos() const { return m_position; }
61         int x() const { return m_position.x(); }
62         int y() const { return m_position.y(); }
63         int globalX() const { return m_globalPosition.x(); }
64         int globalY() const { return m_globalPosition.y(); }
65         MouseButton button() const { return m_button; }
66         int clickCount() const { return m_clickCount; }
67         bool shiftKey() const { return m_shiftKey; }
68         bool ctrlKey() const { return m_ctrlKey; }
69         bool altKey() const { return m_altKey; }
70         bool metaKey() const { return m_metaKey; }
71
72 #if __APPLE__
73         PlatformMouseEvent(NSEvent*);
74 #endif
75 #if WIN32
76         PlatformMouseEvent(HWND, WPARAM, LPARAM, int clickCount);
77 #endif
78
79     private:
80         IntPoint m_position;
81         IntPoint m_globalPosition;
82         MouseButton m_button;
83         int m_clickCount;
84         bool m_shiftKey;
85         bool m_ctrlKey;
86         bool m_altKey;
87         bool m_metaKey;
88     };
89
90 }
91
92 #endif