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 "../platform/WebCommon.h" 35 #include "../platform/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: 53 ~WebHistoryItem() { reset(); } 54 55 WebHistoryItem() { } 56 WebHistoryItem(const WebHistoryItem& h) { assign(h); } 57 WebHistoryItem& operator=(const WebHistoryItem& h) 58 { 59 assign(h); 60 return *this; 61 } 62 63 WEBKIT_EXPORT void initialize(); 64 WEBKIT_EXPORT void reset(); 65 WEBKIT_EXPORT void assign(const WebHistoryItem&); 66 67 bool isNull() const { return m_private.isNull(); } 68 69 WEBKIT_EXPORT WebString urlString() const; 70 WEBKIT_EXPORT void setURLString(const WebString&); 71 72 WEBKIT_EXPORT WebString originalURLString() const; 73 WEBKIT_EXPORT void setOriginalURLString(const WebString&); 74 75 WEBKIT_EXPORT WebString referrer() const; 76 WEBKIT_EXPORT void setReferrer(const WebString&); 77 78 WEBKIT_EXPORT WebString target() const; 79 WEBKIT_EXPORT void setTarget(const WebString&); 80 81 WEBKIT_EXPORT WebString parent() const; 82 WEBKIT_EXPORT void setParent(const WebString&); 83 84 WEBKIT_EXPORT WebString title() const; 85 WEBKIT_EXPORT void setTitle(const WebString&); 86 87 WEBKIT_EXPORT WebString alternateTitle() const; 88 WEBKIT_EXPORT void setAlternateTitle(const WebString&); 89 90 WEBKIT_EXPORT double lastVisitedTime() const; 91 WEBKIT_EXPORT void setLastVisitedTime(double); 92 93 WEBKIT_EXPORT WebPoint scrollOffset() const; 94 WEBKIT_EXPORT void setScrollOffset(const WebPoint&); 95 96 WEBKIT_EXPORT float pageScaleFactor() const; 97 WEBKIT_EXPORT void setPageScaleFactor(float); 98 99 WEBKIT_EXPORT bool isTargetItem() const; 100 WEBKIT_EXPORT void setIsTargetItem(bool); 101 102 WEBKIT_EXPORT int visitCount() const; 103 WEBKIT_EXPORT void setVisitCount(int); 104 105 WEBKIT_EXPORT WebVector<WebString> documentState() const; 106 WEBKIT_EXPORT void setDocumentState(const WebVector<WebString>&); 107 108 WEBKIT_EXPORT long long itemSequenceNumber() const; 109 WEBKIT_EXPORT void setItemSequenceNumber(long long); 110 111 WEBKIT_EXPORT long long documentSequenceNumber() const; 112 WEBKIT_EXPORT void setDocumentSequenceNumber(long long); 113 114 WEBKIT_EXPORT WebSerializedScriptValue stateObject() const; 115 WEBKIT_EXPORT void setStateObject(const WebSerializedScriptValue&); 116 117 WEBKIT_EXPORT WebString httpContentType() const; 118 WEBKIT_EXPORT void setHTTPContentType(const WebString&); 119 120 WEBKIT_EXPORT WebHTTPBody httpBody() const; 121 WEBKIT_EXPORT void setHTTPBody(const WebHTTPBody&); 122 123 WEBKIT_EXPORT WebVector<WebHistoryItem> children() const; 124 WEBKIT_EXPORT void setChildren(const WebVector<WebHistoryItem>&); 125 WEBKIT_EXPORT void appendToChildren(const WebHistoryItem&); 126 127 WEBKIT_EXPORT WebVector<WebString> getReferencedFilePaths() const; 128 129 #if WEBKIT_IMPLEMENTATION 130 WebHistoryItem(const WTF::PassRefPtr<WebCore::HistoryItem>&); 131 WebHistoryItem& operator=(const WTF::PassRefPtr<WebCore::HistoryItem>&); 132 operator WTF::PassRefPtr<WebCore::HistoryItem>() const; 133 #endif 134 135 private: 136 void ensureMutable(); 137 WebPrivatePtr<WebCore::HistoryItem> m_private; 138 }; 139 140 } // namespace WebKit 141 142 #endif 143
