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#include "third_party/WebKit/public/platform/WebVector.h" 14 15class GURL; 16 17namespace ppapi { 18namespace host { 19class PpapiHost; 20} 21} 22 23namespace blink { 24class WebDataSource; 25class WebFrame; 26class WebFormElement; 27class WebGestureEvent; 28class WebLocalFrame; 29class WebMouseEvent; 30class WebNode; 31class WebString; 32class WebTouchEvent; 33class WebURL; 34struct WebURLError; 35} 36 37namespace content { 38 39class RendererPpapiHost; 40class RenderView; 41class RenderViewImpl; 42 43// Base class for objects that want to filter incoming IPCs, and also get 44// notified of changes to the frame. 45class CONTENT_EXPORT RenderViewObserver : public IPC::Listener, 46 public IPC::Sender { 47 public: 48 // By default, observers will be deleted when the RenderView goes away. If 49 // they want to outlive it, they can override this function. 50 virtual void OnDestruct(); 51 52 // These match the WebKit API notifications 53 virtual void DidStartLoading() {} 54 virtual void DidStopLoading() {} 55 virtual void DidFinishDocumentLoad(blink::WebLocalFrame* frame) {} 56 virtual void DidFailLoad(blink::WebLocalFrame* frame, 57 const blink::WebURLError& error) {} 58 virtual void DidFinishLoad(blink::WebLocalFrame* frame) {} 59 virtual void DidStartProvisionalLoad(blink::WebLocalFrame* frame) {} 60 virtual void DidFailProvisionalLoad(blink::WebLocalFrame* frame, 61 const blink::WebURLError& error) {} 62 virtual void DidCommitProvisionalLoad(blink::WebLocalFrame* frame, 63 bool is_new_navigation) {} 64 virtual void DidClearWindowObject(blink::WebLocalFrame* frame) {} 65 virtual void DidCreateDocumentElement(blink::WebLocalFrame* frame) {} 66 virtual void FrameCreated(blink::WebLocalFrame* parent, 67 blink::WebFrame* frame) {} 68 virtual void FrameDetached(blink::WebFrame* frame) {} 69 virtual void FrameWillClose(blink::WebFrame* frame) {} 70 virtual void DidMatchCSS( 71 blink::WebLocalFrame* frame, 72 const blink::WebVector<blink::WebString>& newly_matching_selectors, 73 const blink::WebVector<blink::WebString>& stopped_matching_selectors) {} 74 virtual void WillSendSubmitEvent(blink::WebLocalFrame* frame, 75 const blink::WebFormElement& form) {} 76 virtual void WillSubmitForm(blink::WebLocalFrame* frame, 77 const blink::WebFormElement& form) {} 78 virtual void DidCreateDataSource(blink::WebLocalFrame* frame, 79 blink::WebDataSource* ds) {} 80 virtual void PrintPage(blink::WebLocalFrame* frame, bool user_initiated) {} 81 virtual void FocusedNodeChanged(const blink::WebNode& node) {} 82 virtual void ZoomLevelChanged() {}; 83 virtual void DidChangeScrollOffset(blink::WebLocalFrame* frame) {} 84 virtual void DraggableRegionsChanged(blink::WebFrame* frame) {} 85 virtual void DidCommitCompositorFrame() {} 86 virtual void DidUpdateLayout() {} 87 88 // These match the RenderView methods. 89 virtual void DidHandleMouseEvent(const blink::WebMouseEvent& event) {} 90 virtual void DidHandleTouchEvent(const blink::WebTouchEvent& event) {} 91 92 // These match incoming IPCs. 93 virtual void Navigate(const GURL& url) {} 94 virtual void ClosePage() {} 95 virtual void OrientationChangeEvent() {} 96 97 virtual void OnStop() {} 98 99 // IPC::Listener implementation. 100 virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE; 101 102 // IPC::Sender implementation. 103 virtual bool Send(IPC::Message* message) OVERRIDE; 104 105 RenderView* render_view() const; 106 int routing_id() const { return routing_id_; } 107 108 protected: 109 explicit RenderViewObserver(RenderView* render_view); 110 virtual ~RenderViewObserver(); 111 112 // Sets |render_view_| to track. 113 // Removes itself of previous (if any) |render_view_| observer list and adds 114 // to the new |render_view|. Since it assumes that observer outlives 115 // render_view, OnDestruct should be overridden. 116 void Observe(RenderView* render_view); 117 118 private: 119 friend class RenderViewImpl; 120 121 // This is called by the RenderView when it's going away so that this object 122 // can null out its pointer. 123 void RenderViewGone(); 124 125 RenderView* render_view_; 126 // The routing ID of the associated RenderView. 127 int routing_id_; 128 129 DISALLOW_COPY_AND_ASSIGN(RenderViewObserver); 130}; 131 132} // namespace content 133 134#endif // CONTENT_PUBLIC_RENDERER_RENDER_VIEW_OBSERVER_H_ 135