Add a fade transition to services highlights
[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 GraphicsContext;
38 class GraphicsLayer;
39 }
40
41 namespace WebKit {
42
43 class WebMouseEvent;
44 class WebPage;
45
46 class PageOverlay : public API::ObjectImpl<API::Object::Type::BundlePageOverlay> {
47 public:
48     class Client {
49     protected:
50         virtual ~Client() { }
51     
52     public:
53         virtual void pageOverlayDestroyed(PageOverlay*) = 0;
54         virtual void willMoveToWebPage(PageOverlay*, WebPage*) = 0;
55         virtual void didMoveToWebPage(PageOverlay*, WebPage*) = 0;
56         virtual void drawRect(PageOverlay*, WebCore::GraphicsContext&, const WebCore::IntRect& dirtyRect) = 0;
57         virtual bool mouseEvent(PageOverlay*, const WebMouseEvent&) = 0;
58
59         virtual WKTypeRef copyAccessibilityAttributeValue(PageOverlay*, WKStringRef /* attribute */, WKTypeRef /* parameter */) { return 0; }
60         virtual WKArrayRef copyAccessibilityAttributeNames(PageOverlay*, bool /* parameterizedNames */) { return 0; }
61     };
62
63     enum class OverlayType {
64         View, // Fixed to the view size; does not scale or scroll with the document, repaints on scroll.
65         Document, // Scales and scrolls with the document.
66     };
67
68     static PassRefPtr<PageOverlay> create(Client*, OverlayType = OverlayType::View);
69     virtual ~PageOverlay();
70
71     void setPage(WebPage*);
72     void setNeedsDisplay(const WebCore::IntRect& dirtyRect);
73     void setNeedsDisplay();
74
75     void drawRect(WebCore::GraphicsContext&, const WebCore::IntRect& dirtyRect);
76     bool mouseEvent(const WebMouseEvent&);
77
78     WKTypeRef copyAccessibilityAttributeValue(WKStringRef attribute, WKTypeRef parameter);
79     WKArrayRef copyAccessibilityAttributeNames(bool parameterizedNames);
80     
81     void startFadeInAnimation();
82     void startFadeOutAnimation();
83     void stopFadeOutAnimation();
84
85     void clear();
86
87     Client* client() const { return m_client; }
88
89     enum class FadeMode { DoNotFade, Fade };
90
91     OverlayType overlayType() { return m_overlayType; }
92
93     WebCore::IntRect bounds() const;
94     WebCore::IntRect frame() const;
95     void setFrame(WebCore::IntRect);
96
97     WebCore::RGBA32 backgroundColor() const { return m_backgroundColor; }
98     void setBackgroundColor(WebCore::RGBA32);
99
100     WebCore::GraphicsLayer* layer();
101     
102 protected:
103     explicit PageOverlay(Client*, OverlayType);
104
105 private:
106     void startFadeAnimation();
107     void fadeAnimationTimerFired();
108
109     Client* m_client;
110     WebPage* m_webPage;
111
112     RunLoop::Timer<PageOverlay> m_fadeAnimationTimer;
113     double m_fadeAnimationStartTime;
114     double m_fadeAnimationDuration;
115
116     enum FadeAnimationType {
117         NoAnimation,
118         FadeInAnimation,
119         FadeOutAnimation,
120     };
121
122     FadeAnimationType m_fadeAnimationType;
123     float m_fractionFadedIn;
124
125     OverlayType m_overlayType;
126     WebCore::IntRect m_overrideFrame;
127
128     WebCore::RGBA32 m_backgroundColor;
129 };
130
131 } // namespace WebKit
132
133 #endif // PageOverlay_h