src/third_party/WebKit/Source/web/PageOverlay.h

   1 /*
   2  * Copyright (C) 2011 Google 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 are
   6  * met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *
  11  * 2. Redistributions in binary form must reproduce the above
  12  * copyright notice, this list of conditions and the following disclaimer
  13  * in the documentation and/or other materials provided with the
  14  * distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY GOOGLE INC. AND ITS CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GOOGLE INC.
  20  * OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef PageOverlay_h
  30 #define PageOverlay_h
  31
  32 #include "wtf/OwnPtr.h"
  33 #include "wtf/PassOwnPtr.h"
  34
  35 namespace blink {
  36
  37 class GraphicsContext;
  38 class GraphicsLayer;
  39 class GraphicsLayerClient;
  40 class WebPageOverlay;
  41 class WebViewImpl;
  42
  43 class PageOverlay {
  44 public:
  45     static PassOwnPtr<PageOverlay> create(WebViewImpl*, WebPageOverlay*);
  46
  47     ~PageOverlay() { }
  48
  49     WebPageOverlay* overlay() const { return m_overlay; }
  50     void setOverlay(WebPageOverlay* overlay) { m_overlay = overlay; }
  51
  52     int zOrder() const { return m_zOrder; }
  53     void setZOrder(int zOrder) { m_zOrder = zOrder; }
  54
  55     void clear();
  56     void update();
  57     void paintWebFrame(GraphicsContext&);
  58
  59     GraphicsLayer* graphicsLayer() const { return m_layer.get(); }
  60
  61 private:
  62     PageOverlay(WebViewImpl*, WebPageOverlay*);
  63     void invalidateWebFrame();
  64
  65     WebViewImpl* m_viewImpl;
  66     WebPageOverlay* m_overlay;
  67     OwnPtr<GraphicsLayerClient> m_layerClient;
  68     OwnPtr<GraphicsLayer> m_layer;
  69     int m_zOrder;
  70 };
  71
  72 } // namespace blink
  73
  74 #endif // PageOverlay_h