Source/WebCore/rendering/RenderRegion.h

   1 /*
   2  * Copyright 2011 Adobe Systems Incorporated. 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  *
   8  * 1. Redistributions of source code must retain the above
   9  *    copyright notice, this list of conditions and the following
  10  *    disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above
  12  *    copyright notice, this list of conditions and the following
  13  *    disclaimer in the documentation and/or other materials
  14  *    provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER “AS IS” AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE
  20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  21  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  23  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  25  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
  26  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #ifndef RenderRegion_h
  31 #define RenderRegion_h
  32
  33 #include "RenderReplaced.h"
  34
  35 namespace WebCore {
  36
  37 class RenderBox;
  38 class RenderBoxRegionInfo;
  39 class RenderFlowThread;
  40
  41 class RenderRegion : public RenderReplaced {
  42 public:
  43     explicit RenderRegion(Node*, RenderFlowThread*);
  44     virtual ~RenderRegion();
  45
  46     virtual bool isRenderRegion() const { return true; }
  47
  48     virtual void paintReplaced(PaintInfo&, const LayoutPoint&);
  49     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const LayoutPoint& pointInContainer, const LayoutPoint& accumulatedOffset, HitTestAction);
  50
  51     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
  52
  53     void setRegionRect(const LayoutRect& rect) { m_regionRect = rect; }
  54     LayoutRect regionRect() const { return m_regionRect; }
  55     LayoutRect regionOverflowRect() const;
  56
  57     void attachRegion();
  58     void detachRegion();
  59
  60     RenderFlowThread* parentFlowThread() const { return m_parentFlowThread; }
  61
  62     // Valid regions do not create circular dependencies with other flows.
  63     bool isValid() const { return m_isValid; }
  64     void setIsValid(bool valid) { m_isValid = valid; }
  65
  66     bool hasCustomRegionStyle() const { return m_hasCustomRegionStyle; }
  67     void setHasCustomRegionStyle(bool hasCustomRegionStyle) { m_hasCustomRegionStyle = hasCustomRegionStyle; }
  68
  69     virtual void layout();
  70
  71     RenderBoxRegionInfo* renderBoxRegionInfo(const RenderBox*) const;
  72     RenderBoxRegionInfo* setRenderBoxRegionInfo(const RenderBox*, LayoutUnit logicalLeftInset, LayoutUnit logicalRightInset,
  73         bool containingBlockChainIsInset);
  74     RenderBoxRegionInfo* takeRenderBoxRegionInfo(const RenderBox*);
  75     void removeRenderBoxRegionInfo(const RenderBox*);
  76
  77     void deleteAllRenderBoxRegionInfo();
  78
  79     LayoutUnit offsetFromLogicalTopOfFirstPage() const;
  80
  81     bool isFirstRegion() const;
  82     bool isLastRegion() const;
  83
  84 private:
  85     virtual const char* renderName() const { return "RenderRegion"; }
  86
  87     RenderFlowThread* m_flowThread;
  88
  89     // If this RenderRegion is displayed as part of another flow,
  90     // we need to create a dependency tree, so that layout of the
  91     // regions is always done before the regions themselves.
  92     RenderFlowThread* m_parentFlowThread;
  93     LayoutRect m_regionRect;
  94
  95     // This map holds unique information about a block that is split across regions.
  96     // A RenderBoxRegionInfo* tells us about any layout information for a RenderBox that
  97     // is unique to the region. For now it just holds logical width information for RenderBlocks, but eventually
  98     // it will also hold a custom style for any box (for region styling).
  99     HashMap<const RenderBox*, RenderBoxRegionInfo*> m_renderBoxRegionInfo;
 100
 101     bool m_isValid;
 102     bool m_hasCustomRegionStyle;
 103 };
 104
 105 inline RenderRegion* toRenderRegion(RenderObject* object)
 106 {
 107     ASSERT(!object || object->isRenderRegion());
 108     return static_cast<RenderRegion*>(object);
 109 }
 110
 111 inline const RenderRegion* toRenderRegion(const RenderObject* object)
 112 {
 113     ASSERT(!object || object->isRenderRegion());
 114     return static_cast<const RenderRegion*>(object);
 115 }
 116
 117 // This will catch anyone doing an unnecessary cast.
 118 void toRenderRegion(const RenderRegion*);
 119
 120 } // namespace WebCore
 121
 122 #endif // RenderRegion_h