Home | History | Annotate | Download | only in public 
      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 WebPluginContainer_h
     32 #define WebPluginContainer_h
     33 
     34 struct NPObject;
     35 
     36 namespace WebKit {
     37 
     38 class WebElement;
     39 class WebPlugin;
     40 class WebString;
     41 class WebURL;
     42 class WebURLRequest;
     43 struct WebRect;
     44 
     45 class WebPluginContainer {
     46 public:
     47     // Returns the element containing this plugin.
     48     virtual WebElement element() = 0;
     49 
     50     virtual void invalidate() = 0;
     51     virtual void invalidateRect(const WebRect&) = 0;
     52     virtual void scrollRect(int dx, int dy, const WebRect&) = 0;
     53 
     54     // Causes the container to report its current geometry via
     55     // WebPlugin::updateGeometry.
     56     virtual void reportGeometry() = 0;
     57 
     58     // Sets the id of the texture used for hw-accel compositing.
     59     // The default value for id is zero which indicates software rendering.
     60     // A non-zero value will trigger hw-accelerated compositing.
     61     virtual void setBackingTextureId(unsigned) = 0;
     62     // Called when the backing texture is ready to be composited.
     63     virtual void commitBackingTexture() {}
     64 
     65     // Drop any references to script objects allocated by the plugin.
     66     // These are objects derived from WebPlugin::scriptableObject.  This is
     67     // called when the plugin is being destroyed or if it needs to be
     68     // re-initialized.
     69     virtual void clearScriptObjects() = 0;
     70 
     71     // Returns the scriptable object associated with the DOM element
     72     // containing the plugin.
     73     virtual NPObject* scriptableObjectForElement() = 0;
     74 
     75     // Executes a "javascript:" URL on behalf of the plugin in the context
     76     // of the frame containing the plugin.  Returns the result of script
     77     // execution, if any.
     78     virtual WebString executeScriptURL(const WebURL&, bool popupsAllowed) = 0;
     79 
     80     // Loads an URL in the specified frame (or the frame containing this
     81     // plugin if target is empty).  If notifyNeeded is true, then upon
     82     // completion, WebPlugin::didFinishLoadingFrameRequest is called if the
     83     // load was successful or WebPlugin::didFailLoadingFrameRequest is
     84     // called if the load failed.  The given notifyData is passed along to
     85     // the callback.
     86     virtual void loadFrameRequest(
     87         const WebURLRequest&, const WebString& target, bool notifyNeeded, void* notifyData) = 0;
     88 
     89     // Notifies that the zoom level has changed.
     90     virtual void zoomLevelChanged(double zoomLevel) = 0;
     91 
     92     virtual WebPlugin* plugin() = 0;
     93     virtual void setPlugin(WebPlugin*) = 0;
     94 
     95 protected:
     96     ~WebPluginContainer() { }
     97 };
     98 
     99 } // namespace WebKit
    100 
    101 #endif
    102