Minor cleanups to WebCore/plugins
[WebKit-https.git] / Source / WebCore / plugins / PluginViewBase.h
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 PluginViewBase_h
26 #define PluginViewBase_h
27
28 #include "AudioHardwareListener.h"
29 #include "BridgeJSC.h"
30 #include "PlatformLayer.h"
31 #include "ScrollTypes.h"
32 #include "Widget.h"
33 #include <wtf/text/WTFString.h>
34
35 namespace JSC {
36     class ExecState;
37     class JSGlobalObject;
38     class JSObject;
39 }
40
41 namespace WebCore {
42
43 class Scrollbar;
44
45 // PluginViewBase is a widget that all plug-in views inherit from, both in Webkit and WebKit2.
46 // It's intended as a stopgap measure until we can merge all plug-in views into a single plug-in view.
47 class PluginViewBase : public Widget {
48 public:
49     virtual PlatformLayer* platformLayer() const { return 0; }
50 #if PLATFORM(IOS)
51     virtual bool willProvidePluginLayer() const { return false; }
52     virtual void attachPluginLayer() { }
53     virtual void detachPluginLayer() { }
54 #endif
55
56     virtual JSC::JSObject* scriptObject(JSC::JSGlobalObject*) { return 0; }
57     virtual void storageBlockingStateChanged() { }
58     virtual void privateBrowsingStateChanged(bool) { }
59     virtual bool getFormValue(String&) { return false; }
60     virtual bool scroll(ScrollDirection, ScrollGranularity) { return false; }
61
62     // A plug-in can ask WebKit to handle scrollbars for it.
63     virtual Scrollbar* horizontalScrollbar() { return 0; }
64     virtual Scrollbar* verticalScrollbar() { return 0; }
65
66     // FIXME: This is a hack that works around the fact that the WebKit2 PluginView isn't a ScrollableArea.
67     virtual bool wantsWheelEvents() { return false; }
68     virtual bool supportsKeyboardFocus() const { return false; }
69     virtual bool canProcessDrag() const { return false; }
70
71     virtual bool shouldAlwaysAutoStart() const { return false; }
72     virtual void beginSnapshottingRunningPlugin() { }
73
74     virtual bool shouldAllowNavigationFromDrags() const { return false; }
75
76     virtual bool isPluginViewBase() const { return true; }
77     virtual bool shouldNotAddLayer() const { return false; }
78
79     virtual AudioHardwareActivityType audioHardwareActivity() const { return AudioHardwareActivityType::Unknown; }
80
81     virtual void setJavaScriptPaused(bool) { }
82
83     virtual PassRefPtr<JSC::Bindings::Instance> bindingInstance() { return nullptr; }
84
85 protected:
86     explicit PluginViewBase(PlatformWidget widget = 0) : Widget(widget) { }
87 };
88
89 } // namespace WebCore
90
91 SPECIALIZE_TYPE_TRAITS_WIDGET(PluginViewBase, isPluginViewBase())
92
93 #endif // PluginViewBase_h