Use #pragma once in WebCore
[WebKit-https.git] / Source / WebCore / rendering / RenderEmbeddedObject.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 2000 Simon Hausmann <hausmann@kde.org>
4  * Copyright (C) 2004, 2005, 2006, 2008, 2009, 2010, 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 #pragma once
24
25 #include "RenderWidget.h"
26
27 namespace WebCore {
28
29 class HTMLAppletElement;
30 class MouseEvent;
31 class TextRun;
32
33 // Renderer for embeds and objects, often, but not always, rendered via plug-ins.
34 // For example, <embed src="foo.html"> does not invoke a plug-in.
35 class RenderEmbeddedObject : public RenderWidget {
36 public:
37     RenderEmbeddedObject(HTMLFrameOwnerElement&, RenderStyle&&);
38     virtual ~RenderEmbeddedObject();
39
40     static RenderPtr<RenderEmbeddedObject> createForApplet(HTMLAppletElement&, RenderStyle&&);
41
42     enum PluginUnavailabilityReason {
43         PluginMissing,
44         PluginCrashed,
45         PluginBlockedByContentSecurityPolicy,
46         InsecurePluginVersion,
47     };
48     WEBCORE_EXPORT void setPluginUnavailabilityReason(PluginUnavailabilityReason);
49     WEBCORE_EXPORT void setPluginUnavailabilityReasonWithDescription(PluginUnavailabilityReason, const String& description);
50
51     bool isPluginUnavailable() const { return m_isPluginUnavailable; }
52
53     WEBCORE_EXPORT void setUnavailablePluginIndicatorIsHidden(bool);
54
55     void handleUnavailablePluginIndicatorEvent(Event*);
56
57     WEBCORE_EXPORT bool isReplacementObscured() const;
58
59     bool allowsAcceleratedCompositing() const;
60
61 protected:
62     void paintReplaced(PaintInfo&, const LayoutPoint&) final;
63     void paint(PaintInfo&, const LayoutPoint&) override;
64
65     CursorDirective getCursor(const LayoutPoint&, Cursor&) const override;
66
67 protected:
68     void layout() override;
69
70 private:
71     const char* renderName() const override { return "RenderEmbeddedObject"; }
72     bool isEmbeddedObject() const final { return true; }
73
74     bool showsUnavailablePluginIndicator() const { return isPluginUnavailable() && m_isUnavailablePluginIndicatorState != UnavailablePluginIndicatorState::Hidden; }
75     void paintSnapshotImage(PaintInfo&, const LayoutPoint&, Image&);
76     void paintContents(PaintInfo&, const LayoutPoint&) final;
77
78     bool requiresLayer() const final;
79
80     bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) final;
81
82     bool scroll(ScrollDirection, ScrollGranularity, float multiplier = 1, Element** stopElement = nullptr, RenderBox* startBox = nullptr, const IntPoint& wheelEventAbsolutePoint = IntPoint()) final;
83     bool logicalScroll(ScrollLogicalDirection, ScrollGranularity, float multiplier, Element** stopElement) final;
84
85     void setUnavailablePluginIndicatorIsPressed(bool);
86     bool isInUnavailablePluginIndicator(const MouseEvent&) const;
87     bool isInUnavailablePluginIndicator(const FloatPoint&) const;
88     bool getReplacementTextGeometry(const LayoutPoint& accumulatedOffset, FloatRect& contentRect, FloatRect& indicatorRect, FloatRect& replacementTextRect, FloatRect& arrowRect, FontCascade&, TextRun&, float& textWidth) const;
89     LayoutRect unavailablePluginIndicatorBounds(const LayoutPoint&) const;
90
91     bool canHaveChildren() const final;
92     virtual bool canHaveWidget() const { return true; }
93
94     bool m_isPluginUnavailable;
95     enum class UnavailablePluginIndicatorState { Uninitialized, Hidden, Visible };
96     UnavailablePluginIndicatorState m_isUnavailablePluginIndicatorState { UnavailablePluginIndicatorState::Uninitialized };
97     PluginUnavailabilityReason m_pluginUnavailabilityReason;
98     String m_unavailablePluginReplacementText;
99     bool m_unavailablePluginIndicatorIsPressed;
100     bool m_mouseDownWasInUnavailablePluginIndicator;
101     String m_unavailabilityDescription;
102 };
103
104 } // namespace WebCore
105
106 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderEmbeddedObject, isEmbeddedObject())