1/*
2 * Copyright (C) 2010 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. AND ITS CONTRIBUTORS ``AS IS''
14 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23 * THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#pragma once
27
28#include <wtf/Noncopyable.h>
29#include <wtf/Forward.h>
30#include <wtf/RefPtr.h>
31
32namespace WebCore {
33
34class BackForwardClient;
35class HistoryItem;
36class Page;
37
38class BackForwardController {
39 WTF_MAKE_NONCOPYABLE(BackForwardController); WTF_MAKE_FAST_ALLOCATED;
40public:
41 BackForwardController(Page&, Ref<BackForwardClient>&&);
42 ~BackForwardController();
43
44 BackForwardClient& client() { return m_client.get(); }
45 const BackForwardClient& client() const { return m_client.get(); }
46
47 WEBCORE_EXPORT bool canGoBackOrForward(int distance) const;
48 void goBackOrForward(int distance);
49
50 WEBCORE_EXPORT bool goBack();
51 WEBCORE_EXPORT bool goForward();
52
53 void addItem(Ref<HistoryItem>&&);
54 void setCurrentItem(HistoryItem&);
55
56 unsigned count() const;
57 WEBCORE_EXPORT unsigned backCount() const;
58 WEBCORE_EXPORT unsigned forwardCount() const;
59
60 WEBCORE_EXPORT RefPtr<HistoryItem> itemAtIndex(int);
61
62 void close();
63
64 WEBCORE_EXPORT RefPtr<HistoryItem> backItem();
65 WEBCORE_EXPORT RefPtr<HistoryItem> currentItem();
66 WEBCORE_EXPORT RefPtr<HistoryItem> forwardItem();
67
68private:
69 Page& m_page;
70 Ref<BackForwardClient> m_client;
71};
72
73} // namespace WebCore
74