content/public/renderer/render_view_observer.h

   1 // Copyright (c) 2012 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_PUBLIC_RENDERER_RENDER_VIEW_OBSERVER_H_
   6 #define CONTENT_PUBLIC_RENDERER_RENDER_VIEW_OBSERVER_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/compiler_specific.h"
  10 #include "content/common/content_export.h"
  11 #include "ipc/ipc_listener.h"
  12 #include "ipc/ipc_sender.h"
  13
  14 class GURL;
  15
  16 namespace blink {
  17 class WebFrame;
  18 class WebGestureEvent;
  19 class WebLocalFrame;
  20 class WebNode;
  21 struct WebURLError;
  22 }
  23
  24 namespace content {
  25
  26 class RenderView;
  27 class RenderViewImpl;
  28
  29 // Base class for objects that want to filter incoming IPCs, and also get
  30 // notified of changes to the frame.
  31 class CONTENT_EXPORT RenderViewObserver : public IPC::Listener,
  32                                           public IPC::Sender {
  33  public:
  34   // By default, observers will be deleted when the RenderView goes away.  If
  35   // they want to outlive it, they can override this function.
  36   virtual void OnDestruct();
  37
  38   // These match the WebKit API notifications
  39   virtual void DidStartLoading() {}
  40   virtual void DidStopLoading() {}
  41   virtual void DidFinishDocumentLoad(blink::WebLocalFrame* frame) {}
  42   virtual void DidFailLoad(blink::WebLocalFrame* frame,
  43                            const blink::WebURLError& error) {}
  44   virtual void DidFinishLoad(blink::WebLocalFrame* frame) {}
  45   virtual void DidStartProvisionalLoad(blink::WebLocalFrame* frame) {}
  46   virtual void DidFailProvisionalLoad(blink::WebLocalFrame* frame,
  47                                       const blink::WebURLError& error) {}
  48   virtual void DidCommitProvisionalLoad(blink::WebLocalFrame* frame,
  49                                         bool is_new_navigation) {}
  50   virtual void DidCreateNewDocument(blink::WebLocalFrame* frame) {}
  51   virtual void DidClearWindowObject(blink::WebLocalFrame* frame) {}
  52   virtual void DidCreateDocumentElement(blink::WebLocalFrame* frame) {}
  53   virtual void FrameCreated(blink::WebLocalFrame* parent,
  54                             blink::WebFrame* frame) {}
  55   virtual void FrameDetached(blink::WebFrame* frame) {}
  56   virtual void FrameWillClose(blink::WebFrame* frame) {}
  57   virtual void PrintPage(blink::WebLocalFrame* frame, bool user_initiated) {}
  58   virtual void FocusedNodeChanged(const blink::WebNode& node) {}
  59   virtual void DraggableRegionsChanged(blink::WebFrame* frame) {}
  60   virtual void DidCommitCompositorFrame() {}
  61   virtual void DidUpdateLayout() {}
  62
  63   // These match the RenderView methods.
  64   virtual void DidHandleGestureEvent(const blink::WebGestureEvent& event) {}
  65
  66   virtual void OnMouseDown(const blink::WebNode& mouse_down_node) {}
  67
  68   // These match incoming IPCs.
  69   virtual void Navigate(const GURL& url) {}
  70   virtual void ClosePage() {}
  71
  72   // This indicates that animations to scroll the focused element into view (if
  73   // any) have completed. May be called more than once for a single focus. Can
  74   // be called from browser, renderer, or compositor.
  75   virtual void FocusChangeComplete() {}
  76
  77   virtual void OnStop() {}
  78
  79   // IPC::Listener implementation.
  80   bool OnMessageReceived(const IPC::Message& message) override;
  81
  82   // IPC::Sender implementation.
  83   bool Send(IPC::Message* message) override;
  84
  85   RenderView* render_view() const;
  86   int routing_id() const { return routing_id_; }
  87
  88  protected:
  89   explicit RenderViewObserver(RenderView* render_view);
  90   ~RenderViewObserver() override;
  91
  92   // Sets |render_view_| to track.
  93   // Removes itself of previous (if any) |render_view_| observer list and adds
  94   // to the new |render_view|. Since it assumes that observer outlives
  95   // render_view, OnDestruct should be overridden.
  96   void Observe(RenderView* render_view);
  97
  98  private:
  99   friend class RenderViewImpl;
 100
 101   // This is called by the RenderView when it's going away so that this object
 102   // can null out its pointer.
 103   void RenderViewGone();
 104
 105   RenderView* render_view_;
 106   // The routing ID of the associated RenderView.
 107   int routing_id_;
 108
 109   DISALLOW_COPY_AND_ASSIGN(RenderViewObserver);
 110 };
 111
 112 }  // namespace content
 113
 114 #endif  // CONTENT_PUBLIC_RENDERER_RENDER_VIEW_OBSERVER_H_