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       bool was_ignored_by_handler) {}
  49
  50   // A navigation was committed in |render_frame_host|.
  51   virtual void DidCommitProvisionalLoad(
  52       RenderFrameHostImpl* render_frame_host,
  53       const GURL& url,
  54       ui::PageTransition transition_type) {}
  55
  56   // Handles post-navigation tasks in navigation BEFORE the entry has been
  57   // committed to the NavigationController.
  58   virtual void DidNavigateMainFramePreCommit(bool navigation_is_within_page) {}
  59
  60   // Handles post-navigation tasks in navigation AFTER the entry has been
  61   // committed to the NavigationController. Note that the NavigationEntry is
  62   // not provided since it may be invalid/changed after being committed. The
  63   // NavigationController's last committed entry is for this navigation.
  64   virtual void DidNavigateMainFramePostCommit(
  65       RenderFrameHostImpl* render_frame_host,
  66       const LoadCommittedDetails& details,
  67       const FrameHostMsg_DidCommitProvisionalLoad_Params& params) {}
  68   virtual void DidNavigateAnyFramePostCommit(
  69       RenderFrameHostImpl* render_frame_host,
  70       const LoadCommittedDetails& details,
  71       const FrameHostMsg_DidCommitProvisionalLoad_Params& params) {}
  72
  73   virtual void SetMainFrameMimeType(const std::string& mime_type) {}
  74   virtual bool CanOverscrollContent() const;
  75
  76   // Notification to the Navigator embedder that navigation state has
  77   // changed. This method corresponds to
  78   // WebContents::NotifyNavigationStateChanged.
  79   virtual void NotifyChangedNavigationState(InvalidateTypes changed_flags) {}
  80
  81   // Notifies the Navigator embedder that it is beginning to navigate a frame.
  82   virtual void AboutToNavigateRenderFrame(
  83       RenderFrameHostImpl* old_host,
  84       RenderFrameHostImpl* new_host) {}
  85
  86   // Notifies the Navigator embedder that a navigation to the pending
  87   // NavigationEntry has started in the browser process.
  88   virtual void DidStartNavigationToPendingEntry(
  89       const GURL& url,
  90       NavigationController::ReloadType reload_type) {}
  91
  92   // Opens a URL with the given parameters. See PageNavigator::OpenURL, which
  93   // this forwards to.
  94   virtual void RequestOpenURL(RenderFrameHostImpl* render_frame_host,
  95                               const OpenURLParams& params) {}
  96
  97   // Returns whether URLs for aborted browser-initiated navigations should be
  98   // preserved in the omnibox.  Defaults to false.
  99   virtual bool ShouldPreserveAbortedURLs();
 100
 101   // A RenderFrameHost in the specified |frame_tree_node| started loading a new
 102   // document. This correponds to Blink's notion of the throbber starting.
 103   // |to_different_document| will be true unless the load is a fragment
 104   // navigation, or triggered by history.pushState/replaceState.
 105   virtual void DidStartLoading(FrameTreeNode* frame_tree_node,
 106                                bool to_different_document) {}
 107
 108   // A document stopped loading. This corresponds to Blink's notion of the
 109   // throbber stopping.
 110   virtual void DidStopLoading() {}
 111
 112   // The load progress was changed.
 113   virtual void DidChangeLoadProgress() {}
 114 };
 115
 116 }  // namspace content
 117
 118 #endif  // CONTENT_BROWSER_FRAME_HOST_NAVIGATOR_DELEGATE_H_