8b3461f16c93b1d0b031d6bf423fff87e3de2b6b
[WebKit-https.git] / Source / WebCore / dom / PopStateEvent.h
1 /*
2  * Copyright (C) 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 COMPUTER, 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
27 #ifndef PopStateEvent_h
28 #define PopStateEvent_h
29
30 #include "Event.h"
31 #include "ScriptValue.h"
32 #include "SerializedScriptValue.h"
33
34 namespace WebCore {
35
36 struct PopStateEventInit : public EventInit {
37     PopStateEventInit();
38
39     ScriptValue state;
40 };
41
42 class PopStateEvent : public Event {
43 public:
44     virtual ~PopStateEvent();
45     static PassRefPtr<PopStateEvent> create();
46     static PassRefPtr<PopStateEvent> create(const ScriptValue&);
47     static PassRefPtr<PopStateEvent> create(PassRefPtr<SerializedScriptValue>);
48     static PassRefPtr<PopStateEvent> create(const AtomicString&, const PopStateEventInit&);
49     void initPopStateEvent(const AtomicString& type, bool canBubble, bool cancelable, const ScriptValue&);
50
51     SerializedScriptValue* serializedState() const { return m_serializedState.get(); }
52     ScriptValue state() const { return m_state; }
53
54     virtual const AtomicString& interfaceName() const;
55
56 private:
57     PopStateEvent();
58     PopStateEvent(const AtomicString&, const PopStateEventInit&);
59     explicit PopStateEvent(const ScriptValue&);
60     explicit PopStateEvent(PassRefPtr<SerializedScriptValue>);
61
62     ScriptValue m_state;
63     RefPtr<SerializedScriptValue> m_serializedState;
64 };
65
66 } // namespace WebCore
67
68 #endif // PopStateEvent_h