[New Multicolumn] Rename methods to prepare for proper pagination of columns
[WebKit-https.git] / Source / WebCore / rendering / RenderMultiColumnSet.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 RenderMultiColumnSet_h
28 #define RenderMultiColumnSet_h
29
30 #include "RenderRegionSet.h"
31
32 namespace WebCore {
33
34 // RenderMultiColumnSet represents a set of columns that all have the same width and height. By combining runs of same-size columns into a single
35 // object, we significantly reduce the number of unique RenderObjects required to represent columns.
36 //
37 // A simple multi-column block will have exactly one RenderMultiColumnSet child. A simple paginated multi-column block will have three
38 // RenderMultiColumnSet children: one for the content at the bottom of the first page (whose columns will have a shorter height), one
39 // for the 2nd to n-1 pages, and then one last column set that will hold the shorter columns on the final page (that may have to be balanced
40 // as well).
41 //
42 // Column spans result in the creation of new column sets as well, since a spanning region has to be placed in between the column sets that
43 // come before and after the span.
44 class RenderMultiColumnSet : public RenderRegionSet {
45 public:
46     RenderMultiColumnSet(Node*, RenderFlowThread*);
47     
48     virtual bool isRenderMultiColumnSet() const OVERRIDE { return true; }
49
50     unsigned computedColumnCount() const { return m_computedColumnCount; }
51     LayoutUnit computedColumnWidth() const { return m_computedColumnWidth; }
52     LayoutUnit computedColumnHeight() const { return m_computedColumnHeight; }
53
54     void setComputedColumnWidthAndCount(LayoutUnit width, unsigned count)
55     {
56         m_computedColumnWidth = width;
57         m_computedColumnCount = count;
58     }
59     void setComputedColumnHeight(LayoutUnit height)
60     {
61         m_computedColumnHeight = height;
62     }
63
64 private:
65     virtual void computeLogicalWidth() OVERRIDE;
66     virtual void computeLogicalHeight() OVERRIDE;
67
68     virtual void paintReplaced(PaintInfo&, const LayoutPoint& paintOffset) OVERRIDE;
69     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation&, const LayoutPoint& accumulatedOffset, HitTestAction) OVERRIDE;
70
71     virtual LayoutUnit pageLogicalWidth() const OVERRIDE { return m_computedColumnWidth; }
72     virtual LayoutUnit pageLogicalHeight() const OVERRIDE { return m_computedColumnHeight; }
73
74     // FIXME: This will change once we have column sets constrained by enclosing pages, etc.
75     virtual LayoutUnit logicalHeightOfAllFlowThreadContent() const OVERRIDE { return m_computedColumnHeight; }
76     
77     virtual const char* renderName() const;
78     
79     void paintColumnRules(PaintInfo&, const LayoutPoint& paintOffset);
80     void paintColumnContents(PaintInfo&, const LayoutPoint& paintOffset);
81
82     LayoutUnit columnGap() const;
83     LayoutRect columnRectAt(unsigned index) const;
84     unsigned columnCount() const;
85
86     LayoutRect flowThreadPortionRectAt(unsigned index) const;
87     LayoutRect flowThreadPortionOverflowRect(const LayoutRect& flowThreadPortion, unsigned index, unsigned colCount, int colGap) const;
88
89     unsigned m_computedColumnCount;
90     LayoutUnit m_computedColumnWidth;
91     LayoutUnit m_computedColumnHeight;
92 };
93
94 } // namespace WebCore
95
96 #endif // RenderMultiColumnSet_h
97