src/third_party/WebKit/Source/core/rendering/RenderLayerModelObject.h

   1 /*
   2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
   3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
   4  * Copyright (C) 2003, 2006, 2007, 2009 Apple Inc. All rights reserved.
   5  * Copyright (C) 2010, 2012 Google Inc. All rights reserved.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public License
  18  * along with this library; see the file COPYING.LIB.  If not, write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 #ifndef RenderLayerModelObject_h
  24 #define RenderLayerModelObject_h
  25
  26 #include "core/rendering/RenderObject.h"
  27
  28 namespace blink {
  29
  30 class RenderLayer;
  31 class CompositedLayerMapping;
  32 class ScrollableArea;
  33
  34 enum LayerType {
  35     NoLayer,
  36     NormalLayer,
  37     // A forced or overflow clip layer is required for bookkeeping purposes,
  38     // but does not force a layer to be self painting.
  39     OverflowClipLayer,
  40     ForcedLayer
  41 };
  42
  43 class RenderLayerModelObject : public RenderObject {
  44 public:
  45     explicit RenderLayerModelObject(ContainerNode*);
  46     virtual ~RenderLayerModelObject();
  47
  48     // This is the only way layers should ever be destroyed.
  49     void destroyLayer();
  50
  51     bool hasSelfPaintingLayer() const;
  52     RenderLayer* layer() const { return m_layer.get(); }
  53     ScrollableArea* scrollableArea() const;
  54
  55     virtual void styleWillChange(StyleDifference, const RenderStyle& newStyle) OVERRIDE;
  56     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle) OVERRIDE;
  57     virtual void updateFromStyle() { }
  58
  59     virtual LayerType layerTypeRequired() const = 0;
  60
  61     // Returns true if the background is painted opaque in the given rect.
  62     // The query rect is given in local coordinate system.
  63     virtual bool backgroundIsKnownToBeOpaqueInRect(const LayoutRect&) const { return false; }
  64
  65     // This is null for anonymous renderers.
  66     ContainerNode* node() const { return toContainerNode(RenderObject::node()); }
  67
  68     virtual void invalidateTreeIfNeeded(const PaintInvalidationState&) OVERRIDE;
  69 protected:
  70     void createLayer(LayerType);
  71
  72     virtual void willBeDestroyed() OVERRIDE;
  73
  74     virtual void addLayerHitTestRects(LayerHitTestRects&, const RenderLayer*, const LayoutPoint&, const LayoutRect&) const OVERRIDE;
  75
  76     virtual InvalidationReason invalidatePaintIfNeeded(const PaintInvalidationState&, const RenderLayerModelObject& newPaintInvalidationContainer);
  77 private:
  78     virtual bool isLayerModelObject() const OVERRIDE FINAL { return true; }
  79
  80     OwnPtr<RenderLayer> m_layer;
  81
  82     // Used to store state between styleWillChange and styleDidChange
  83     static bool s_wasFloating;
  84 };
  85
  86 DEFINE_RENDER_OBJECT_TYPE_CASTS(RenderLayerModelObject, isLayerModelObject());
  87
  88 } // namespace blink
  89
  90 #endif // RenderLayerModelObject_h