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 "PlatformString.h"
  33
  34 namespace WebCore {
  35
  36     class DOMWindow;
  37     class Storage;
  38
  39     class StorageEvent : public Event {
  40     public:
  41         static PassRefPtr<StorageEvent> create();
  42         static PassRefPtr<StorageEvent> create(const AtomicString& type, const String& key, const String& oldValue, const String& newValue, const String& uri, PassRefPtr<DOMWindow> source, Storage* storageArea);
  43
  44         const String& key() const { return m_key; }
  45         const String& oldValue() const { return m_oldValue; }
  46         const String& newValue() const { return m_newValue; }
  47         const String& uri() const { return m_uri; }
  48         DOMWindow* source() const { return m_source.get(); }
  49         Storage* storageArea() const { return m_storageArea.get(); }
  50
  51         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);
  52
  53         // Needed once we support init<blank>EventNS
  54         // 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);
  55
  56         virtual bool isStorageEvent() const { return true; }
  57
  58     private:
  59         StorageEvent();
  60         StorageEvent(const AtomicString& type, const String& key, const String& oldValue, const String& newValue, const String& uri, PassRefPtr<DOMWindow> source, Storage* storageArea);
  61
  62         String m_key;
  63         String m_oldValue;
  64         String m_newValue;
  65         String m_uri;
  66         RefPtr<DOMWindow> m_source;
  67         RefPtr<Storage> m_storageArea;
  68     };
  69
  70 } // namespace WebCore
  71
  72 #endif // ENABLE(DOM_STORAGE)
  73
  74 #endif // StorageEvent_h