ios/web/public/navigation_manager.h

   1 // Copyright 2013 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 IOS_WEB_PUBLIC_NAVIGATION_MANAGER_H_
   6 #define IOS_WEB_PUBLIC_NAVIGATION_MANAGER_H_
   7
   8 namespace web {
   9
  10 class BrowserState;
  11 class NavigationItem;
  12 class WebState;
  13
  14 // A NavigationManager maintains the back-forward list for a WebState and
  15 // manages all navigation within that list.
  16 //
  17 // Each NavigationManager belongs to one WebState; each WebState has
  18 // exactly one NavigationManager.
  19 class NavigationManager {
  20  public:
  21   virtual ~NavigationManager() {}
  22
  23   // Gets the BrowserState associated with this NavigationManager. Can never
  24   // return null.
  25   virtual BrowserState* GetBrowserState() const = 0;
  26
  27   // Gets the WebState associated with this NavigationManager.
  28   virtual WebState* GetWebState() const = 0;
  29
  30   // Returns the NavigationItem that should be used when displaying info about
  31   // the current entry to the user. It ignores certain pending entries, to
  32   // prevent spoofing attacks using slow-loading navigations.
  33   virtual NavigationItem* GetVisibleItem() const = 0;
  34
  35   // Returns the last committed NavigationItem, which may be null if there
  36   // are no committed entries.
  37   virtual NavigationItem* GetLastCommittedItem() const = 0;
  38
  39   // Returns the pending entry corresponding to the navigation that is
  40   // currently in progress, or null if there is none.
  41   virtual NavigationItem* GetPendingItem() const = 0;
  42 };
  43
  44 }  // namespace web
  45
  46 #endif  // IOS_WEB_PUBLIC_NAVIGATION_MANAGER_H_