9d970f2f8ddb07f80a801f2a3a183a89535e7d94
[WebKit.git] / Source / WebKit / chromium / src / WebPluginContainerImpl.h
1 /*
2  * Copyright (C) 2009 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 WebPluginContainerImpl_h
32 #define WebPluginContainerImpl_h
33
34 #include "PluginViewBase.h"
35 #include "WebPluginContainer.h"
36 #include "Widget.h"
37
38 #include <wtf/OwnPtr.h>
39 #include <wtf/PassRefPtr.h>
40 #include <wtf/Vector.h>
41 #include <wtf/text/WTFString.h>
42
43 struct NPObject;
44
45 namespace WebCore {
46 class HTMLPlugInElement;
47 class IntRect;
48 class KeyboardEvent;
49 class LayerChromium;
50 class MouseEvent;
51 class PluginLayerChromium;
52 class ResourceError;
53 class ResourceResponse;
54 class WheelEvent;
55
56 #if ENABLE(GESTURE_EVENTS)
57 class PlatformGestureEvent;
58 #endif
59 }
60
61 namespace WebKit {
62
63 class ScrollbarGroup;
64 class WebPlugin;
65 class WebPluginLoadObserver;
66
67 class WebPluginContainerImpl : public WebCore::PluginViewBase, public WebPluginContainer {
68 public:
69     static PassRefPtr<WebPluginContainerImpl> create(WebCore::HTMLPlugInElement* element, WebPlugin* webPlugin)
70     {
71         return adoptRef(new WebPluginContainerImpl(element, webPlugin));
72     }
73
74     // PluginViewBase methods
75     virtual bool getFormValue(String&);
76
77     // Widget methods
78     virtual void setFrameRect(const WebCore::IntRect&);
79     virtual void paint(WebCore::GraphicsContext*, const WebCore::IntRect&);
80     virtual void invalidateRect(const WebCore::IntRect&);
81     virtual void setFocus(bool);
82     virtual void show();
83     virtual void hide();
84     virtual void handleEvent(WebCore::Event*);
85     virtual void frameRectsChanged();
86     virtual void setParentVisible(bool);
87     virtual void setParent(WebCore::ScrollView*);
88     virtual void widgetPositionsUpdated();
89     virtual bool isPluginContainer() const { return true; }
90
91     // WebPluginContainer methods
92     virtual WebElement element();
93     virtual void invalidate();
94     virtual void invalidateRect(const WebRect&);
95     virtual void scrollRect(int dx, int dy, const WebRect&);
96     virtual void reportGeometry();
97     virtual void setBackingTextureId(unsigned);
98     virtual void setBackingIOSurfaceId(int width,
99                                        int height,
100                                        uint32_t ioSurfaceId);
101     virtual void commitBackingTexture();
102     virtual void clearScriptObjects();
103     virtual NPObject* scriptableObjectForElement();
104     virtual WebString executeScriptURL(const WebURL&, bool popupsAllowed);
105     virtual void loadFrameRequest(const WebURLRequest&, const WebString& target, bool notifyNeeded, void* notifyData);
106     virtual void zoomLevelChanged(double zoomLevel);    
107     virtual void setOpaque(bool);
108     virtual bool isRectTopmost(const WebRect&);
109
110     // This cannot be null.
111     WebPlugin* plugin() { return m_webPlugin; }
112     void setPlugin(WebPlugin* plugin) { m_webPlugin = plugin; }
113
114     // Printing interface. The plugin can support custom printing
115     // (which means it controls the layout, number of pages etc).
116     // Whether the plugin supports its own paginated print. The other print
117     // interface methods are called only if this method returns true.
118     bool supportsPaginatedPrint() const;
119     // If the plugin content should not be scaled to the printable area of
120     // the page, then this method should return true.
121     bool isPrintScalingDisabled() const;
122     // Sets up printing at the given print rect and printer DPI. printableArea
123     // is in points (a point is 1/72 of an inch).Returns the number of pages to
124     // be printed at these settings.
125     int printBegin(const WebCore::IntRect& printableArea, int printerDPI) const;
126     // Prints the page specified by pageNumber (0-based index) into the supplied canvas.
127     bool printPage(int pageNumber, WebCore::GraphicsContext* gc);
128     // Ends the print operation.
129     void printEnd();
130
131     // Copy the selected text.
132     void copy();
133
134     // Resource load events for the plugin's source data:
135     void didReceiveResponse(const WebCore::ResourceResponse&);
136     void didReceiveData(const char *data, int dataLength);
137     void didFinishLoading();
138     void didFailLoading(const WebCore::ResourceError&);
139
140     NPObject* scriptableObject();
141
142     void willDestroyPluginLoadObserver(WebPluginLoadObserver*);
143
144 #if USE(ACCELERATED_COMPOSITING)
145     virtual WebCore::LayerChromium* platformLayer() const;
146 #endif
147
148     ScrollbarGroup* scrollbarGroup();
149
150     void willStartLiveResize();
151     void willEndLiveResize();
152
153     bool paintCustomOverhangArea(WebCore::GraphicsContext*, const WebCore::IntRect&, const WebCore::IntRect&, const WebCore::IntRect&);
154
155 private:
156     WebPluginContainerImpl(WebCore::HTMLPlugInElement* element, WebPlugin* webPlugin);
157     ~WebPluginContainerImpl();
158
159     void handleMouseEvent(WebCore::MouseEvent*);
160     void handleWheelEvent(WebCore::WheelEvent*);
161     void handleKeyboardEvent(WebCore::KeyboardEvent*);
162
163     void calculateGeometry(const WebCore::IntRect& frameRect,
164                            WebCore::IntRect& windowRect,
165                            WebCore::IntRect& clipRect,
166                            Vector<WebCore::IntRect>& cutOutRects);
167     WebCore::IntRect windowClipRect() const;
168     void windowCutOutRects(const WebCore::IntRect& frameRect,
169                            Vector<WebCore::IntRect>& cutOutRects);
170
171     WebCore::HTMLPlugInElement* m_element;
172     WebPlugin* m_webPlugin;
173     Vector<WebPluginLoadObserver*> m_pluginLoadObservers;
174
175 #if USE(ACCELERATED_COMPOSITING)
176     RefPtr<WebCore::PluginLayerChromium> m_platformLayer;
177 #endif
178
179     // The associated scrollbar group object, created lazily. Used for Pepper
180     // scrollbars.
181     OwnPtr<ScrollbarGroup> m_scrollbarGroup;
182 };
183
184 } // namespace WebKit
185
186 #endif