1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
/*
* Copyright (C) 2009, 2012 Google Inc. All rights reserved.
* Copyright (C) 2014 Opera Software ASA. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef WebPlugin_h
#define WebPlugin_h
#include "../platform/WebCanvas.h"
#include "../platform/WebFocusType.h"
#include "../platform/WebString.h"
#include "../platform/WebURL.h"
#include "WebDragOperation.h"
#include "WebDragStatus.h"
#include "WebWidget.h"
#include <v8.h>
struct NPObject;
struct _NPP;
namespace blink {
class WebDragData;
class WebInputEvent;
class WebPluginContainer;
class WebURLResponse;
struct WebCompositionUnderline;
struct WebCursorInfo;
struct WebPrintParams;
struct WebPrintPresetOptions;
struct WebPoint;
struct WebRect;
struct WebURLError;
template <typename T> class WebVector;
class WebPlugin {
public:
virtual bool initialize(WebPluginContainer*) = 0;
virtual void destroy() = 0;
virtual WebPluginContainer* container() const { return 0; }
virtual void containerDidDetachFromParent() { }
virtual NPObject* scriptableObject() { return 0; }
virtual struct _NPP* pluginNPP() { return 0; }
// The same as scriptableObject() but allows to expose scriptable interface
// through plain v8 object instead of NPObject.
// If you override this function, you must return nullptr in scriptableObject().
virtual v8::Local<v8::Object> v8ScriptableObject(v8::Isolate*) { return v8::Local<v8::Object>(); }
// Returns true if the form submission value is successfully obtained
// from the plugin. The value would be associated with the name attribute
// of the corresponding object element.
virtual bool getFormValue(WebString&) { return false; }
virtual bool supportsKeyboardFocus() const { return false; }
virtual bool supportsEditCommands() const { return false; }
// Returns true if this plugin supports input method, which implements
// setComposition() and confirmComposition() below.
virtual bool supportsInputMethod() const { return false; }
virtual bool canProcessDrag() const { return false; }
// TODO(schenney): Make these pure virtual when chromium changes land
virtual void layoutIfNeeded() { }
virtual void paint(WebCanvas*, const WebRect&) = 0;
// Coordinates are relative to the containing window.
virtual void updateGeometry(
const WebRect& windowRect, const WebRect& clipRect,
const WebRect& unobscuredRect, const WebVector<WebRect>& cutOutsRects,
bool isVisible) = 0;
virtual void updateFocus(bool focused, WebFocusType) = 0;
virtual void updateVisibility(bool) = 0;
virtual bool acceptsInputEvents() = 0;
virtual bool handleInputEvent(const WebInputEvent&, WebCursorInfo&) = 0;
virtual bool handleDragStatusUpdate(WebDragStatus, const WebDragData&, WebDragOperationsMask, const WebPoint& position, const WebPoint& screenPosition) { return false; }
virtual void didReceiveResponse(const WebURLResponse&) = 0;
virtual void didReceiveData(const char* data, int dataLength) = 0;
virtual void didFinishLoading() = 0;
virtual void didFailLoading(const WebURLError&) = 0;
// Called in response to WebPluginContainer::loadFrameRequest
virtual void didFinishLoadingFrameRequest(
const WebURL&, void* notifyData) = 0;
virtual void didFailLoadingFrameRequest(
const WebURL&, void* notifyData, const WebURLError&) = 0;
// Printing interface.
// Whether the plugin supports its own paginated print. The other print
// interface methods are called only if this method returns true.
virtual bool supportsPaginatedPrint() { return false; }
// Returns true if the printed content should not be scaled to
// the printer's printable area.
virtual bool isPrintScalingDisabled() { return false; }
// Returns true on success and sets the out parameter to the print preset options for the document.
virtual bool getPrintPresetOptionsFromDocument(WebPrintPresetOptions*) { return false; }
// Sets up printing with the specified printParams. Returns the number of
// pages to be printed at these settings.
virtual int printBegin(const WebPrintParams& printParams) { return 0; }
virtual void printPage(int pageNumber, WebCanvas* canvas) { }
// Ends the print operation.
virtual void printEnd() { }
virtual bool hasSelection() const { return false; }
virtual WebString selectionAsText() const { return WebString(); }
virtual WebString selectionAsMarkup() const { return WebString(); }
virtual bool executeEditCommand(const WebString& name) { return false; }
virtual bool executeEditCommand(const WebString& name, const WebString& value) { return false; }
// Sets composition text from input method, and returns true if the
// composition is set successfully.
virtual bool setComposition(const WebString& text, const WebVector<WebCompositionUnderline>& underlines, int selectionStart, int selectionEnd) { return false; }
// Confirms an ongoing composition and returns true if there is an ongoing
// composition or the text is inserted.
virtual bool confirmComposition(const WebString& text, WebWidget::ConfirmCompositionBehavior selectionBehavior) { return false; }
// Deletes the current selection plus the specified number of characters
// before and after the selection or caret.
virtual void extendSelectionAndDelete(int before, int after) { }
// If the given position is over a link, returns the absolute url.
// Otherwise an empty url is returned.
virtual WebURL linkAtPosition(const WebPoint& position) const { return WebURL(); }
// Find interface.
// Start a new search. The plugin should search for a little bit at a time so that it
// doesn't block the thread in case of a large document. The results, along with the
// find's identifier, should be sent asynchronously to WebFrameClient's reportFindInPage* methods.
// Returns true if the search started, or false if the plugin doesn't support search.
virtual bool startFind(const WebString& searchText, bool caseSensitive, int identifier) { return false; }
// Tells the plugin to jump forward or backward in the list of find results.
virtual void selectFindResult(bool forward) { }
// Tells the plugin that the user has stopped the find operation.
virtual void stopFind() { }
// View rotation types.
enum RotationType {
RotationType90Clockwise,
RotationType90Counterclockwise
};
// Whether the plugin can rotate the view of its content.
virtual bool canRotateView() { return false; }
// Rotates the plugin's view of its content.
virtual void rotateView(RotationType type) { }
virtual bool isPlaceholder() { return true; }
protected:
~WebPlugin() { }
};
} // namespace blink
#endif
|
