Home | History | Annotate | Download | only in page 
      1 /*
      2  * Copyright (C) 2007 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 COMPUTER, INC. ``AS IS'' AND ANY
     14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
     17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
     20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
     21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     24  */
     25 
     26 #ifndef History_h
     27 #define History_h
     28 
     29 #include "KURL.h"
     30 #include <wtf/Forward.h>
     31 #include <wtf/PassRefPtr.h>
     32 #include <wtf/RefCounted.h>
     33 
     34 namespace WebCore {
     35 
     36 class Frame;
     37 class ScriptExecutionContext;
     38 class SerializedScriptValue;
     39 typedef int ExceptionCode;
     40 
     41 class History : public RefCounted<History> {
     42 public:
     43     static PassRefPtr<History> create(Frame* frame) { return adoptRef(new History(frame)); }
     44 
     45     Frame* frame() const;
     46     void disconnectFrame();
     47 
     48     unsigned length() const;
     49     void back();
     50     void forward();
     51     void go(int distance);
     52 
     53     void back(ScriptExecutionContext*);
     54     void forward(ScriptExecutionContext*);
     55     void go(ScriptExecutionContext*, int distance);
     56 
     57     enum StateObjectType {
     58         StateObjectPush,
     59         StateObjectReplace
     60     };
     61     void stateObjectAdded(PassRefPtr<SerializedScriptValue>, const String& title, const String& url, StateObjectType, ExceptionCode&);
     62 
     63 private:
     64     History(Frame*);
     65 
     66     KURL urlForState(const String& url);
     67 
     68     Frame* m_frame;
     69 };
     70 
     71 } // namespace WebCore
     72 
     73 #endif // History_h
     74