1 /* 2 * Copyright (C) 2009 Google 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 are 6 * met: 7 * 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above 11 * copyright notice, this list of conditions and the following disclaimer 12 * in the documentation and/or other materials provided with the 13 * distribution. 14 * * Neither the name of Google Inc. nor the names of its 15 * contributors may be used to endorse or promote products derived from 16 * this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 #ifndef WebHistoryItem_h 32 #define WebHistoryItem_h 33 34 #include "WebCommon.h" 35 #include "WebPrivatePtr.h" 36 37 namespace WebCore { class HistoryItem; } 38 39 namespace WebKit { 40 class WebHTTPBody; 41 class WebString; 42 class WebSerializedScriptValue; 43 struct WebPoint; 44 template <typename T> class WebVector; 45 46 // Represents a frame-level navigation entry in session history. A 47 // WebHistoryItem is a node in a tree. 48 // 49 // Copying a WebHistoryItem is cheap. 50 // 51 class WebHistoryItem { 52 public: ~WebHistoryItem()53 ~WebHistoryItem() { reset(); } 54 WebHistoryItem()55 WebHistoryItem() { } WebHistoryItem(const WebHistoryItem & h)56 WebHistoryItem(const WebHistoryItem& h) { assign(h); } 57 WebHistoryItem& operator=(const WebHistoryItem& h) 58 { 59 assign(h); 60 return *this; 61 } 62 63 WEBKIT_API void initialize(); 64 WEBKIT_API void reset(); 65 WEBKIT_API void assign(const WebHistoryItem&); 66 isNull()67 bool isNull() const { return m_private.isNull(); } 68 69 WEBKIT_API WebString urlString() const; 70 WEBKIT_API void setURLString(const WebString&); 71 72 WEBKIT_API WebString originalURLString() const; 73 WEBKIT_API void setOriginalURLString(const WebString&); 74 75 WEBKIT_API WebString referrer() const; 76 WEBKIT_API void setReferrer(const WebString&); 77 78 WEBKIT_API WebString target() const; 79 WEBKIT_API void setTarget(const WebString&); 80 81 WEBKIT_API WebString parent() const; 82 WEBKIT_API void setParent(const WebString&); 83 84 WEBKIT_API WebString title() const; 85 WEBKIT_API void setTitle(const WebString&); 86 87 WEBKIT_API WebString alternateTitle() const; 88 WEBKIT_API void setAlternateTitle(const WebString&); 89 90 WEBKIT_API double lastVisitedTime() const; 91 WEBKIT_API void setLastVisitedTime(double); 92 93 WEBKIT_API WebPoint scrollOffset() const; 94 WEBKIT_API void setScrollOffset(const WebPoint&); 95 96 WEBKIT_API bool isTargetItem() const; 97 WEBKIT_API void setIsTargetItem(bool); 98 99 WEBKIT_API int visitCount() const; 100 WEBKIT_API void setVisitCount(int); 101 102 WEBKIT_API WebVector<WebString> documentState() const; 103 WEBKIT_API void setDocumentState(const WebVector<WebString>&); 104 105 WEBKIT_API long long itemSequenceNumber() const; 106 WEBKIT_API void setItemSequenceNumber(long long); 107 108 WEBKIT_API long long documentSequenceNumber() const; 109 WEBKIT_API void setDocumentSequenceNumber(long long); 110 111 WEBKIT_API WebSerializedScriptValue stateObject() const; 112 WEBKIT_API void setStateObject(const WebSerializedScriptValue&); 113 114 WEBKIT_API WebString httpContentType() const; 115 WEBKIT_API void setHTTPContentType(const WebString&); 116 117 WEBKIT_API WebHTTPBody httpBody() const; 118 WEBKIT_API void setHTTPBody(const WebHTTPBody&); 119 120 WEBKIT_API WebVector<WebHistoryItem> children() const; 121 WEBKIT_API void setChildren(const WebVector<WebHistoryItem>&); 122 WEBKIT_API void appendToChildren(const WebHistoryItem&); 123 124 #if WEBKIT_IMPLEMENTATION 125 WebHistoryItem(const WTF::PassRefPtr<WebCore::HistoryItem>&); 126 WebHistoryItem& operator=(const WTF::PassRefPtr<WebCore::HistoryItem>&); 127 operator WTF::PassRefPtr<WebCore::HistoryItem>() const; 128 #endif 129 130 private: 131 void ensureMutable(); 132 WebPrivatePtr<WebCore::HistoryItem> m_private; 133 }; 134 135 } // namespace WebKit 136 137 #endif 138