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 

    53     // Causes the container to report its current geometry via

    54     // WebPlugin::updateGeometry.

    55     virtual void reportGeometry() = 0;

    56 

    57     // Drop any references to script objects allocated by the plugin.

    58     // These are objects derived from WebPlugin::scriptableObject.  This is

    59     // called when the plugin is being destroyed or if it needs to be

    60     // re-initialized.

    61     virtual void clearScriptObjects() = 0;

    62 

    63     // Returns the scriptable object associated with the DOM element

    64     // containing the plugin.

    65     virtual NPObject* scriptableObjectForElement() = 0;

    66 

    67     // Executes a "javascript:" URL on behalf of the plugin in the context

    68     // of the frame containing the plugin.  Returns the result of script

    69     // execution, if any.

    70     virtual WebString executeScriptURL(const WebURL&, bool popupsAllowed) = 0;

    71 

    72     // Loads an URL in the specified frame (or the frame containing this

    73     // plugin if target is empty).  If notifyNeeded is true, then upon

    74     // completion, WebPlugin::didFinishLoadingFrameRequest is called if the

    75     // load was successful or WebPlugin::didFailLoadingFrameRequest is

    76     // called if the load failed.  The given notifyData is passed along to

    77     // the callback.

    78     virtual void loadFrameRequest(

    79         const WebURLRequest&, const WebString& target, bool notifyNeeded, void* notifyData) = 0;

    80 

    81     virtual WebPlugin* plugin() = 0;

    82     virtual void setPlugin(WebPlugin*) = 0;

    83 

    84 protected:

    85     ~WebPluginContainer() { }

    86 };

    87 

    88 } // namespace WebKit

    89 

    90 #endif