Source/WebCore/rendering/RenderMultiColumnBlock.h

   1 /*
   2  * Copyright (C) 2012 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. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26
  27 #ifndef RenderMultiColumnBlock_h
  28 #define RenderMultiColumnBlock_h
  29
  30 #include "RenderBlock.h"
  31
  32 namespace WebCore {
  33
  34 class RenderMultiColumnFlowThread;
  35
  36 class RenderMultiColumnBlock : public RenderBlock {
  37 public:
  38     RenderMultiColumnBlock(Node*);
  39
  40     LayoutUnit columnHeight() const { return m_columnHeight; }
  41     void setColumnHeight(LayoutUnit columnHeight) { m_columnHeight = columnHeight; }
  42
  43     LayoutUnit columnWidth() const { return m_columnWidth; }
  44     unsigned columnCount() const { return m_columnCount; }
  45
  46 private:
  47     virtual bool isRenderMultiColumnBlock() const { return true; }
  48
  49     virtual const char* renderName() const;
  50
  51     virtual bool recomputeLogicalWidth() OVERRIDE;
  52     virtual void checkForPaginationLogicalHeightChange(LayoutUnit& pageLogicalHeight, bool& pageLogicalHeightChanged, bool& hasSpecifiedPageLogicalHeight) OVERRIDE;
  53     virtual bool relayoutForPagination(bool hasSpecifiedPageLogicalHeight, LayoutUnit pageLogicalHeight, LayoutStateMaintainer&) OVERRIDE;
  54
  55     virtual void addChild(RenderObject* newChild, RenderObject* beforeChild = 0) OVERRIDE;
  56
  57     void computeColumnCountAndWidth();
  58
  59     void ensureColumnSets();
  60
  61     RenderMultiColumnFlowThread* flowThread() const { return m_flowThread; }
  62
  63     RenderMultiColumnFlowThread* m_flowThread;
  64     unsigned m_columnCount;   // The default column count/width that are based off our containing block width. These values represent only the default,
  65     LayoutUnit m_columnWidth; // since a multi-column block that is split across variable width pages or regions will have different column counts and widths in each.
  66                               // These values will be cached (eventually) for multi-column blocks.
  67     LayoutUnit m_columnHeight; // The current column height.
  68 };
  69
  70 inline RenderMultiColumnBlock* toRenderMultiColumnBlock(RenderObject* object)
  71 {
  72     ASSERT(!object || object->isRenderMultiColumnBlock());
  73     return static_cast<RenderMultiColumnBlock*>(object);
  74 }
  75
  76 inline const RenderMultiColumnBlock* toRenderMultiColumnBlock(const RenderObject* object)
  77 {
  78     ASSERT(!object || object->isRenderMultiColumnBlock());
  79     return static_cast<const RenderMultiColumnBlock*>(object);
  80 }
  81
  82 // This will catch anyone doing an unnecessary cast.
  83 void toRenderMultiColumnBlock(const RenderMultiColumnBlock*);
  84
  85 } // namespace WebCore
  86
  87 #endif // RenderMultiColumnBlock_h
  88