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 "RunLoop.h" 31 #include <wtf/PassRefPtr.h> 32 33 namespace WebCore { 34 class GraphicsContext; 35 class IntRect; 36 } 37 38 namespace WebKit { 39 40 class WebMouseEvent; 41 class WebPage; 42 43 class PageOverlay : public APIObject { 44 public: 45 class Client { 46 protected: ~Client()47 virtual ~Client() { } 48 49 public: 50 virtual void pageOverlayDestroyed(PageOverlay*) = 0; 51 virtual void willMoveToWebPage(PageOverlay*, WebPage*) = 0; 52 virtual void didMoveToWebPage(PageOverlay*, WebPage*) = 0; 53 virtual void drawRect(PageOverlay*, WebCore::GraphicsContext&, const WebCore::IntRect& dirtyRect) = 0; 54 virtual bool mouseEvent(PageOverlay*, const WebMouseEvent&) = 0; 55 }; 56 57 static const Type APIType = TypeBundlePageOverlay; 58 59 static PassRefPtr<PageOverlay> create(Client*); 60 virtual ~PageOverlay(); 61 62 void setPage(WebPage*); 63 void setNeedsDisplay(const WebCore::IntRect& dirtyRect); 64 void setNeedsDisplay(); 65 66 void drawRect(WebCore::GraphicsContext&, const WebCore::IntRect& dirtyRect); 67 bool mouseEvent(const WebMouseEvent&); 68 69 void startFadeInAnimation(); 70 void startFadeOutAnimation(); 71 fractionFadedIn()72 float fractionFadedIn() const { return m_fractionFadedIn; } 73 74 protected: 75 explicit PageOverlay(Client*); 76 77 private: 78 // APIObject type()79 virtual Type type() const { return APIType; } 80 81 WebCore::IntRect bounds() const; 82 83 void startFadeAnimation(); 84 void fadeAnimationTimerFired(); 85 86 Client* m_client; 87 WebPage* m_webPage; 88 89 RunLoop::Timer<PageOverlay> m_fadeAnimationTimer; 90 double m_fadeAnimationStartTime; 91 double m_fadeAnimationDuration; 92 93 enum FadeAnimationType { 94 NoAnimation, 95 FadeInAnimation, 96 FadeOutAnimation, 97 }; 98 99 FadeAnimationType m_fadeAnimationType; 100 float m_fractionFadedIn; 101 }; 102 103 } // namespace WebKit 104 105 #endif // PageOverlay_h 106