src/third_party/WebKit/Source/core/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 #include "core/events/Event.h"
  30 #include "heap/Handle.h"
  31 #include "wtf/text/WTFString.h"
  32
  33 namespace WebCore {
  34
  35 class Storage;
  36
  37 struct StorageEventInit : public EventInit {
  38     // FIXME: oilpan: Replace this with STACK_ALLOCATED.
  39     DISALLOW_ALLOCATION();
  40 public:
  41     StorageEventInit();
  42
  43     String key;
  44     String oldValue;
  45     String newValue;
  46     String url;
  47     RefPtrWillBeRawPtr<Storage> storageArea;
  48 };
  49
  50 class StorageEvent FINAL : public Event {
  51 public:
  52     static PassRefPtr<StorageEvent> create();
  53     static PassRefPtr<StorageEvent> create(const AtomicString& type, const String& key, const String& oldValue, const String& newValue, const String& url, Storage* storageArea);
  54     static PassRefPtr<StorageEvent> create(const AtomicString&, const StorageEventInit&);
  55     virtual ~StorageEvent();
  56
  57     const String& key() const { return m_key; }
  58     const String& oldValue() const { return m_oldValue; }
  59     const String& newValue() const { return m_newValue; }
  60     const String& url() const { return m_url; }
  61     Storage* storageArea() const { return m_storageArea.get(); }
  62     Storage* storageArea(bool& isNull) const { isNull = !m_storageArea; return m_storageArea.get(); }
  63
  64     void initStorageEvent(const AtomicString& type, bool canBubble, bool cancelable, const String& key, const String& oldValue, const String& newValue, const String& url, Storage* storageArea);
  65
  66     // Needed once we support init<blank>EventNS
  67     // 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);
  68
  69     virtual const AtomicString& interfaceName() const OVERRIDE;
  70
  71 private:
  72     StorageEvent();
  73     StorageEvent(const AtomicString& type, const String& key, const String& oldValue, const String& newValue, const String& url, Storage* storageArea);
  74     StorageEvent(const AtomicString&, const StorageEventInit&);
  75
  76     String m_key;
  77     String m_oldValue;
  78     String m_newValue;
  79     String m_url;
  80     RefPtrWillBePersistent<Storage> m_storageArea;
  81 };
  82
  83 } // namespace WebCore
  84
  85 #endif // StorageEvent_h