Source/WebCore/history/CachedPage.h

   1 /*
   2  * Copyright (C) 2006, 2007, 2008 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 CachedPage_h
  27 #define CachedPage_h
  28
  29 #include "CachedFrame.h"
  30
  31 namespace WebCore {
  32
  33 class Document;
  34 class DocumentLoader;
  35 class Page;
  36
  37 class CachedPage : public RefCounted<CachedPage> {
  38 public:
  39     static PassRefPtr<CachedPage> create(Page*);
  40     ~CachedPage();
  41
  42     void restore(Page*);
  43     void clear();
  44     void destroy();
  45
  46     Document* document() const { return m_cachedMainFrame->document(); }
  47     DocumentLoader* documentLoader() const { return m_cachedMainFrame->documentLoader(); }
  48
  49     double timeStamp() const { return m_timeStamp; }
  50
  51     CachedFrame* cachedMainFrame() { return m_cachedMainFrame.get(); }
  52
  53 private:
  54     CachedPage(Page*);
  55
  56     double m_timeStamp;
  57     RefPtr<CachedFrame> m_cachedMainFrame;
  58 };
  59
  60 } // namespace WebCore
  61
  62 #endif // CachedPage_h
  63