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 <wtf/PassRefPtr.h>
  31
  32 namespace WebCore {
  33     class GraphicsContext;
  34     class IntRect;
  35 }
  36
  37 namespace WebKit {
  38
  39 class WebMouseEvent;
  40 class WebPage;
  41
  42 class PageOverlay : public APIObject {
  43 public:
  44     class Client {
  45     protected:
  46         virtual ~Client() { }
  47
  48     public:
  49         virtual void pageOverlayDestroyed(PageOverlay*) = 0;
  50         virtual void willMoveToWebPage(PageOverlay*, WebPage*) = 0;
  51         virtual void didMoveToWebPage(PageOverlay*, WebPage*) = 0;
  52         virtual void drawRect(PageOverlay*, WebCore::GraphicsContext&, const WebCore::IntRect& dirtyRect) = 0;
  53         virtual bool mouseEvent(PageOverlay*, const WebMouseEvent&) = 0;
  54     };
  55
  56     static const Type APIType = TypeBundlePageOverlay;
  57
  58     static PassRefPtr<PageOverlay> create(Client*);
  59     virtual ~PageOverlay();
  60
  61     void setPage(WebPage*);
  62     void setNeedsDisplay(const WebCore::IntRect& dirtyRect);
  63     void setNeedsDisplay();
  64
  65     void drawRect(WebCore::GraphicsContext&, const WebCore::IntRect& dirtyRect);
  66     bool mouseEvent(const WebMouseEvent&);
  67
  68 protected:
  69     explicit PageOverlay(Client*);
  70
  71     WebPage* webPage() const { return m_webPage; }
  72
  73 private:
  74     // APIObject
  75     virtual Type type() const { return APIType; }
  76
  77     WebCore::IntRect bounds() const;
  78
  79     Client* m_client;
  80
  81     WebPage* m_webPage;
  82 };
  83
  84 } // namespace WebKit
  85
  86 #endif // PageOverlay_h