Unreviewed, rolling out r117675.
[WebKit-https.git] / Source / WebKit / chromium / public / WebPlugin.h
1 /*
2  * Copyright (C) 2009, 2012 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef WebPlugin_h
32 #define WebPlugin_h
33
34 #include "platform/WebCanvas.h"
35 #include "platform/WebString.h"
36 #include "platform/WebURL.h"
37
38 struct NPObject;
39
40 namespace WebKit {
41
42 class WebDataSource;
43 class WebFrame;
44 class WebInputEvent;
45 class WebPluginContainer;
46 class WebURLResponse;
47 struct WebCursorInfo;
48 struct WebPluginParams;
49 struct WebPrintParams;
50 struct WebPoint;
51 struct WebRect;
52 struct WebURLError;
53 template <typename T> class WebVector;
54
55 class WebPlugin {
56 public:
57     virtual bool initialize(WebPluginContainer*) = 0;
58     virtual void destroy() = 0;
59
60     virtual WebPluginContainer* container() const { return 0; }
61
62     virtual NPObject* scriptableObject() = 0;
63
64     // Returns true if the form submission value is successfully obtained
65     // from the plugin. The value would be associated with the name attribute
66     // of the corresponding object element.
67     virtual bool getFormValue(WebString&) { return false; }
68
69     virtual void paint(WebCanvas*, const WebRect&) = 0;
70
71     // Coordinates are relative to the containing window.
72     virtual void updateGeometry(
73         const WebRect& frameRect, const WebRect& clipRect,
74         const WebVector<WebRect>& cutOutsRects, bool isVisible) = 0;
75
76     virtual void updateFocus(bool) = 0;
77     virtual void updateVisibility(bool) = 0;
78
79     virtual bool acceptsInputEvents() = 0;
80     virtual bool handleInputEvent(const WebInputEvent&, WebCursorInfo&) = 0;
81
82     virtual void didReceiveResponse(const WebURLResponse&) = 0;
83     virtual void didReceiveData(const char* data, int dataLength) = 0;
84     virtual void didFinishLoading() = 0;
85     virtual void didFailLoading(const WebURLError&) = 0;
86
87     // Called in response to WebPluginContainer::loadFrameRequest
88     virtual void didFinishLoadingFrameRequest(
89         const WebURL&, void* notifyData) = 0;
90     virtual void didFailLoadingFrameRequest(
91         const WebURL&, void* notifyData, const WebURLError&) = 0;
92
93     // Printing interface.
94     // Whether the plugin supports its own paginated print. The other print
95     // interface methods are called only if this method returns true.
96     virtual bool supportsPaginatedPrint() { return false; }
97     // Returns true if the printed content should not be scaled to
98     // the printer's printable area.
99     virtual bool isPrintScalingDisabled() { return false; }
100
101     // Sets up printing at the given print rect and printer DPI.
102     // printContentArea is in points ( a point is 1/72 of an inch). Returns the
103     // number of pages to be printed at these settings.
104     // FIXME: Remove this function after fixing crbug.com/85132. For detailed
105     // information, please refer to the comments in WebFrame.h
106     virtual int printBegin(const WebRect& printContentArea, int printerDPI) { return 0; }
107     // Sets up printing with the specified printParams. Returns the number of
108     // pages to be printed at these settings.
109     virtual int printBegin(const WebPrintParams& printParams) { return 0; }
110
111     // Prints the page specified by pageNumber (0-based index) into the supplied canvas.
112     virtual bool printPage(int pageNumber, WebCanvas* canvas) { return false; }
113     // Ends the print operation.
114     virtual void printEnd() { }
115
116     virtual bool hasSelection() const { return false; }
117     virtual WebString selectionAsText() const { return WebString(); }
118     virtual WebString selectionAsMarkup() const { return WebString(); }
119
120     // If the given position is over a link, returns the absolute url.
121     // Otherwise an empty url is returned.
122     virtual WebURL linkAtPosition(const WebPoint& position) const { return WebURL(); }
123
124     // Used for zooming of full page plugins.
125     virtual void setZoomLevel(double level, bool textOnly) { }
126
127     // Find interface.
128     // Start a new search.  The plugin should search for a little bit at a time so that it
129     // doesn't block the thread in case of a large document.  The results, along with the
130     // find's identifier, should be sent asynchronously to WebFrameClient's reportFindInPage* methods.
131     // Returns true if the search started, or false if the plugin doesn't support search.
132     virtual bool startFind(const WebString& searchText, bool caseSensitive, int identifier) { return false; }
133     // Tells the plugin to jump forward or backward in the list of find results.
134     virtual void selectFindResult(bool forward) { }
135     // Tells the plugin that the user has stopped the find operation.
136     virtual void stopFind() { }
137
138     // View rotation types.
139     enum RotationType {
140         RotationType90Clockwise,
141         RotationType90Counterclockwise
142     };
143     // Whether the plugin can rotate the view of its content.
144     virtual bool canRotateView() { return false; }
145     // Rotates the plugin's view of its content.
146     virtual void rotateView(RotationType type) { }
147
148 protected:
149     ~WebPlugin() { }
150 };
151
152 } // namespace WebKit
153
154 #endif