Remove an outdated comment from RenderBox.
[WebKit-https.git] / WebCore / rendering / RenderBox.h
1 /*
2  * This file is part of the DOM implementation for KDE.
3  *
4  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
5  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
6  * Copyright (C) 2003 Apple Computer, Inc.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  *
23  */
24
25 #ifndef RENDER_BOX_H
26 #define RENDER_BOX_H
27
28 #include "loader.h"
29 #include "RenderLayer.h"
30
31 namespace WebCore {
32     class CachedObject;
33     
34     enum WidthType { Width, MinWidth, MaxWidth };
35     enum HeightType { Height, MinHeight, MaxHeight };
36     
37 class RenderBox : public RenderObject
38 {
39 public:
40     RenderBox(WebCore::Node* node);
41     virtual ~RenderBox();
42
43     virtual const char *renderName() const { return "RenderBox"; }
44
45     virtual void setStyle(RenderStyle *style);
46     virtual void paint(PaintInfo& i, int _tx, int _ty);
47     virtual bool nodeAtPoint(NodeInfo& i, int _x, int _y, int _tx, int _ty, HitTestAction hitTestAction);
48
49     virtual void destroy();
50     
51     virtual int minWidth() const { return m_minWidth; }
52     virtual int maxWidth() const { return m_maxWidth; }
53
54     virtual int contentWidth() const;
55     virtual int contentHeight() const;
56
57     virtual int overrideSize() const { return m_overrideSize; }
58     virtual int overrideWidth() const;
59     virtual int overrideHeight() const;
60     virtual void setOverrideSize(int s) { m_overrideSize = s; }
61     
62     virtual bool absolutePosition(int &xPos, int &yPos, bool f = false);
63
64     virtual void setPos( int xPos, int yPos );
65
66     virtual int xPos() const { return m_x; }
67     virtual int yPos() const { return m_y; }
68     virtual int width() const;
69     virtual int height() const;
70
71     virtual int marginTop() const { return m_marginTop; }
72     virtual int marginBottom() const { return m_marginBottom; }
73     virtual int marginLeft() const { return m_marginLeft; }
74     virtual int marginRight() const { return m_marginRight; }
75
76     virtual void setWidth( int width ) { m_width = width; }
77     virtual void setHeight( int height ) { m_height = height; }
78
79     virtual IntRect borderBox() const { return IntRect(0, -borderTopExtra(), width(), height() + borderTopExtra() + borderBottomExtra()); }
80
81     int calcBorderBoxWidth(int w) const;
82     int calcBorderBoxHeight(int h) const;
83     int calcContentBoxWidth(int w) const;
84     int calcContentBoxHeight(int h) const;
85     
86     // This method is now public so that centered objects like tables that are
87     // shifted right by left-aligned floats can recompute their left and
88     // right margins (so that they can remain centered after being 
89     // shifted. -dwh
90     void calcHorizontalMargins(const Length& ml, const Length& mr, int cw);
91
92     virtual void position(InlineBox* box, int from, int len, bool reverse, bool override);
93     
94     virtual void dirtyLineBoxes(bool fullLayout, bool isRootLineBox=false);
95
96     // For inline replaced elements, this function returns the inline box that owns us.  Enables
97     // the replaced RenderObject to quickly determine what line it is contained on and to easily
98     // iterate over structures on the line.
99     virtual InlineBox* inlineBoxWrapper() const;
100     virtual void setInlineBoxWrapper(InlineBox* b);
101     virtual void deleteLineBoxWrapper();
102     
103     virtual int lowestPosition(bool includeOverflowInterior=true, bool includeSelf=true) const;
104     virtual int rightmostPosition(bool includeOverflowInterior=true, bool includeSelf=true) const;
105     virtual int leftmostPosition(bool includeOverflowInterior=true, bool includeSelf=true) const;
106
107     virtual IntRect getAbsoluteRepaintRect();
108     virtual void computeAbsoluteRepaintRect(IntRect& r, bool f=false);
109
110     virtual void repaintDuringLayoutIfMoved(int oldX, int oldY);
111     
112     virtual int containingBlockWidth() const;
113
114     virtual void calcWidth();
115     virtual void calcHeight();
116
117     // Whether or not the element shrinks to its intrinsic width (rather than filling the width
118     // of a containing block).  HTML4 buttons, <select>s, <input>s, legends, and floating/compact elements do this.
119     bool sizesToIntrinsicWidth(WidthType widthType) const;
120
121     int calcWidthUsing(WidthType widthType, int cw, LengthType& lengthType);
122     int calcHeightUsing(const Length& height);
123     int calcReplacedWidthUsing(WidthType widthType) const;
124     int calcReplacedHeightUsing(HeightType heightType) const;
125     
126     virtual int calcReplacedWidth() const;
127     virtual int calcReplacedHeight() const;
128
129     int calcPercentageHeight(const Length& height);
130
131     virtual int availableHeight() const;
132     int availableHeightUsing(const Length& h) const;
133     
134     void calcVerticalMargins();
135
136     void relativePositionOffset(int &tx, int &ty);
137
138     virtual RenderLayer* layer() const { return m_layer; }
139     
140     virtual IntRect caretRect(int offset, EAffinity affinity = UPSTREAM, int *extraWidthToEndOfLine = 0);
141
142     virtual void paintBackgroundExtended(GraphicsContext*, const Color& c, const BackgroundLayer* bgLayer, int clipy, int cliph,
143                                          int _tx, int _ty, int w, int height,
144                                          int bleft, int bright, int pleft, int pright);
145
146     virtual void setStaticX(int staticX);
147     virtual void setStaticY(int staticY);
148     virtual int staticX() const { return m_staticX; }
149     virtual int staticY() const { return m_staticY; }
150
151 protected:
152     virtual void paintBoxDecorations(PaintInfo& i, int _tx, int _ty);
153     void paintRootBoxDecorations(PaintInfo& i, int _tx, int _ty);
154
155     void paintBackgrounds(GraphicsContext*, const Color&, const BackgroundLayer*, int clipy, int cliph, int _tx, int _ty, int w, int h);
156     void paintBackground(GraphicsContext*, const Color&, const BackgroundLayer*, int clipy, int cliph, int _tx, int _ty, int w, int h);
157     void outlineBox(GraphicsContext*, int _tx, int _ty, const char *color = "red");
158
159     void calcAbsoluteHorizontal();
160     void calcAbsoluteVertical();
161     void calcAbsoluteHorizontalValues(WidthType widthType, RenderObject* cb, int cw, int pab, int static_distance,
162                                       int l, int r, int& w, int& ml, int& mr, int& x);
163     void calcAbsoluteVerticalValues(HeightType heightType, RenderObject* cb, int ch, int pab, 
164                                     int t, int b, int& h, int& mt, int& mb, int& y); 
165     
166     virtual IntRect getOverflowClipRect(int tx, int ty);
167     virtual IntRect getClipRect(int tx, int ty);
168
169     // the actual height of the contents + borders + padding
170     int m_height;
171
172     int m_y;
173
174     int m_x;
175     int m_width;
176
177     int m_marginTop;
178     int m_marginBottom;
179
180     int m_marginLeft;
181     int m_marginRight;
182
183     /*
184      * the minimum width the element needs, to be able to render
185      * it's content without clipping
186      */
187     int m_minWidth;
188     /* The maximum width the element can fill horizontally
189      * ( = the width of the element with line breaking disabled)
190      */
191     int m_maxWidth;
192
193     // Used by flexible boxes when flexing this element.
194     int m_overrideSize;
195
196     // Cached normal flow values for absolute positioned elements with static left/top values.
197     int m_staticX;
198     int m_staticY;
199     
200     // A pointer to our layer if we have one.  Currently only positioned elements
201     // and floaters have layers.
202     RenderLayer* m_layer;
203     
204     // For inline replaced elements, the inline box that owns us.
205     InlineBox* m_inlineBoxWrapper;
206 };
207
208 } //namespace
209
210 #endif