1/*
2 * Copyright (C) 2006, 2010 Apple Inc. All rights reserved.
3 * Copyright (C) 2008 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
4 * Copyright (C) 2009 Google, Inc. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
16 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
19 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28#ifndef BackForwardClient_h
29#define BackForwardClient_h
30
31#include <wtf/Forward.h>
32#include <wtf/RefCounted.h>
33
34namespace WebCore {
35
36class HistoryItem;
37
38class BackForwardClient : public RefCounted<BackForwardClient> {
39public:
40    virtual ~BackForwardClient()
41    {
42    }
43
44    virtual void addItem(PassRefPtr<HistoryItem>) = 0;
45
46    virtual void goToItem(HistoryItem*) = 0;
47
48    virtual HistoryItem* itemAtIndex(int) = 0;
49    virtual int backListCount() = 0;
50    virtual int forwardListCount() = 0;
51
52    virtual void close() = 0;
53
54#if PLATFORM(IOS)
55    // FIXME: These methods seem to violate the encapsulation of this class.
56    virtual unsigned current() = 0;
57    virtual void setCurrent(unsigned newCurrent) = 0;
58
59    // FIXME: Consider renaming this method once we upstream the iOS changes to WebView.mm.
60    virtual bool clearAllPageCaches() = 0;
61#endif
62
63    // FIXME: Delete these once all callers are using BackForwardController
64    // instead of calling this directly.
65    HistoryItem* backItem() { return itemAtIndex(-1); }
66    HistoryItem* currentItem() { return itemAtIndex(0); }
67    HistoryItem* forwardItem() { return itemAtIndex(1); }
68};
69
70} // namespace WebCore
71
72#endif // BackForwardClient_h
73