e78d50e677e777fe15ca5398426874139d7a61af
[WebKit-https.git] / Source / WebCore / dom / CustomEvent.h
1 /*
2  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
3  * Copyright (C) 2011-2018 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #pragma once
28
29 #include "Event.h"
30 #include "JSValueInWrappedObject.h"
31 #include "SerializedScriptValue.h"
32
33 namespace WebCore {
34
35 class CustomEvent final : public Event {
36 public:
37     virtual ~CustomEvent();
38
39     static Ref<CustomEvent> create(IsTrusted = IsTrusted::No);
40
41     struct Init : EventInit {
42         JSC::JSValue detail;
43     };
44
45     static Ref<CustomEvent> create(const AtomString& type, const Init&, IsTrusted = IsTrusted::No);
46
47     void initCustomEvent(const AtomString& type, bool canBubble, bool cancelable, JSC::JSValue detail = JSC::JSValue::JSUndefined);
48
49     const JSValueInWrappedObject& detail() const { return m_detail; }
50     JSValueInWrappedObject& cachedDetail() { return m_cachedDetail; }
51
52 private:
53     CustomEvent(IsTrusted);
54     CustomEvent(const AtomString& type, const Init& initializer, IsTrusted);
55
56     EventInterface eventInterface() const final;
57
58     JSValueInWrappedObject m_detail;
59     JSValueInWrappedObject m_cachedDetail;
60 };
61
62 } // namespace WebCore