1 /*

     2  * Copyright (C) 2010 Apple 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

     6  * are met:

     7  * 1. Redistributions of source code must retain the above copyright

     8  *    notice, this list of conditions and the following disclaimer.

     9  * 2. Redistributions in binary form must reproduce the above copyright

    10  *    notice, this list of conditions and the following disclaimer in the

    11  *    documentation and/or other materials provided with the distribution.

    12  *

    13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''

    14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,

    15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

    16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS

    17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

    18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

    19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

    20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

    21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

    22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF

    23  * THE POSSIBILITY OF SUCH DAMAGE.

    24  */

    25 

    26 #ifndef PluginController_h

    27 #define PluginController_h

    28 

    29 struct NPObject;

    30 

    31 namespace WebCore {

    32     class HTTPHeaderMap;

    33     class IntRect;

    34     class KURL;

    35     class String;

    36 }

    37 

    38 namespace WebKit {

    39 

    40 class PluginController {

    41 public:

    42     // Tells the controller that the plug-in wants the given rect to be repainted. The rect is in the plug-in's coordinate system.

    43     virtual void invalidate(const WebCore::IntRect&) = 0;

    44 

    45     // Returns the user agent string for the given URL.

    46     virtual WebCore::String userAgent(const WebCore::KURL&) = 0;

    47 

    48     // Loads the given URL and associates it with the request ID.

    49     // 

    50     // If a target is specified, then the URL will be loaded in the window or frame that the target refers to.

    51     // Once the URL finishes loading, Plugin::frameDidFinishLoading will be called with the given requestID. If the URL

    52     // fails to load, Plugin::frameDidFailToLoad will be called.

    53     //

    54     // If the URL is a JavaScript URL, the JavaScript code will be evaluated and the result sent back using Plugin::didEvaluateJavaScript.

    55     virtual void loadURL(uint64_t requestID, const WebCore::String& method, const WebCore::String& urlString, const WebCore::String& target, 

    56                          const WebCore::HTTPHeaderMap& headerFields, const Vector<char>& httpBody, bool allowPopups) = 0;

    57 

    58     /// Cancels the load of a stream that was requested by loadURL.

    59     virtual void cancelStreamLoad(uint64_t streamID) = 0;

    60 

    61     // Get the NPObject that corresponds to the window JavaScript object. Returns a retained object.

    62     virtual NPObject* windowScriptNPObject() = 0;

    63 

    64     // Get the NPObject that corresponds to the plug-in's element. Returns a retained object.

    65     virtual NPObject* pluginElementNPObject() = 0;

    66 

    67 protected:

    68     virtual ~PluginController() { }

    69 };

    70 

    71 } // namespace WebKit

    72 

    73 #endif // PluginController_h