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 COMPUTER, 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 COMPUTER, 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 BackForwardList_h
29#define BackForwardList_h
30
31#include <wtf/Forward.h>
32#include <wtf/RefCounted.h>
33
34namespace WebCore {
35
36class HistoryItem;
37
38// FIXME: Rename this class to BackForwardClient, and rename the
39// getter in Page accordingly.
40class BackForwardList : public RefCounted<BackForwardList> {
41public:
42    virtual ~BackForwardList()
43    {
44    }
45
46    virtual void addItem(PassRefPtr<HistoryItem>) = 0;
47
48    virtual void goToItem(HistoryItem*) = 0;
49
50    virtual HistoryItem* itemAtIndex(int) = 0;
51    virtual int backListCount() = 0;
52    virtual int forwardListCount() = 0;
53
54    virtual bool isActive() = 0;
55
56    virtual void close() = 0;
57
58    // FIXME: Delete these once all callers are using BackForwardController
59    // instead of calling this directly.
60    HistoryItem* backItem() { return itemAtIndex(-1); }
61    HistoryItem* currentItem() { return itemAtIndex(0); }
62    HistoryItem* forwardItem() { return itemAtIndex(1); }
63};
64
65} // namespace WebCore
66
67#endif // BackForwardList_h
68