Service overlays stay fixed when <iframe> scrolls
[WebKit-https.git] / Source / WebKit2 / WebProcess / WebPage / PageOverlay.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''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef PageOverlay_h
27 #define PageOverlay_h
28
29 #include "APIObject.h"
30 #include "WKBase.h"
31 #include <WebCore/Color.h>
32 #include <WebCore/IntRect.h>
33 #include <wtf/PassRefPtr.h>
34 #include <wtf/RunLoop.h>
35
36 namespace WebCore {
37 class Frame;
38 class GraphicsContext;
39 class GraphicsLayer;
40 }
41
42 namespace WebKit {
43
44 class WebFrame;
45 class WebMouseEvent;
46 class WebPage;
47
48 class PageOverlay : public API::ObjectImpl<API::Object::Type::BundlePageOverlay> {
49 public:
50     class Client {
51     protected:
52         virtual ~Client() { }
53     
54     public:
55         virtual void pageOverlayDestroyed(PageOverlay*) = 0;
56         virtual void willMoveToWebPage(PageOverlay*, WebPage*) = 0;
57         virtual void didMoveToWebPage(PageOverlay*, WebPage*) = 0;
58         virtual void drawRect(PageOverlay*, WebCore::GraphicsContext&, const WebCore::IntRect& dirtyRect) = 0;
59         virtual bool mouseEvent(PageOverlay*, const WebMouseEvent&) = 0;
60         virtual void didScrollFrame(PageOverlay*, WebCore::Frame*) { }
61
62         virtual WKTypeRef copyAccessibilityAttributeValue(PageOverlay*, WKStringRef /* attribute */, WKTypeRef /* parameter */) { return 0; }
63         virtual WKArrayRef copyAccessibilityAttributeNames(PageOverlay*, bool /* parameterizedNames */) { return 0; }
64     };
65
66     enum class OverlayType {
67         View, // Fixed to the view size; does not scale or scroll with the document, repaints on scroll.
68         Document, // Scales and scrolls with the document.
69     };
70
71     static PassRefPtr<PageOverlay> create(Client*, OverlayType = OverlayType::View);
72     virtual ~PageOverlay();
73
74     void setPage(WebPage*);
75     void setNeedsDisplay(const WebCore::IntRect& dirtyRect);
76     void setNeedsDisplay();
77
78     void drawRect(WebCore::GraphicsContext&, const WebCore::IntRect& dirtyRect);
79     bool mouseEvent(const WebMouseEvent&);
80     void didScrollFrame(WebCore::Frame*);
81
82     WKTypeRef copyAccessibilityAttributeValue(WKStringRef attribute, WKTypeRef parameter);
83     WKArrayRef copyAccessibilityAttributeNames(bool parameterizedNames);
84     
85     void startFadeInAnimation();
86     void startFadeOutAnimation();
87     void stopFadeOutAnimation();
88
89     void clear();
90
91     Client* client() const { return m_client; }
92
93     enum class FadeMode { DoNotFade, Fade };
94
95     OverlayType overlayType() { return m_overlayType; }
96
97     WebCore::IntRect bounds() const;
98     WebCore::IntRect frame() const;
99     void setFrame(WebCore::IntRect);
100
101     WebCore::RGBA32 backgroundColor() const { return m_backgroundColor; }
102     void setBackgroundColor(WebCore::RGBA32);
103
104     WebCore::GraphicsLayer* layer();
105     
106 protected:
107     explicit PageOverlay(Client*, OverlayType);
108
109 private:
110     void startFadeAnimation();
111     void fadeAnimationTimerFired();
112
113     Client* m_client;
114     WebPage* m_webPage;
115
116     RunLoop::Timer<PageOverlay> m_fadeAnimationTimer;
117     double m_fadeAnimationStartTime;
118     double m_fadeAnimationDuration;
119
120     enum FadeAnimationType {
121         NoAnimation,
122         FadeInAnimation,
123         FadeOutAnimation,
124     };
125
126     FadeAnimationType m_fadeAnimationType;
127     float m_fractionFadedIn;
128
129     OverlayType m_overlayType;
130     WebCore::IntRect m_overrideFrame;
131
132     WebCore::RGBA32 m_backgroundColor;
133 };
134
135 } // namespace WebKit
136
137 #endif // PageOverlay_h