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'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16 * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 */
24
25#ifndef PluginWidget_h
26#define PluginWidget_h
27
28#include "PlatformLayer.h"
29#include "ScrollTypes.h"
30#include "Widget.h"
31#include <wtf/text/WTFString.h>
32
33namespace JSC {
34    class ExecState;
35    class JSGlobalObject;
36    class JSObject;
37}
38
39namespace WebCore {
40
41class Scrollbar;
42
43// PluginViewBase is a widget that all plug-in views inherit from, both in Webkit and WebKit2.
44// It's intended as a stopgap measure until we can merge all plug-in views into a single plug-in view.
45class PluginViewBase : public Widget {
46public:
47    virtual PlatformLayer* platformLayer() const { return 0; }
48#if PLATFORM(IOS)
49    virtual bool willProvidePluginLayer() const { return false; }
50    virtual void attachPluginLayer() { }
51    virtual void detachPluginLayer() { }
52#endif
53
54    virtual JSC::JSObject* scriptObject(JSC::JSGlobalObject*) { return 0; }
55    virtual void storageBlockingStateChanged() { }
56    virtual void privateBrowsingStateChanged(bool) { }
57    virtual bool getFormValue(String&) { return false; }
58    virtual bool scroll(ScrollDirection, ScrollGranularity) { return false; }
59
60    // A plug-in can ask WebKit to handle scrollbars for it.
61    virtual Scrollbar* horizontalScrollbar() { return 0; }
62    virtual Scrollbar* verticalScrollbar() { return 0; }
63
64    // FIXME: This is a hack that works around the fact that the WebKit2 PluginView isn't a ScrollableArea.
65    virtual bool wantsWheelEvents() { return false; }
66    virtual bool supportsKeyboardFocus() const { return false; }
67    virtual bool canProcessDrag() const { return false; }
68
69    virtual bool shouldAlwaysAutoStart() const { return false; }
70    virtual void beginSnapshottingRunningPlugin() { }
71
72    virtual bool shouldAllowNavigationFromDrags() const { return false; }
73
74    virtual bool isPluginViewBase() const { return true; }
75    virtual bool shouldNotAddLayer() const { return false; }
76
77protected:
78    explicit PluginViewBase(PlatformWidget widget = 0) : Widget(widget) { }
79};
80
81WIDGET_TYPE_CASTS(PluginViewBase, isPluginViewBase());
82
83} // namespace WebCore
84
85#endif // PluginWidget_h
86