render_view_observer.h revision 58537e28ecd584eab876aee8be7156509866d23a 
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/web/WebIconURL.h"
14
15class GURL;
16
17namespace ppapi {
18namespace host {
19class PpapiHost;
20}
21}
22
23namespace WebKit {
24class WebDataSource;
25class WebFrame;
26class WebFormElement;
27class WebGestureEvent;
28class WebMediaPlayerClient;
29class WebMouseEvent;
30class WebNode;
31class WebTouchEvent;
32class WebURL;
33struct WebContextMenuData;
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(WebKit::WebFrame* frame) {}
56  virtual void DidFailLoad(WebKit::WebFrame* frame,
57                           const WebKit::WebURLError& error) {}
58  virtual void DidFinishLoad(WebKit::WebFrame* frame) {}
59  virtual void DidStartProvisionalLoad(WebKit::WebFrame* frame) {}
60  virtual void DidFailProvisionalLoad(WebKit::WebFrame* frame,
61                                      const WebKit::WebURLError& error) {}
62  virtual void DidCommitProvisionalLoad(WebKit::WebFrame* frame,
63                                        bool is_new_navigation) {}
64  virtual void DidClearWindowObject(WebKit::WebFrame* frame) {}
65  virtual void DidCreateDocumentElement(WebKit::WebFrame* frame) {}
66  virtual void FrameCreated(WebKit::WebFrame* parent,
67                            WebKit::WebFrame* frame) {}
68  virtual void FrameDetached(WebKit::WebFrame* frame) {}
69  virtual void FrameWillClose(WebKit::WebFrame* frame) {}
70  virtual void WillSendSubmitEvent(WebKit::WebFrame* frame,
71                                   const WebKit::WebFormElement& form) {}
72  virtual void WillSubmitForm(WebKit::WebFrame* frame,
73                              const WebKit::WebFormElement& form) {}
74  virtual void DidCreateDataSource(WebKit::WebFrame* frame,
75                                   WebKit::WebDataSource* ds) {}
76  virtual void PrintPage(WebKit::WebFrame* frame, bool user_initiated) {}
77  virtual void FocusedNodeChanged(const WebKit::WebNode& node) {}
78  virtual void WillCreateMediaPlayer(WebKit::WebFrame* frame,
79                                     WebKit::WebMediaPlayerClient* client) {}
80  virtual void ZoomLevelChanged() {};
81  virtual void DidChangeScrollOffset(WebKit::WebFrame* frame) {}
82  virtual void DraggableRegionsChanged(WebKit::WebFrame* frame) {}
83  virtual void DidRequestShowContextMenu(
84      WebKit::WebFrame* frame,
85      const WebKit::WebContextMenuData& data) {}
86  virtual void DidCommitCompositorFrame() {}
87
88  // These match the RenderView methods.
89  virtual void DidHandleMouseEvent(const WebKit::WebMouseEvent& event) {}
90  virtual void DidHandleTouchEvent(const WebKit::WebTouchEvent& event) {}
91  virtual void DidHandleGestureEvent(const WebKit::WebGestureEvent& event) {}
92  virtual void DidCreatePepperPlugin(RendererPpapiHost* host) {}
93
94  // Called when we receive a console message from WebKit for which we requested
95  // extra details (like the stack trace). |message| is the error message,
96  // |source| is the WebKit-reported source of the error (either external or
97  // internal), and |stack_trace| is the stack trace of the error in a
98  // human-readable format (each frame is formatted as
99  // "\n    at function_name (source:line_number:column_number)").
100  virtual void DetailedConsoleMessageAdded(const base::string16& message,
101                                           const base::string16& source,
102                                           const base::string16& stack_trace,
103                                           int32 line_number,
104                                           int32 severity_level) {}
105
106  // These match incoming IPCs.
107  virtual void Navigate(const GURL& url) {}
108  virtual void ClosePage() {}
109  virtual void OrientationChangeEvent(int orientation) {}
110
111  // IPC::Listener implementation.
112  virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
113
114  // IPC::Sender implementation.
115  virtual bool Send(IPC::Message* message) OVERRIDE;
116
117  RenderView* render_view() const;
118  int routing_id() const { return routing_id_; }
119
120 protected:
121  explicit RenderViewObserver(RenderView* render_view);
122  virtual ~RenderViewObserver();
123
124 private:
125  friend class RenderViewImpl;
126
127  // This is called by the RenderView when it's going away so that this object
128  // can null out its pointer.
129  void RenderViewGone();
130
131  RenderView* render_view_;
132  // The routing ID of the associated RenderView.
133  int routing_id_;
134
135  DISALLOW_COPY_AND_ASSIGN(RenderViewObserver);
136};
137
138}  // namespace content
139
140#endif  // CONTENT_PUBLIC_RENDERER_RENDER_VIEW_OBSERVER_H_
141