summaryrefslogtreecommitdiffstats
path: root/Source/WebKit2/UIProcess/WebBackForwardList.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/WebKit2/UIProcess/WebBackForwardList.h')
-rw-r--r--Source/WebKit2/UIProcess/WebBackForwardList.h100
1 files changed, 100 insertions, 0 deletions
diff --git a/Source/WebKit2/UIProcess/WebBackForwardList.h b/Source/WebKit2/UIProcess/WebBackForwardList.h
new file mode 100644
index 0000000..f51ab26
--- /dev/null
+++ b/Source/WebKit2/UIProcess/WebBackForwardList.h
@@ -0,0 +1,100 @@
+/*
+ * Copyright (C) 2010, 2011 Apple 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:
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS 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 APPLE INC. OR ITS 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 WebBackForwardList_h
+#define WebBackForwardList_h
+
+#include "APIObject.h"
+#include "ImmutableArray.h"
+#include "WebBackForwardListItem.h"
+#include "WebPageProxy.h"
+#include <wtf/PassRefPtr.h>
+#include <wtf/RefPtr.h>
+#include <wtf/Vector.h>
+#if PLATFORM(CF)
+#include <CoreFoundation/CFDictionary.h>
+#endif
+
+namespace WebKit {
+
+typedef Vector<RefPtr<WebBackForwardListItem> > BackForwardListItemVector;
+
+/*
+ * Current
+ * |---------*--------------| Entries
+ * Back Forward
+ */
+
+class WebBackForwardList : public APIObject {
+public:
+ static const Type APIType = TypeBackForwardList;
+
+ static PassRefPtr<WebBackForwardList> create(WebPageProxy* page)
+ {
+ return adoptRef(new WebBackForwardList(page));
+ }
+ void pageClosed();
+
+ virtual ~WebBackForwardList();
+
+ void addItem(WebBackForwardListItem*);
+ void goToItem(WebBackForwardListItem*);
+ void clear();
+
+ WebBackForwardListItem* currentItem();
+ WebBackForwardListItem* backItem();
+ WebBackForwardListItem* forwardItem();
+ WebBackForwardListItem* itemAtIndex(int);
+
+ const BackForwardListItemVector& entries() const { return m_entries; }
+
+ uint32_t currentIndex() { return m_current; }
+ int backListCount();
+ int forwardListCount();
+
+ PassRefPtr<ImmutableArray> backListAsImmutableArrayWithLimit(unsigned limit);
+ PassRefPtr<ImmutableArray> forwardListAsImmutableArrayWithLimit(unsigned limit);
+
+#if PLATFORM(CF)
+ CFDictionaryRef createCFDictionaryRepresentation(WebPageProxy::WebPageProxySessionStateFilterCallback, void* context) const;
+ bool restoreFromCFDictionaryRepresentation(CFDictionaryRef);
+#endif
+
+private:
+ WebBackForwardList(WebPageProxy*);
+
+ virtual Type type() const { return APIType; }
+
+ WebPageProxy* m_page;
+ BackForwardListItemVector m_entries;
+ uint32_t m_current;
+ uint32_t m_capacity;
+ bool m_closed;
+ bool m_enabled;
+};
+
+} // namespace WebKit
+
+#endif // WebBackForwardList_h