Sessions API - previously Session Restore API. Supports restoring currently open foreign windows an…

chrome/browser/sessions/persistent_tab_restore_service.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROME_BROWSER_SESSIONS_PERSISTENT_TAB_RESTORE_SERVICE_H_
 #define CHROME_BROWSER_SESSIONS_PERSISTENT_TAB_RESTORE_SERVICE_H_
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/memory/scoped_ptr.h"
@@ skipping 13 matching lines @@
 
   // TabRestoreService:
   virtual void AddObserver(TabRestoreServiceObserver* observer) OVERRIDE;
   virtual void RemoveObserver(TabRestoreServiceObserver* observer) OVERRIDE;
   virtual void CreateHistoricalTab(content::WebContents* contents,
                                    int index) OVERRIDE;
   virtual void BrowserClosing(TabRestoreServiceDelegate* delegate) OVERRIDE;
   virtual void BrowserClosed(TabRestoreServiceDelegate* delegate) OVERRIDE;
   virtual void ClearEntries() OVERRIDE;
   virtual const Entries& entries() const OVERRIDE;
-  virtual void RestoreMostRecentEntry(
+  // Returns the WebContents of the restored tab if entry is a Tab. In the case

[sky, 2013/08/01 00:05:43]

Don't duplicate the documentation when overriding interfaces. See all the other
methods here that don't copy existing docs.

[Kristen Dwan, 2013/08/02 20:54:19]

Done.

+  // of restoring type Window, returns the WebContents of the last successfully
+  // restored tab in the window.
+  virtual content::WebContents* RestoreMostRecentEntry(
       TabRestoreServiceDelegate* delegate,
       chrome::HostDesktopType host_desktop_type) OVERRIDE;
   virtual Tab* RemoveTabEntryById(SessionID::id_type id) OVERRIDE;
-  virtual void RestoreEntryById(TabRestoreServiceDelegate* delegate,
-                                SessionID::id_type id,
-                                chrome::HostDesktopType host_desktop_type,
-                                WindowOpenDisposition disposition) OVERRIDE;
+  // Returns the WebContents of the restored tab if entry is a Tab. In the case
+  // of restoring type Window, returns the WebContents of the last successfully
+  // restored tab in the window.
+  virtual content::WebContents* RestoreEntryById(
+      TabRestoreServiceDelegate* delegate,
+      SessionID::id_type id,
+      chrome::HostDesktopType host_desktop_type,
+      WindowOpenDisposition disposition) OVERRIDE;
   virtual void LoadTabsFromLastSession() OVERRIDE;
   virtual bool IsLoaded() const OVERRIDE;
   virtual void DeleteLastSession() OVERRIDE;
   virtual void Shutdown() OVERRIDE;
 
  private:
   friend class PersistentTabRestoreServiceTest;
 
   class Delegate;
 
   // Exposed for testing.
   Entries* mutable_entries();
   void PruneEntries();
 
   scoped_ptr<Delegate> delegate_;
   TabRestoreServiceHelper helper_;
 
   DISALLOW_COPY_AND_ASSIGN(PersistentTabRestoreService);
 };
 
 #endif  // CHROME_BROWSER_SESSIONS_PERSISTENT_TAB_RESTORE_SERVICE_H_