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 WebPlugin_h
32#define WebPlugin_h
33
34#include "WebCanvas.h"
35
36struct NPObject;
37
38namespace WebKit {
39
40class WebDataSource;
41class WebFrame;
42class WebInputEvent;
43class WebPluginContainer;
44class WebURL;
45class WebURLResponse;
46struct WebCursorInfo;
47struct WebPluginParams;
48struct WebRect;
49struct WebURLError;
50template <typename T> class WebVector;
51
52class WebPlugin {
53public:
54    virtual bool initialize(WebPluginContainer*) = 0;
55    virtual void destroy() = 0;
56
57    virtual NPObject* scriptableObject() = 0;
58
59    virtual void paint(WebCanvas*, const WebRect&) = 0;
60
61    // Coordinates are relative to the containing window.
62    virtual void updateGeometry(
63        const WebRect& frameRect, const WebRect& clipRect,
64        const WebVector<WebRect>& cutOutsRects, bool isVisible) = 0;
65
66    virtual void updateFocus(bool) = 0;
67    virtual void updateVisibility(bool) = 0;
68
69    virtual bool acceptsInputEvents() = 0;
70    virtual bool handleInputEvent(const WebInputEvent&, WebCursorInfo&) = 0;
71
72    virtual void didReceiveResponse(const WebURLResponse&) = 0;
73    virtual void didReceiveData(const char* data, int dataLength) = 0;
74    virtual void didFinishLoading() = 0;
75    virtual void didFailLoading(const WebURLError&) = 0;
76
77    // Called in response to WebPluginContainer::loadFrameRequest
78    virtual void didFinishLoadingFrameRequest(
79        const WebURL&, void* notifyData) = 0;
80    virtual void didFailLoadingFrameRequest(
81        const WebURL&, void* notifyData, const WebURLError&) = 0;
82
83protected:
84    ~WebPlugin() { }
85};
86
87} // namespace WebKit
88
89#endif
90