013e4273774db20be7c227d007ebf14d0374f026
[WebKit.git] / Source / WebCore / dom / UIEvent.h
1 /*
2  * Copyright (C) 2001 Peter Kelly (pmk@post.com)
3  * Copyright (C) 2001 Tobias Anton (anton@stud.fbi.fh-darmstadt.de)
4  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
5  * Copyright (C) 2003, 2004, 2005, 2006, 2008, 2013 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #ifndef UIEvent_h
25 #define UIEvent_h
26
27 #include "DOMWindow.h"
28 #include "Event.h"
29
30 namespace WebCore {
31
32 struct UIEventInit : public EventInit {
33     RefPtr<DOMWindow> view;
34     int detail { 0 };
35 };
36
37 class UIEvent : public Event {
38 public:
39     static Ref<UIEvent> create(const AtomicString& type, bool canBubble, bool cancelable, DOMWindow* view, int detail)
40     {
41         return adoptRef(*new UIEvent(type, canBubble, cancelable, view, detail));
42     }
43     static Ref<UIEvent> createForBindings()
44     {
45         return adoptRef(*new UIEvent);
46     }
47     static Ref<UIEvent> createForBindings(const AtomicString& type, const UIEventInit& initializer)
48     {
49         return adoptRef(*new UIEvent(type, initializer));
50     }
51     virtual ~UIEvent();
52
53     void initUIEvent(const AtomicString& type, bool canBubble, bool cancelable, DOMWindow*, int detail);
54
55     DOMWindow* view() const { return m_view.get(); }
56     int detail() const { return m_detail; }
57
58     EventInterface eventInterface() const override;
59
60     virtual int keyCode() const;
61     virtual int charCode() const;
62
63     virtual int layerX();
64     virtual int layerY();
65
66     virtual int pageX() const;
67     virtual int pageY() const;
68
69     virtual int which() const;
70
71 protected:
72     UIEvent();
73     UIEvent(const AtomicString& type, bool canBubble, bool cancelable, DOMWindow*, int detail);
74     UIEvent(const AtomicString& type, bool canBubble, bool cancelable, double timestamp, DOMWindow*, int detail);
75     UIEvent(const AtomicString&, const UIEventInit&);
76
77 private:
78     bool isUIEvent() const final;
79
80     RefPtr<DOMWindow> m_view;
81     int m_detail;
82 };
83
84 } // namespace WebCore
85
86 SPECIALIZE_TYPE_TRAITS_EVENT(UIEvent)
87
88 #endif // UIEvent_h