a8fc1433525832ad73cab7813ca7e162433e2f0c
[WebKit-https.git] / Source / WebCore / dom / UIEventWithKeyState.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 #pragma once
25
26 #include "EventModifierInit.h"
27 #include "PlatformEvent.h"
28 #include "UIEvent.h"
29
30 namespace WebCore {
31
32 class UIEventWithKeyState : public UIEvent {
33 public:
34     using Modifier = PlatformEvent::Modifier;
35
36     bool ctrlKey() const { return m_modifiers.contains(Modifier::ControlKey); }
37     bool shiftKey() const { return m_modifiers.contains(Modifier::ShiftKey); }
38     bool altKey() const { return m_modifiers.contains(Modifier::AltKey); }
39     bool metaKey() const { return m_modifiers.contains(Modifier::MetaKey); }
40     bool altGraphKey() const { return m_modifiers.contains(Modifier::AltGraphKey); }
41     bool capsLockKey() const { return m_modifiers.contains(Modifier::CapsLockKey); }
42
43     OptionSet<Modifier> modifierKeys() const { return m_modifiers; }
44
45     WEBCORE_EXPORT bool getModifierState(const String& keyIdentifier) const;
46
47 protected:
48     UIEventWithKeyState() = default;
49
50     UIEventWithKeyState(const AtomString& type, CanBubble canBubble, IsCancelable cancelable, IsComposed isComposed,
51         RefPtr<WindowProxy>&& view, int detail, OptionSet<Modifier> modifiers)
52         : UIEvent(type, canBubble, cancelable, isComposed, WTFMove(view), detail)
53         , m_modifiers(modifiers)
54     {
55     }
56
57     UIEventWithKeyState(const AtomString& type, CanBubble canBubble, IsCancelable cancelable, IsComposed isComposed,
58         MonotonicTime timestamp, RefPtr<WindowProxy>&& view, int detail, OptionSet<Modifier> modifiers, IsTrusted isTrusted)
59         : UIEvent(type, canBubble, cancelable, isComposed, timestamp, WTFMove(view), detail, isTrusted)
60         , m_modifiers(modifiers)
61     {
62     }
63
64     UIEventWithKeyState(const AtomString& type, const EventModifierInit& initializer)
65         : UIEvent(type, initializer)
66         , m_modifiers(modifiersFromInitializer(initializer))
67     {
68     }
69
70     void setModifierKeys(bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, bool altGraphKey = false);
71
72 private:
73     OptionSet<Modifier> m_modifiers;
74
75     static OptionSet<Modifier> modifiersFromInitializer(const EventModifierInit& initializer);
76 };
77
78 UIEventWithKeyState* findEventWithKeyState(Event*);
79
80 } // namespace WebCore