Fix unused variable warning.
[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/RunLoop.h>
32 #include <wtf/PassRefPtr.h>
33
34 namespace WebCore {
35     class GraphicsContext;
36     class IntPoint;
37     class IntRect;
38 }
39
40 namespace WebKit {
41
42 class WebMouseEvent;
43 class WebPage;
44
45 class PageOverlay : public TypedAPIObject<APIObject::TypeBundlePageOverlay> {
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     static PassRefPtr<PageOverlay> create(Client*);
63     virtual ~PageOverlay();
64
65     void setPage(WebPage*);
66     void setNeedsDisplay(const WebCore::IntRect& dirtyRect);
67     void setNeedsDisplay();
68
69     void drawRect(WebCore::GraphicsContext&, const WebCore::IntRect& dirtyRect);
70     bool mouseEvent(const WebMouseEvent&);
71
72     WKTypeRef copyAccessibilityAttributeValue(WKStringRef attribute, WKTypeRef parameter);
73     WKArrayRef copyAccessibilityAttributeNames(bool parameterizedNames);
74     
75     void startFadeInAnimation();
76     void startFadeOutAnimation();
77     void stopFadeOutAnimation();
78
79     Client* client() const { return m_client; }
80     
81 protected:
82     explicit PageOverlay(Client*);
83
84 private:
85     WebCore::IntRect bounds() const;
86
87     void startFadeAnimation();
88     void fadeAnimationTimerFired();
89
90     Client* m_client;
91     WebPage* m_webPage;
92
93     WebCore::RunLoop::Timer<PageOverlay> m_fadeAnimationTimer;
94     double m_fadeAnimationStartTime;
95     double m_fadeAnimationDuration;
96
97     enum FadeAnimationType {
98         NoAnimation,
99         FadeInAnimation,
100         FadeOutAnimation,
101     };
102
103     FadeAnimationType m_fadeAnimationType;
104     float m_fractionFadedIn;
105 };
106
107 } // namespace WebKit
108
109 #endif // PageOverlay_h