Remove "virtual" from all lines that have both "virtual" and "override".
[WebKit-https.git] / Source / WebCore / html / HTMLPlugInElement.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  * Copyright (C) 2004, 2006, 2007, 2008, 2009, 2012 Apple Inc. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #ifndef HTMLPlugInElement_h
24 #define HTMLPlugInElement_h
25
26 #include "HTMLFrameOwnerElement.h"
27 #include "Image.h"
28
29 #if ENABLE(NETSCAPE_PLUGIN_API)
30 struct NPObject;
31 #endif
32
33 namespace JSC {
34 namespace Bindings {
35 class Instance;
36 }
37 }
38
39 namespace WebCore {
40
41 class PluginReplacement;
42 class RenderEmbeddedObject;
43 class RenderWidget;
44 class Widget;
45
46 class HTMLPlugInElement : public HTMLFrameOwnerElement {
47 public:
48     virtual ~HTMLPlugInElement();
49
50     void resetInstance();
51
52     PassRefPtr<JSC::Bindings::Instance> getInstance();
53
54     enum class PluginLoadingPolicy { DoNotLoad, Load };
55     WEBCORE_EXPORT Widget* pluginWidget(PluginLoadingPolicy = PluginLoadingPolicy::Load) const;
56
57     enum DisplayState {
58         WaitingForSnapshot,
59         DisplayingSnapshot,
60         Restarting,
61         RestartingWithPendingMouseClick,
62         Playing,
63         PreparingPluginReplacement,
64         DisplayingPluginReplacement,
65     };
66     DisplayState displayState() const { return m_displayState; }
67     virtual void setDisplayState(DisplayState);
68     virtual void updateSnapshot(PassRefPtr<Image>) { }
69     virtual void dispatchPendingMouseClick() { }
70     virtual bool isRestartedPlugin() const { return false; }
71
72     JSC::JSObject* scriptObjectForPluginReplacement();
73
74 #if ENABLE(NETSCAPE_PLUGIN_API)
75     WEBCORE_EXPORT NPObject* getNPObject();
76 #endif
77
78     bool isCapturingMouseEvents() const { return m_isCapturingMouseEvents; }
79     void setIsCapturingMouseEvents(bool capturing) { m_isCapturingMouseEvents = capturing; }
80
81     bool canContainRangeEndPoint() const override { return false; }
82
83     bool canProcessDrag() const;
84
85 #if PLATFORM(IOS)
86     bool willRespondToMouseMoveEvents() override { return false; }
87 #endif
88     bool willRespondToMouseClickEvents() override;
89
90     virtual bool isPlugInImageElement() const { return false; }
91
92     bool isUserObservable() const;
93     
94 protected:
95     HTMLPlugInElement(const QualifiedName& tagName, Document&);
96
97     void willDetachRenderers() override;
98     bool isPresentationAttribute(const QualifiedName&) const override;
99     void collectStyleForPresentationAttribute(const QualifiedName&, const AtomicString&, MutableStyleProperties&) override;
100
101     virtual bool useFallbackContent() const { return false; }
102
103     void defaultEventHandler(Event*) override;
104
105     virtual bool requestObject(const String& url, const String& mimeType, const Vector<String>& paramNames, const Vector<String>& paramValues);
106     RenderPtr<RenderElement> createElementRenderer(Ref<RenderStyle>&&, const RenderTreePosition&) override;
107     void didAddUserAgentShadowRoot(ShadowRoot*) override;
108
109     // Subclasses should use guardedDispatchBeforeLoadEvent instead of calling dispatchBeforeLoadEvent directly.
110     bool guardedDispatchBeforeLoadEvent(const String& sourceURL);
111
112     bool m_inBeforeLoadEventHandler;
113
114 private:
115     void swapRendererTimerFired();
116     bool shouldOverridePlugin(const String& url, const String& mimeType);
117
118     bool dispatchBeforeLoadEvent(const String& sourceURL); // Not implemented, generates a compile error if subclasses call this by mistake.
119
120     // FIXME: Shadow DOM spec says we should be able to create shadow root on applet, embed, and object.
121     bool canHaveUserAgentShadowRoot() const override final { return true; }
122
123     // This will load the plugin if necessary.
124     virtual RenderWidget* renderWidgetLoadingPlugin() const = 0;
125
126     bool supportsFocus() const override;
127
128     bool isKeyboardFocusable(KeyboardEvent*) const override;
129     bool isPluginElement() const override final;
130
131     RefPtr<JSC::Bindings::Instance> m_instance;
132     Timer m_swapRendererTimer;
133     RefPtr<PluginReplacement> m_pluginReplacement;
134 #if ENABLE(NETSCAPE_PLUGIN_API)
135     NPObject* m_NPObject;
136 #endif
137     bool m_isCapturingMouseEvents;
138
139     DisplayState m_displayState;
140 };
141
142 } // namespace WebCore
143
144 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::HTMLPlugInElement)
145     static bool isType(const WebCore::Node& node) { return node.isPluginElement(); }
146 SPECIALIZE_TYPE_TRAITS_END()
147
148 #endif // HTMLPlugInElement_h