2009-07-14 Brent Fulgham <bfulgham@webkit.org>
[WebKit-https.git] / 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 #ifndef StorageEvent_h
27 #define StorageEvent_h
28
29 #if ENABLE(DOM_STORAGE)
30
31 #include "Event.h"
32 #include "Storage.h"
33
34 namespace WebCore {
35
36     class DOMWindow;
37
38     class StorageEvent : public Event {
39     public:
40         static PassRefPtr<StorageEvent> create()
41         {
42             return adoptRef(new StorageEvent);
43         }
44         static PassRefPtr<StorageEvent> create(const AtomicString& type, const String& key, const String& oldValue, const String& newValue, const String& uri, PassRefPtr<DOMWindow> source, Storage* storageArea)
45         {
46             return adoptRef(new StorageEvent(type, key, oldValue, newValue, uri, source, storageArea));
47         }
48
49         const String& key() const { return m_key; }
50         const String& oldValue() const { return m_oldValue; }
51         const String& newValue() const { return m_newValue; }
52         const String& uri() const { return m_uri; }
53         DOMWindow* source() const { return m_source.get(); }
54         Storage* storageArea() const { return m_storageArea.get(); }
55
56         void initStorageEvent(const AtomicString& type, bool canBubble, bool cancelable, const String& key, const String& oldValue, const String& newValue, const String& uri, PassRefPtr<DOMWindow> source, Storage* storageArea);
57
58         // Needed once we support init<blank>EventNS
59         // 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 uriArg, in Window sourceArg,  Storage storageAreaArg);
60
61         virtual bool isStorageEvent() const { return true; }
62
63     private:    
64         StorageEvent() { }
65         StorageEvent(const AtomicString& type, const String& key, const String& oldValue, const String& newValue, const String& uri, PassRefPtr<DOMWindow> source, Storage* storageArea);
66         
67         String m_key;
68         String m_oldValue;
69         String m_newValue;
70         String m_uri;
71         RefPtr<DOMWindow> m_source;
72         RefPtr<Storage> m_storageArea;        
73     };
74
75 } // namespace WebCore
76
77 #endif // ENABLE(DOM_STORAGE)
78
79 #endif // StorageEvent_h