components/sessions/core/live_tab.h

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef COMPONENTS_SESSIONS_CORE_LIVE_TAB_H_
   6 #define COMPONENTS_SESSIONS_CORE_LIVE_TAB_H_
   7
   8 #include "base/basictypes.h"
   9 #include "components/sessions/serialized_navigation_entry.h"
  10 #include "components/sessions/sessions_export.h"
  11
  12 namespace sessions {
  13
  14 // Interface that represents a currently-live tab to the core sessions code, and
  15 // in particular, the tab restore service. This interface abstracts the concrete
  16 // representation of a live tab on different platforms (e.g., WebContents on
  17 // //content-based platforms).
  18 class SESSIONS_EXPORT LiveTab {
  19  public:
  20   virtual ~LiveTab() {}
  21
  22   // Methods that return information about the navigation state of the tab.
  23   virtual int GetCurrentEntryIndex() = 0;
  24   virtual int GetPendingEntryIndex() = 0;
  25   virtual SerializedNavigationEntry GetEntryAtIndex(int index) = 0;
  26   virtual SerializedNavigationEntry GetPendingEntry() = 0;
  27   virtual int GetEntryCount() = 0;
  28
  29   // Loads the current page if necessary (where "necessary" is defined on a
  30   // platform-specific basis).
  31   virtual void LoadIfNecessary() = 0;
  32
  33   // Returns the user agent override, if any.
  34   virtual const std::string& GetUserAgentOverride() const = 0;
  35 };
  36
  37 }  // namespace sessions
  38
  39 #endif  // COMPONENTS_SESSIONS_CORE_LIVE_TAB_H_