c2b32c63dc1dad13edc3d6d2b14582ba55fd5bdd
[WebKit-https.git] / Source / WebCore / storage / StorageEvent.h
1 /*
2  * Copyright (C) 2008, 2009 Apple 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 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 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 #pragma once
27
28 #include "Event.h"
29 #include <wtf/text/WTFString.h>
30
31 namespace WebCore {
32
33 class Storage;
34
35 class StorageEvent : public Event {
36 public:
37     static Ref<StorageEvent> create(const AtomString& type, const String& key, const String& oldValue, const String& newValue, const String& url, Storage* storageArea);
38     static Ref<StorageEvent> createForBindings();
39
40     struct Init : EventInit {
41         String key;
42         String oldValue;
43         String newValue;
44         String url;
45         RefPtr<Storage> storageArea;
46     };
47
48     static Ref<StorageEvent> create(const AtomString&, const Init&, IsTrusted = IsTrusted::No);
49     virtual ~StorageEvent();
50
51     const String& key() const { return m_key; }
52     const String& oldValue() const { return m_oldValue; }
53     const String& newValue() const { return m_newValue; }
54     const String& url() const { return m_url; }
55     Storage* storageArea() const { return m_storageArea.get(); }
56
57     void initStorageEvent(const AtomString& type, bool canBubble, bool cancelable, const String& key, const String& oldValue, const String& newValue, const String& url, Storage* storageArea);
58
59     // Needed once we support init<blank>EventNS
60     // void initStorageEventNS(in DOMString namespaceURI, in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in DOMString keyArg, in DOMString oldValueArg, in DOMString newValueArg, in DOMString urlArg, Storage storageAreaArg);
61
62     EventInterface eventInterface() const override;
63
64 private:
65     StorageEvent();
66     StorageEvent(const AtomString& type, const String& key, const String& oldValue, const String& newValue, const String& url, Storage* storageArea);
67     StorageEvent(const AtomString&, const Init&, IsTrusted);
68
69     String m_key;
70     String m_oldValue;
71     String m_newValue;
72     String m_url;
73     RefPtr<Storage> m_storageArea;
74 };
75
76 } // namespace WebCore