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