content/browser/frame_host/navigator_delegate.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 CONTENT_BROWSER_FRAME_HOST_NAVIGATOR_DELEGATE_H_
   6 #define CONTENT_BROWSER_FRAME_HOST_NAVIGATOR_DELEGATE_H_
   7
   8 #include "base/strings/string16.h"
   9 #include "content/public/browser/invalidate_type.h"
  10 #include "content/public/browser/navigation_controller.h"
  11 #include "ui/base/page_transition_types.h"
  12 #include "ui/base/window_open_disposition.h"
  13
  14 class GURL;
  15 struct FrameHostMsg_DidCommitProvisionalLoad_Params;
  16 struct FrameHostMsg_DidFailProvisionalLoadWithError_Params;
  17
  18 namespace content {
  19
  20 class FrameTreeNode;
  21 class RenderFrameHostImpl;
  22 struct LoadCommittedDetails;
  23 struct OpenURLParams;
  24
  25 // A delegate API used by Navigator to notify its embedder of navigation
  26 // related events.
  27 class CONTENT_EXPORT NavigatorDelegate {
  28  public:
  29   // The RenderFrameHost started a provisional load for the frame
  30   // represented by |render_frame_host|.
  31   virtual void DidStartProvisionalLoad(
  32       RenderFrameHostImpl* render_frame_host,
  33       const GURL& validated_url,
  34       bool is_error_page,
  35       bool is_iframe_srcdoc) {}
  36
  37   // A provisional load in |render_frame_host| failed.
  38   virtual void DidFailProvisionalLoadWithError(
  39       RenderFrameHostImpl* render_frame_host,
  40       const FrameHostMsg_DidFailProvisionalLoadWithError_Params& params) {}
  41
  42   // Document load in |render_frame_host| failed.
  43   virtual void DidFailLoadWithError(
  44       RenderFrameHostImpl* render_frame_host,
  45       const GURL& url,
  46       int error_code,
  47       const base::string16& error_description) {}
  48
  49   // A navigation was committed in |render_frame_host|.
  50   virtual void DidCommitProvisionalLoad(
  51       RenderFrameHostImpl* render_frame_host,
  52       const GURL& url,
  53       ui::PageTransition transition_type) {}
  54
  55   // Handles post-navigation tasks in navigation BEFORE the entry has been
  56   // committed to the NavigationController.
  57   virtual void DidNavigateMainFramePreCommit(bool navigation_is_within_page) {}
  58
  59   // Handles post-navigation tasks in navigation AFTER the entry has been
  60   // committed to the NavigationController. Note that the NavigationEntry is
  61   // not provided since it may be invalid/changed after being committed. The
  62   // NavigationController's last committed entry is for this navigation.
  63   virtual void DidNavigateMainFramePostCommit(
  64       RenderFrameHostImpl* render_frame_host,
  65       const LoadCommittedDetails& details,
  66       const FrameHostMsg_DidCommitProvisionalLoad_Params& params) {}
  67   virtual void DidNavigateAnyFramePostCommit(
  68       RenderFrameHostImpl* render_frame_host,
  69       const LoadCommittedDetails& details,
  70       const FrameHostMsg_DidCommitProvisionalLoad_Params& params) {}
  71
  72   virtual void SetMainFrameMimeType(const std::string& mime_type) {}
  73   virtual bool CanOverscrollContent() const;
  74
  75   // Notification to the Navigator embedder that navigation state has
  76   // changed. This method corresponds to
  77   // WebContents::NotifyNavigationStateChanged.
  78   virtual void NotifyChangedNavigationState(InvalidateTypes changed_flags) {}
  79
  80   // Notifies the Navigator embedder that it is beginning to navigate a frame.
  81   virtual void AboutToNavigateRenderFrame(
  82       RenderFrameHostImpl* old_host,
  83       RenderFrameHostImpl* new_host) {}
  84
  85   // Notifies the Navigator embedder that a navigation to the pending
  86   // NavigationEntry has started in the browser process.
  87   virtual void DidStartNavigationToPendingEntry(
  88       const GURL& url,
  89       NavigationController::ReloadType reload_type) {}
  90
  91   // Opens a URL with the given parameters. See PageNavigator::OpenURL, which
  92   // this forwards to.
  93   virtual void RequestOpenURL(RenderFrameHostImpl* render_frame_host,
  94                               const OpenURLParams& params) {}
  95
  96   // Returns whether URLs for aborted browser-initiated navigations should be
  97   // preserved in the omnibox.  Defaults to false.
  98   virtual bool ShouldPreserveAbortedURLs();
  99
 100   // A RenderFrameHost in the specified |frame_tree_node| started loading a new
 101   // document. This correponds to Blink's notion of the throbber starting.
 102   // |to_different_document| will be true unless the load is a fragment
 103   // navigation, or triggered by history.pushState/replaceState.
 104   virtual void DidStartLoading(FrameTreeNode* frame_tree_node,
 105                                bool to_different_document) {}
 106
 107   // A document stopped loading. This corresponds to Blink's notion of the
 108   // throbber stopping.
 109   virtual void DidStopLoading() {}
 110
 111   // The load progress was changed.
 112   virtual void DidChangeLoadProgress() {}
 113 };
 114
 115 }  // namspace content
 116
 117 #endif  // CONTENT_BROWSER_FRAME_HOST_NAVIGATOR_DELEGATE_H_