WinCairo build fails to link.
[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/chromium/public/WebCanvas.h"
35 #include "../../../Platform/chromium/public/WebString.h"
36 #include "../../../Platform/chromium/public/WebURL.h"
37 #include "WebDragOperation.h"
38 #include "WebDragStatus.h"
39
40 struct NPObject;
41
42 namespace WebKit {
43
44 class WebDataSource;
45 class WebDragData;
46 class WebFrame;
47 class WebInputEvent;
48 class WebPluginContainer;
49 class WebURLResponse;
50 struct WebCursorInfo;
51 struct WebPluginParams;
52 struct WebPrintParams;
53 struct WebPoint;
54 struct WebRect;
55 struct WebURLError;
56 template <typename T> class WebVector;
57
58 class WebPlugin {
59 public:
60     virtual bool initialize(WebPluginContainer*) = 0;
61     virtual void destroy() = 0;
62
63     virtual WebPluginContainer* container() const { return 0; }
64
65     virtual NPObject* scriptableObject() = 0;
66
67     // Returns true if the form submission value is successfully obtained
68     // from the plugin. The value would be associated with the name attribute
69     // of the corresponding object element.
70     virtual bool getFormValue(WebString&) { return false; }
71     virtual bool supportsKeyboardFocus() const { return false; }
72
73     virtual bool canProcessDrag() const { return false; }
74
75     virtual void paint(WebCanvas*, const WebRect&) = 0;
76
77     // Coordinates are relative to the containing window.
78     virtual void updateGeometry(
79         const WebRect& frameRect, const WebRect& clipRect,
80         const WebVector<WebRect>& cutOutsRects, bool isVisible) = 0;
81
82     virtual void updateFocus(bool) = 0;
83     virtual void updateVisibility(bool) = 0;
84
85     virtual bool acceptsInputEvents() = 0;
86     virtual bool handleInputEvent(const WebInputEvent&, WebCursorInfo&) = 0;
87
88     virtual bool handleDragStatusUpdate(WebDragStatus, const WebDragData&, WebDragOperationsMask, const WebPoint& position, const WebPoint& screenPosition) { return false; }
89
90     virtual void didReceiveResponse(const WebURLResponse&) = 0;
91     virtual void didReceiveData(const char* data, int dataLength) = 0;
92     virtual void didFinishLoading() = 0;
93     virtual void didFailLoading(const WebURLError&) = 0;
94
95     // Called in response to WebPluginContainer::loadFrameRequest
96     virtual void didFinishLoadingFrameRequest(
97         const WebURL&, void* notifyData) = 0;
98     virtual void didFailLoadingFrameRequest(
99         const WebURL&, void* notifyData, const WebURLError&) = 0;
100
101     // Printing interface.
102     // Whether the plugin supports its own paginated print. The other print
103     // interface methods are called only if this method returns true.
104     virtual bool supportsPaginatedPrint() { return false; }
105     // Returns true if the printed content should not be scaled to
106     // the printer's printable area.
107     virtual bool isPrintScalingDisabled() { return false; }
108
109     // Sets up printing with the specified printParams. Returns the number of
110     // pages to be printed at these settings.
111     virtual int printBegin(const WebPrintParams& printParams) { return 0; }
112
113     // Prints the page specified by pageNumber (0-based index) into the supplied canvas.
114     virtual bool printPage(int pageNumber, WebCanvas* canvas) { return false; }
115     // Ends the print operation.
116     virtual void printEnd() { }
117
118     virtual bool hasSelection() const { return false; }
119     virtual WebString selectionAsText() const { return WebString(); }
120     virtual WebString selectionAsMarkup() const { return WebString(); }
121
122     // If the given position is over a link, returns the absolute url.
123     // Otherwise an empty url is returned.
124     virtual WebURL linkAtPosition(const WebPoint& position) const { return WebURL(); }
125
126     // Used for zooming of full page plugins.
127     virtual void setZoomLevel(double level, bool textOnly) { }
128
129     // Find interface.
130     // Start a new search.  The plugin should search for a little bit at a time so that it
131     // doesn't block the thread in case of a large document.  The results, along with the
132     // find's identifier, should be sent asynchronously to WebFrameClient's reportFindInPage* methods.
133     // Returns true if the search started, or false if the plugin doesn't support search.
134     virtual bool startFind(const WebString& searchText, bool caseSensitive, int identifier) { return false; }
135     // Tells the plugin to jump forward or backward in the list of find results.
136     virtual void selectFindResult(bool forward) { }
137     // Tells the plugin that the user has stopped the find operation.
138     virtual void stopFind() { }
139
140     // View rotation types.
141     enum RotationType {
142         RotationType90Clockwise,
143         RotationType90Counterclockwise
144     };
145     // Whether the plugin can rotate the view of its content.
146     virtual bool canRotateView() { return false; }
147     // Rotates the plugin's view of its content.
148     virtual void rotateView(RotationType type) { }
149
150     virtual bool isPlaceholder() { return true; }
151
152 protected:
153     ~WebPlugin() { }
154 };
155
156 } // namespace WebKit
157
158 #endif