/* * Copyright (C) 2009 Google Inc. 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 WebPluginContainer_h #define WebPluginContainer_h struct NPObject; namespace WebKit { class WebElement; class WebPlugin; class WebString; class WebURL; class WebURLRequest; struct WebRect; class WebPluginContainer { public: // Returns the element containing this plugin. virtual WebElement element() = 0; virtual void invalidate() = 0; virtual void invalidateRect(const WebRect&) = 0; virtual void scrollRect(int dx, int dy, const WebRect&) = 0; // Causes the container to report its current geometry via // WebPlugin::updateGeometry. virtual void reportGeometry() = 0; // Sets the id of the texture used for hw-accel compositing. // The default value for id is zero which indicates software rendering. // A non-zero value will trigger hw-accelerated compositing. virtual void setBackingTextureId(unsigned) = 0; // Notifies the container that the plugin allocated a new IOSurface for // its rendering, and that the compositor should bind to this texture // and use it for subsequent rendering. A non-zero ioSurfaceId triggers // hardware-accelerated compositing; a zero value switches back to the // software rendered path. (This entry point is used only on Mac OS, // but is defined on all platforms for simplicity.) virtual void setBackingIOSurfaceId(int width, int height, uint32_t ioSurfaceId) = 0; // Called when the backing texture is ready to be composited. // FIXME: consider renaming to something more general, now that // there are multiple providers. One idea: commitBackingStore. virtual void commitBackingTexture() {} // Drop any references to script objects allocated by the plugin. // These are objects derived from WebPlugin::scriptableObject. This is // called when the plugin is being destroyed or if it needs to be // re-initialized. virtual void clearScriptObjects() = 0; // Returns the scriptable object associated with the DOM element // containing the plugin. virtual NPObject* scriptableObjectForElement() = 0; // Executes a "javascript:" URL on behalf of the plugin in the context // of the frame containing the plugin. Returns the result of script // execution, if any. virtual WebString executeScriptURL(const WebURL&, bool popupsAllowed) = 0; // Loads an URL in the specified frame (or the frame containing this // plugin if target is empty). If notifyNeeded is true, then upon // completion, WebPlugin::didFinishLoadingFrameRequest is called if the // load was successful or WebPlugin::didFailLoadingFrameRequest is // called if the load failed. The given notifyData is passed along to // the callback. virtual void loadFrameRequest( const WebURLRequest&, const WebString& target, bool notifyNeeded, void* notifyData) = 0; // Notifies that the zoom level has changed. virtual void zoomLevelChanged(double zoomLevel) = 0; // Notifies whether the contents of the plugin are entirely opaque. virtual void setOpaque(bool) = 0; // Determines whether the given rectangle in this plugin is above all other // content. The rectangle is in the plugin's coordinate system. virtual bool isRectTopmost(const WebRect&) = 0; virtual WebPlugin* plugin() = 0; virtual void setPlugin(WebPlugin*) = 0; protected: ~WebPluginContainer() { } }; } // namespace WebKit #endif