summaryrefslogtreecommitdiffstats
path: root/webkit/api/public/WebHistoryItem.h
blob: 49ee18c8977033e0eeb1855b63a461b8d42c8986 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/*
 * Copyright (C) 2009 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef WebHistoryItem_h
#define WebHistoryItem_h

#include "WebCommon.h"

#if WEBKIT_IMPLEMENTATION
namespace WebCore { class HistoryItem; }
namespace WTF { template <typename T> class PassRefPtr; }
#endif

namespace WebKit {
    class WebHistoryItemPrivate;
    class WebHTTPBody;
    class WebString;
    struct WebPoint;
    template <typename T> class WebVector;

    // Represents a frame-level navigation entry in session history.  A
    // WebHistoryItem is a node in a tree.
    //
    // Copying a WebHistoryItem is cheap.
    //
    class WebHistoryItem {
    public:
        ~WebHistoryItem() { reset(); }

        WebHistoryItem() : m_private(0) { }
        WebHistoryItem(const WebHistoryItem& h) : m_private(0) { assign(h); }
        WebHistoryItem& operator=(const WebHistoryItem& h) { assign(h); return *this; }

        WEBKIT_API void initialize();
        WEBKIT_API void reset();
        WEBKIT_API void assign(const WebHistoryItem&);

        bool isNull() const { return m_private == 0; }

        WEBKIT_API WebString urlString() const;
        WEBKIT_API void setURLString(const WebString&);

        WEBKIT_API WebString originalURLString() const;
        WEBKIT_API void setOriginalURLString(const WebString&);

        WEBKIT_API WebString referrer() const;
        WEBKIT_API void setReferrer(const WebString&);

        WEBKIT_API WebString target() const;
        WEBKIT_API void setTarget(const WebString&);

        WEBKIT_API WebString parent() const;
        WEBKIT_API void setParent(const WebString&);

        WEBKIT_API WebString title() const;
        WEBKIT_API void setTitle(const WebString&);

        WEBKIT_API WebString alternateTitle() const;
        WEBKIT_API void setAlternateTitle(const WebString&);

        WEBKIT_API double lastVisitedTime() const;
        WEBKIT_API void setLastVisitedTime(double);

        WEBKIT_API WebPoint scrollOffset() const;
        WEBKIT_API void setScrollOffset(const WebPoint&);

        WEBKIT_API bool isTargetItem() const;
        WEBKIT_API void setIsTargetItem(bool);

        WEBKIT_API int visitCount() const;
        WEBKIT_API void setVisitCount(int);

        WEBKIT_API WebVector<WebString> documentState() const;
        WEBKIT_API void setDocumentState(const WebVector<WebString>&);

        WEBKIT_API WebString httpContentType() const;
        WEBKIT_API void setHTTPContentType(const WebString&);

        WEBKIT_API WebHTTPBody httpBody() const;
        WEBKIT_API void setHTTPBody(const WebHTTPBody&);

        WEBKIT_API WebVector<WebHistoryItem> children() const;
        WEBKIT_API void setChildren(const WebVector<WebHistoryItem>&);
        WEBKIT_API void appendToChildren(const WebHistoryItem&);

#if WEBKIT_IMPLEMENTATION
        WebHistoryItem(const WTF::PassRefPtr<WebCore::HistoryItem>&);
        WebHistoryItem& operator=(const WTF::PassRefPtr<WebCore::HistoryItem>&);
        operator WTF::PassRefPtr<WebCore::HistoryItem>() const;
#endif

    private:
        void assign(WebHistoryItemPrivate*);
        void ensureMutable();
        WebHistoryItemPrivate* m_private;
    };

} // namespace WebKit

#endif