Fix for 7837, make opacity work with table rows. Make transparent backgrounds
[WebKit-https.git] / WebCore / rendering / render_object.h
1 /*
2  * This file is part of the html renderer for KDE.
3  *
4  * Copyright (C) 2000 Lars Knoll (knoll@kde.org)
5  *           (C) 2000 Antti Koivisto (koivisto@kde.org)
6  *           (C) 2000 Dirk Mueller (mueller@kde.org)
7  * Copyright (C) 2003, 2004, 2005, 2006 Apple Computer, Inc.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public License
20  * along with this library; see the file COPYING.LIB.  If not, write to
21  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22  * Boston, MA 02111-1307, USA.
23  *
24  */
25
26 #ifndef render_object_h
27 #define render_object_h
28
29 #include "CachedObjectClient.h"
30 #include "KWQScrollBar.h"
31 #include "NodeImpl.h"
32 #include "render_style.h"
33 #include "text_affinity.h"
34 #include <kxmlcore/Assertions.h>
35 #include <kxmlcore/HashSet.h>
36
37 class CSSStyle;
38 class QMatrix;
39 class QTextStream;
40 class RenderArena;
41
42 #define KHTMLAssert(x) ASSERT(x)
43
44 /*
45  *  The painting of a layer occurs in three distinct phases.  Each phase involves
46  *  a recursive descent into the layer's render objects. The first phase is the background phase.
47  *  The backgrounds and borders of all blocks are painted.  Inlines are not painted at all.
48  *  Floats must paint above block backgrounds but entirely below inline content that can overlap them.
49  *  In the foreground phase, all inlines are fully painted.  Inline replaced elements will get all
50  *  three phases invoked on them during this phase.
51  */
52
53 namespace WebCore {
54
55 class AffineTransform;
56 class Color;
57 class CollapsedBorderValue;
58 class DOMString;
59 class DocumentImpl;
60 class ElementImpl;
61 class EventImpl;
62 class FloatRect;
63 class FrameView;
64 class HTMLAreaElementImpl;
65 class InlineBox;
66 class InlineFlowBox;
67 class Position;
68 class RenderBlock;
69 class RenderCanvas;
70 class RenderFlow;
71 class RenderFrameSet;
72 class RenderLayer;
73 class RenderTable;
74 class RenderText;
75 class VisiblePosition;
76
77 enum PaintAction {
78     PaintActionBlockBackground,
79     PaintActionChildBlockBackground,
80     PaintActionChildBlockBackgrounds,
81     PaintActionFloat,
82     PaintActionForeground,
83     PaintActionOutline,
84     PaintActionSelection,
85     PaintActionCollapsedTableBorders
86 };
87
88 enum HitTestFilter {
89     HitTestAll,
90     HitTestSelf,
91     HitTestDescendants
92 };
93
94 enum HitTestAction {
95     HitTestBlockBackground,
96     HitTestChildBlockBackground,
97     HitTestChildBlockBackgrounds,
98     HitTestFloat,
99     HitTestForeground
100 };
101
102 struct DashboardRegionValue
103 {
104     QString label;
105     IntRect bounds;
106     IntRect clip;
107     int type;
108
109     bool operator==(const DashboardRegionValue& o) const
110     {
111         return type == o.type && bounds == o.bounds && label == o.label;
112     }
113 };
114
115 // FIXME: This should be a HashSequencedSet, but we don't have that data structure yet.
116 // This means the paint order of outlines will be wrong, although this is a minor issue.
117 typedef HashSet<RenderFlow*> RenderFlowSequencedSet;
118
119 /**
120  * Base Class for all rendering tree objects.
121  */
122 class RenderObject : public CachedObjectClient
123 {
124 public:
125     // Anonymous objects should pass the document as their node, and they will then automatically be
126     // marked as anonymous in the constructor.
127     RenderObject(NodeImpl* node);
128     virtual ~RenderObject();
129
130     RenderObject *parent() const { return m_parent; }
131     bool hasAncestor(const RenderObject *obj) const;
132
133     RenderObject *previousSibling() const { return m_previous; }
134     RenderObject *nextSibling() const { return m_next; }
135
136     virtual RenderObject *firstChild() const { return 0; }
137     virtual RenderObject *lastChild() const { return 0; }
138
139     RenderObject *nextRenderer() const; 
140     RenderObject *previousRenderer() const; 
141
142     RenderObject *nextEditable() const; 
143     RenderObject *previousEditable() const; 
144
145     RenderObject *firstLeafChild() const;
146     RenderObject *lastLeafChild() const;
147     
148     virtual RenderLayer* layer() const { return 0; }
149     RenderLayer* enclosingLayer();
150     void addLayers(RenderLayer* parentLayer, RenderObject* newObject);
151     void removeLayers(RenderLayer* parentLayer);
152     void moveLayers(RenderLayer* oldParent, RenderLayer* newParent);
153     RenderLayer* findNextLayer(RenderLayer* parentLayer, RenderObject* startPoint,
154                                bool checkParent=true);
155     virtual void positionChildLayers() { }
156     virtual bool requiresLayer();
157     
158     virtual IntRect getOverflowClipRect(int tx, int ty) { return IntRect(0,0,0,0); }
159     virtual IntRect getClipRect(int tx, int ty) { return IntRect(0,0,0,0); }
160     bool hasClip() { return isPositioned() &&  style()->hasClip(); }
161     
162     virtual int getBaselineOfFirstLineBox() const { return -1; } 
163     virtual int getBaselineOfLastLineBox() const { return -1; }
164     virtual bool isEmpty() const { return firstChild() == 0; }
165         
166     virtual bool isEdited() const { return false; }
167     virtual void setEdited(bool) { return; };
168     
169     // Obtains the nearest enclosing block (including this block) that contributes a first-line style to our inline
170     // children.
171     virtual RenderBlock* firstLineBlock() const;
172     virtual void updateFirstLetter();
173     
174     // Called when an object that was floating or positioned becomes a normal flow object
175     // again.  We have to make sure the render tree updates as needed to accommodate the new
176     // normal flow object.
177     void handleDynamicFloatPositionChange();
178
179     // This function is a convenience helper for creating an anonymous block that inherits its
180     // style from this RenderObject.
181     RenderBlock* createAnonymousBlock();
182     
183     // Whether or not a positioned element requires normal flow x/y to be computed
184     // to determine its position.
185     bool hasStaticX() const;
186     bool hasStaticY() const;
187     virtual void setStaticX(int staticX) {};
188     virtual void setStaticY(int staticY) {};
189     virtual int staticX() const { return 0; }
190     virtual int staticY() const { return 0; }
191     
192     // RenderObject tree manipulation
193     //////////////////////////////////////////
194     virtual bool canHaveChildren() const;
195     virtual void addChild(RenderObject *newChild, RenderObject *beforeChild = 0);
196     virtual void removeChild(RenderObject *oldChild);
197
198     // raw tree manipulation
199     virtual RenderObject* removeChildNode(RenderObject* child);
200     virtual void appendChildNode(RenderObject* child);
201     virtual void insertChildNode(RenderObject* child, RenderObject* before);
202     //////////////////////////////////////////
203
204 protected:
205     //////////////////////////////////////////
206     // Helper functions. Dangerous to use!
207     void setPreviousSibling(RenderObject *previous) { m_previous = previous; }
208     void setNextSibling(RenderObject *next) { m_next = next; }
209     void setParent(RenderObject *parent) { m_parent = parent; }
210     //////////////////////////////////////////
211 private:
212     void addAbsoluteRectForLayer(IntRect& result);
213
214 public:
215     virtual const char *renderName() const { return "RenderObject"; }
216 #if !NDEBUG
217     QString information() const;
218     virtual void dump(QTextStream *stream, QString ind = "") const;
219     void showTree() const;
220     static void showTree(const RenderObject *ro);
221 #endif
222
223     static RenderObject *createObject(NodeImpl* node, RenderStyle* style);
224
225     // Overloaded new operator.  Derived classes must override operator new
226     // in order to allocate out of the RenderArena.
227     void* operator new(size_t sz, RenderArena* renderArena) throw();    
228
229     // Overridden to prevent the normal delete from being called.
230     void operator delete(void* ptr, size_t sz);
231         
232 private:
233     // The normal operator new is disallowed on all render objects.
234     void* operator new(size_t sz) throw();
235     
236 public:
237     RenderArena* renderArena() const;
238     
239     // some helper functions...
240     virtual bool isRenderBlock() const { return false; }
241     virtual bool isRenderInline() const { return false; }
242     virtual bool isInlineFlow() const { return false; }
243     virtual bool isBlockFlow() const { return false; }
244     virtual bool isInlineBlockOrInlineTable() const { return false; }
245     virtual bool childrenInline() const { return false; }
246     virtual void setChildrenInline(bool b) { };
247
248     virtual RenderFlow* continuation() const;
249     virtual bool isInlineContinuation() const;
250     
251     virtual bool isListItem() const { return false; }
252     virtual bool isListMarker() const { return false; }
253     virtual bool isCanvas() const { return false; }
254     bool isRoot() const;
255     bool isBody() const;
256     bool isHR() const;
257     virtual bool isBR() const { return false; }
258     virtual bool isTableCell() const { return false; }
259     virtual bool isTableRow() const { return false; }
260     virtual bool isTableSection() const { return false; }
261     virtual bool isTableCol() const { return false; }
262     virtual bool isTable() const { return false; }
263     virtual bool isWidget() const { return false; }
264     virtual bool isFormElement() const { return false; }
265     virtual bool isImage() const { return false; }
266     virtual bool isTextArea() const { return false; }
267     virtual bool isTextField() const { return false; }
268     virtual bool isFrameSet() const { return false; }
269     virtual bool isApplet() const { return false; }
270     
271 #if SVG_SUPPORT
272     virtual bool isKCanvasContainer() const { return false; }
273     virtual bool isRenderPath() const { return false; }
274     virtual FloatRect relativeBBox(bool includeStroke = true) const;
275     // We may eventually want to make these non-virtual
276     virtual QMatrix localTransform() const;
277     virtual void setLocalTransform(const QMatrix&);
278     virtual QMatrix absoluteTransform() const;
279 #endif
280     
281     virtual bool isEditable() const;
282
283     bool isHTMLMarquee() const;
284     
285     bool isAnonymous() const { return m_isAnonymous; }
286     void setIsAnonymous(bool b) { m_isAnonymous = b; }
287     bool isAnonymousBlock() const { return m_isAnonymous && 
288                                            style()->display() == BLOCK && 
289                                            style()->styleType() == RenderStyle::NOPSEUDO &&
290                                            !isListMarker(); }
291     
292     bool isFloating() const { return m_floating; }
293     bool isPositioned() const { return m_positioned; } // absolute or fixed positioning
294     bool isRelPositioned() const { return m_relPositioned; } // relative positioning
295     bool isText() const  { return m_isText; }
296     bool isInline() const { return m_inline; }  // inline object
297     bool isCompact() const { return style()->display() == COMPACT; } // compact object
298     bool isRunIn() const { return style()->display() == RUN_IN; } // run-in object
299     bool isDragging() const;
300     bool isReplaced() const { return m_replaced; } // a "replaced" element (see CSS)
301     bool shouldPaintBackgroundOrBorder() const { return m_paintBackground; }
302     bool mustRepaintBackgroundOrBorder() const;
303     bool needsLayout() const   { return m_needsLayout || m_normalChildNeedsLayout || m_posChildNeedsLayout; }
304     bool selfNeedsLayout() const { return m_needsLayout; }
305     bool posChildNeedsLayout() const { return m_posChildNeedsLayout; }
306     bool normalChildNeedsLayout() const { return m_normalChildNeedsLayout; }
307     bool minMaxKnown() const{ return m_minMaxKnown; }
308     bool recalcMinMax() const { return m_recalcMinMax; }
309     bool isSelectionBorder() const;
310     
311     bool hasOverflowClip() const { return m_hasOverflowClip; }
312     bool hasAutoScrollbars() const { return hasOverflowClip() && 
313         (style()->overflow() == OAUTO || style()->overflow() == OOVERLAY); }
314     bool scrollsOverflow() const { return hasOverflowClip() &&
315         (style()->overflow() == OSCROLL || hasAutoScrollbars()); }
316     bool includeScrollbarSize() const { return hasOverflowClip() &&
317         (style()->overflow() == OSCROLL || style()->overflow() == OAUTO); }
318
319     RenderStyle* getPseudoStyle(RenderStyle::PseudoId pseudo, RenderStyle* parentStyle = 0) const;
320     
321     void updateDragState(bool dragOn);
322
323     RenderCanvas* canvas() const;
324
325     // don't even think about making this method virtual!
326     NodeImpl* element() const { return m_isAnonymous ? 0 : m_node; }
327     DocumentImpl* document() const { return m_node->getDocument(); }
328     void setNode(NodeImpl* node) { m_node = node; }
329     NodeImpl* node() const { return m_node; }
330     
331    /**
332      * returns the object containing this one. can be different from parent for
333      * positioned elements
334      */
335     RenderObject *container() const;
336     RenderObject* hoverAncestor() const;
337
338     virtual void markAllDescendantsWithFloatsForLayout(RenderObject* floatToRemove = 0);
339     void markContainingBlocksForLayout();
340     void setNeedsLayout(bool b, bool markParents = true);
341     void setChildNeedsLayout(bool b, bool markParents = true);
342     void setMinMaxKnown(bool b=true) {
343         m_minMaxKnown = b;
344         if ( !b ) {
345             RenderObject *o = this;
346             RenderObject *root = this;
347             while( o ) { // ### && !o->m_recalcMinMax ) {
348                 o->m_recalcMinMax = true;
349                 root = o;
350                 o = o->m_parent;
351             }
352         }
353     }
354
355     void setNeedsLayoutAndMinMaxRecalc() {
356         setMinMaxKnown(false);
357         setNeedsLayout(true);
358     }
359     
360     void setPositioned(bool b=true)  { m_positioned = b;  }
361     void setRelPositioned(bool b=true) { m_relPositioned = b; }
362     void setFloating(bool b=true) { m_floating = b; }
363     void setInline(bool b=true) { m_inline = b; }
364     void setShouldPaintBackgroundOrBorder(bool b=true) { m_paintBackground = b; }
365     void setRenderText() { m_isText = true; }
366     void setReplaced(bool b=true) { m_replaced = b; }
367     void setHasOverflowClip(bool b = true) { m_hasOverflowClip = b; }
368
369     void scheduleRelayout();
370     
371     void updateBackgroundImages(RenderStyle* oldStyle);
372
373     virtual InlineBox* createInlineBox(bool makePlaceHolderBox, bool isRootLineBox, bool isOnlyRun=false);
374     virtual void dirtyLineBoxes(bool fullLayout, bool isRootLineBox=false);
375     
376     // For inline replaced elements, this function returns the inline box that owns us.  Enables
377     // the replaced RenderObject to quickly determine what line it is contained on and to easily
378     // iterate over structures on the line.
379     virtual InlineBox* inlineBoxWrapper() const;
380     virtual void setInlineBoxWrapper(InlineBox* b);
381     virtual void deleteLineBoxWrapper();
382
383     virtual InlineBox *inlineBox(int offset=0, EAffinity affinity = UPSTREAM);
384     
385     // for discussion of lineHeight see CSS2 spec
386     virtual short lineHeight( bool firstLine, bool isRootLineBox=false ) const;
387     // for the vertical-align property of inline elements
388     // the difference between this objects baseline position and the lines baseline position.
389     virtual short verticalPositionHint( bool firstLine ) const;
390     // the offset of baseline from the top of the object.
391     virtual short baselinePosition( bool firstLine, bool isRootLineBox=false ) const;
392     // width of tab character
393     int tabWidth() const;
394
395     /*
396      * Paint the object and its children, clipped by (x|y|w|h).
397      * (tx|ty) is the calculated position of the parent
398      */
399     struct PaintInfo {
400         PaintInfo(GraphicsContext* _p, const IntRect& _r, PaintAction _phase, RenderObject* _paintingRoot)
401             : p(_p), r(_r), phase(_phase), paintingRoot(_paintingRoot) {}
402         GraphicsContext* p;
403         IntRect r;
404         PaintAction phase;
405         RenderObject* paintingRoot; // used to draw just one element and its visual kids
406         RenderFlowSequencedSet outlineObjects; // used to list outlines that should be painted by a block with inline children
407     };
408     virtual void paint(PaintInfo&, int tx, int ty);
409     void paintBorder(GraphicsContext*, int tx, int ty, int w, int h, const RenderStyle*, bool begin = true, bool end = true);
410     bool paintBorderImage(GraphicsContext*, int tx, int ty, int w, int h, const RenderStyle* style);
411     void paintOutline(GraphicsContext*, int tx, int ty, int w, int h, const RenderStyle* style);
412
413     // RenderBox implements this.
414     virtual void paintBoxDecorations(PaintInfo&, int tx, int ty) {}
415
416     virtual void paintBackgroundExtended(GraphicsContext*, const Color&, const BackgroundLayer*, int clipy, int cliph,
417         int tx, int ty, int w, int height, int bleft, int bright, int pleft, int pright) {}
418
419     /*
420      * This function calculates the minimum & maximum width that the object
421      * can be set to.
422      *
423      * when the Element calls setMinMaxKnown(true), calcMinMaxWidth() will
424      * be no longer called.
425      *
426      * when a element has a fixed size, m_minWidth and m_maxWidth should be
427      * set to the same value. This has the special meaning that m_width,
428      * contains the actual value.
429      *
430      * assumes calcMinMaxWidth has already been called for all children.
431      */
432     virtual void calcMinMaxWidth() { }
433
434     /*
435      * Does the min max width recalculations after changes.
436      */
437     void recalcMinMaxWidths();
438
439     /*
440      * Calculates the actual width of the object (only for non inline
441      * objects)
442      */
443     virtual void calcWidth() {}
444
445     /*
446      * This function should cause the Element to calculate its
447      * width and height and the layout of its content
448      *
449      * when the Element calls setNeedsLayout(false), layout() is no
450      * longer called during relayouts, as long as there is no
451      * style sheet change. When that occurs, m_needsLayout will be
452      * set to true and the Element receives layout() calls
453      * again.
454      */
455     virtual void layout() = 0;
456
457     /* This function performs a layout only if one is needed. */
458     void layoutIfNeeded() { if (needsLayout()) layout(); }
459
460     // used for element state updates that can not be fixed with a
461     // repaint and do not need a relayout
462     virtual void updateFromElement() {};
463
464     virtual int availableHeight() const { return 0; }
465
466     virtual void updateWidgetPosition();
467     
468     QValueList<DashboardRegionValue> RenderObject::computeDashboardRegions();
469     void addDashboardRegions (QValueList<DashboardRegionValue>& regions);
470     void collectDashboardRegions (QValueList<DashboardRegionValue>& regions);
471
472     // does a query on the rendertree and finds the innernode
473     // and overURL for the given position
474     // if readonly == false, it will recalc hover styles accordingly
475     class NodeInfo
476     {
477         friend class RenderLayer;
478         friend class RenderImage;
479         friend class RenderText;
480         friend class RenderInline;
481         friend class RenderObject;
482         friend class RenderFrameSet;
483         friend class HTMLAreaElementImpl;
484     public:
485         NodeInfo(bool readonly, bool active, bool mouseMove = false)
486             : m_innerNode(0), m_innerNonSharedNode(0), m_innerURLElement(0), m_readonly(readonly), m_active(active), m_mouseMove(mouseMove)
487             { }
488
489         NodeImpl* innerNode() const { return m_innerNode; }
490         NodeImpl* innerNonSharedNode() const { return m_innerNonSharedNode; }
491         ElementImpl* URLElement() const { return m_innerURLElement; }
492         bool readonly() const { return m_readonly; }
493         bool active() const { return m_active; }
494         bool mouseMove() const { return m_mouseMove; }
495         
496         void setInnerNode(NodeImpl* n) { m_innerNode = n; }
497         void setInnerNonSharedNode(NodeImpl* n) { m_innerNonSharedNode = n; }
498         void setURLElement(ElementImpl* n) { m_innerURLElement = n; }
499
500     private:
501         NodeImpl* m_innerNode;
502         NodeImpl* m_innerNonSharedNode;
503         ElementImpl* m_innerURLElement;
504         bool m_readonly;
505         bool m_active;
506         bool m_mouseMove;
507     };
508
509     // Used to signal a specific subrect within an object that must be repainted after
510     // layout is complete.
511     struct RepaintInfo {
512         RenderObject* m_object;
513         IntRect m_repaintRect;
514     
515         RepaintInfo(RenderObject* o, const IntRect& r) :m_object(o), m_repaintRect(r) {}
516     };
517     
518     bool hitTest(NodeInfo& info, int x, int y, int tx, int ty, HitTestFilter hitTestFilter = HitTestAll);
519     virtual bool nodeAtPoint(NodeInfo& info, int x, int y, int tx, int ty,
520                              HitTestAction hitTestAction);
521     void setInnerNode(NodeInfo& info);
522
523     virtual VisiblePosition positionForCoordinates(int x, int y);
524     
525     virtual void dirtyLinesFromChangedChild(RenderObject* child);
526     
527     // Set the style of the object and update the state of the object accordingly.
528     virtual void setStyle(RenderStyle* style);
529
530     // Updates only the local style ptr of the object.  Does not update the state of the object,
531     // and so only should be called when the style is known not to have changed (or from setStyle).
532     void setStyleInternal(RenderStyle* style);
533
534     // returns the containing block level element for this element.
535     RenderBlock *containingBlock() const;
536
537     // return just the width of the containing block
538     virtual int containingBlockWidth() const;
539     // return just the height of the containing block
540     virtual int containingBlockHeight() const;
541
542     // size of the content area (box size minus padding/border)
543     virtual int contentWidth() const { return 0; }
544     virtual int contentHeight() const { return 0; }
545
546     // intrinsic extend of replaced elements. undefined otherwise
547     virtual int intrinsicWidth() const { return 0; }
548     virtual int intrinsicHeight() const { return 0; }
549
550     // used by flexible boxes to impose a flexed width/height override
551     virtual int overrideSize() const { return 0; }
552     virtual int overrideWidth() const { return 0; }
553     virtual int overrideHeight() const { return 0; }
554     virtual void setOverrideSize(int s) {}
555
556     // relative to parent node
557     virtual void setPos( int /*xPos*/, int /*yPos*/ ) { }
558     virtual void setWidth( int /*width*/ ) { }
559     virtual void setHeight( int /*height*/ ) { }
560
561     virtual int xPos() const { return 0; }
562     virtual int yPos() const { return 0; }
563
564     // calculate client position of box
565     virtual bool absolutePosition(int &/*xPos*/, int &/*yPos*/, bool fixed = false);
566     
567     // This function is used to deal with the extra top space that can occur in table cells (called borderTopExtra).
568     // The children of the cell do not factor this space in, so we have to add it in.  Any code that wants to
569     // accurately deal with the contents of a cell must call this function instad of absolutePosition.
570     void absolutePositionForContent(int& xPos, int& yPos, bool fixed = false) {
571         absolutePosition(xPos, yPos, fixed);
572         yPos += borderTopExtra();
573     }
574
575     // width and height are without margins but include paddings and borders
576     virtual int width() const { return 0; }
577     virtual int height() const { return 0; }
578
579     virtual IntRect borderBox() const { return IntRect(0, 0, width(), height()); }
580
581     // The height of a block when you include normal flow overflow spillage out of the bottom
582     // of the block (e.g., a <div style="height:25px"> that has a 100px tall image inside
583     // it would have an overflow height of borderTop() + paddingTop() + 100px.
584     virtual int overflowHeight(bool includeInterior=true) const { return height(); }
585     virtual int overflowWidth(bool includeInterior=true) const { return width(); }
586     virtual void setOverflowHeight(int) {}
587     virtual void setOverflowWidth(int) {}
588     virtual int overflowLeft(bool includeInterior=true) const { return 0; }
589     virtual int overflowTop(bool includeInterior=true) const { return 0; }
590     virtual IntRect overflowRect(bool includeInterior=true) const { return borderBox(); }
591
592     // IE extensions. Used to calculate offsetWidth/Height.  Overridden by inlines (render_flow) 
593     // to return the remaining width on a given line (and the height of a single line). -dwh
594     virtual int offsetWidth() const { return width(); }
595     virtual int offsetHeight() const { return height() + borderTopExtra() + borderBottomExtra(); }
596     
597     // IE exxtensions.  Also supported by Gecko.  We override in render flow to get the
598     // left and top correct. -dwh
599     virtual int offsetLeft() const;
600     virtual int offsetTop() const;
601     virtual RenderObject* offsetParent() const;
602
603     // More IE extensions.  clientWidth and clientHeight represent the interior of an object
604     // excluding border and scrollbar.
605     int clientWidth() const;
606     int clientHeight() const;
607
608     // scrollWidth/scrollHeight will be the same as clientWidth/clientHeight unless the
609     // object has overflow:hidden/scroll/auto specified and also has overflow.
610     int scrollWidth() const;
611     int scrollHeight() const;
612     
613     virtual bool scroll(KWQScrollDirection direction, KWQScrollGranularity granularity, float multiplier=1.0);
614
615     // The following seven functions are used to implement collapsing margins.
616     // All objects know their maximal positive and negative margins.  The
617     // formula for computing a collapsed margin is |maxPosMargin|-|maxNegmargin|.
618     // For a non-collapsing, e.g., a leaf element, this formula will simply return
619     // the margin of the element.  Blocks override the maxTopMargin and maxBottomMargin
620     // methods.
621     virtual bool isSelfCollapsingBlock() const { return false; }
622     virtual int collapsedMarginTop() const 
623         { return maxTopMargin(true)-maxTopMargin(false); }
624     virtual int collapsedMarginBottom() const 
625         { return maxBottomMargin(true)-maxBottomMargin(false); }
626     virtual bool isTopMarginQuirk() const { return false; }
627     virtual bool isBottomMarginQuirk() const { return false; }
628     virtual int maxTopMargin(bool positive) const {
629         if (positive)
630             if (marginTop() > 0)
631                 return marginTop();
632             else
633                 return 0;
634         else
635             if (marginTop() < 0)
636                 return 0 - marginTop();
637             else
638                 return 0;
639     }
640     virtual int maxBottomMargin(bool positive) const {
641         if (positive)
642             if (marginBottom() > 0)
643                 return marginBottom();
644             else
645                 return 0;
646         else
647             if (marginBottom() < 0)
648                 return 0 - marginBottom();
649             else
650                 return 0;
651     }
652
653     virtual int marginTop() const { return 0; }
654     virtual int marginBottom() const { return 0; }
655     virtual int marginLeft() const { return 0; }
656     virtual int marginRight() const { return 0; }
657
658     // Virtual since table cells override 
659     virtual int paddingTop() const;
660     virtual int paddingBottom() const;
661     virtual int paddingLeft() const;
662     virtual int paddingRight() const;
663     
664     virtual int borderTop() const { return style()->borderTopWidth(); }
665     virtual int borderBottom() const { return style()->borderBottomWidth(); }
666     virtual int borderTopExtra() const { return 0; }
667     virtual int borderBottomExtra() const { return 0; }
668     virtual int borderLeft() const { return style()->borderLeftWidth(); }
669     virtual int borderRight() const { return style()->borderRightWidth(); }
670
671     virtual QValueList<IntRect> lineBoxRects();
672
673     virtual void absoluteRects(QValueList<IntRect>& rects, int tx, int ty);
674     IntRect absoluteBoundingBoxRect();
675     
676     // the rect that will be painted if this object is passed as the paintingRoot
677     IntRect paintingRootRect(IntRect& topLevelRect);
678
679     virtual void addFocusRingRects(GraphicsContext*, int tx, int ty);
680
681     virtual int minWidth() const { return 0; }
682     virtual int maxWidth() const { return 0; }
683
684     RenderStyle* style() const { return m_style; }
685     RenderStyle* firstLineStyle() const;
686     RenderStyle* style(bool firstLine) const { return firstLine ? firstLineStyle() : style(); }
687
688
689     void getTextDecorationColors(int decorations, Color& underline, Color& overline,
690                                  Color& linethrough, bool quirksMode=false);
691
692     enum BorderSide {
693         BSTop, BSBottom, BSLeft, BSRight
694     };
695     void drawBorder(GraphicsContext*, int x1, int y1, int x2, int y2, BorderSide,
696         Color, const Color& textcolor, EBorderStyle, int adjbw1, int adjbw2, bool invalidisInvert = false);
697
698     virtual void setTable(RenderTable*) {};
699
700     // Used by collapsed border tables.
701     virtual void collectBorders(QValueList<CollapsedBorderValue>& borderStyles);
702
703     // Repaint the entire object.  Called when, e.g., the color of a border changes, or when a border
704     // style changes.
705     void repaint(bool immediate = false);
706
707     // Repaint a specific subrectangle within a given object.  The rect |r| is in the object's coordinate space.
708     void repaintRectangle(const IntRect& r, bool immediate = false);
709     
710     // Repaint only if our old bounds and new bounds are different.
711     bool repaintAfterLayoutIfNeeded(const IntRect& oldBounds, const IntRect& oldFullBounds);
712
713     // Repaint only if the object moved.
714     virtual void repaintDuringLayoutIfMoved(int oldX, int oldY);
715
716     // Called to repaint a block's floats.
717     virtual void repaintFloatingDescendants();
718
719     // Called before layout to repaint all dirty children (with selfNeedsLayout() set).
720     virtual void repaintObjectsBeforeLayout();
721
722     bool checkForRepaintDuringLayout() const;
723
724     // Returns the rect that should be repainted whenever this object changes.  The rect is in the view's
725     // coordinate space.  This method deals with outlines and overflow.
726     virtual IntRect getAbsoluteRepaintRect();
727
728     IntRect getAbsoluteRepaintRectWithOutline(int ow);
729
730     virtual void getAbsoluteRepaintRectIncludingFloats(IntRect& bounds, IntRect& boundsWithChildren);
731
732     // Given a rect in the object's coordinate space, this method converts the rectangle to the view's
733     // coordinate space.
734     virtual void computeAbsoluteRepaintRect(IntRect& r, bool f=false);
735     
736     virtual unsigned int length() const { return 1; }
737
738     bool isFloatingOrPositioned() const { return (isFloating() || isPositioned()); };
739     virtual bool containsFloats() { return false; }
740     virtual bool containsFloat(RenderObject* o) { return false; }
741     virtual bool hasOverhangingFloats() { return false; }
742     virtual IntRect floatRect() const { return borderBox(); }
743
744     bool avoidsFloats() const;
745     bool usesLineWidth() const;
746
747     // positioning of inline children (bidi)
748     virtual void position(InlineBox*, int, int, bool, bool) {}
749
750     bool isTransparent() const { return style()->opacity() < 1.0f; }
751     float opacity() const { return style()->opacity(); }
752
753     // Applied as a "slop" to dirty rect checks during the outline painting phase's dirty-rect checks.
754     int maximalOutlineSize(PaintAction p) const;
755
756     enum SelectionState {
757         SelectionNone, // The object is not selected.
758         SelectionStart, // The object either contains the start of a selection run or is the start of a run
759         SelectionInside, // The object is fully encompassed by a selection run
760         SelectionEnd, // The object either contains the end of a selection run or is the end of a run
761         SelectionBoth // The object contains an entire run or is the sole selected object in that run
762     };
763
764     // The current selection state for an object.  For blocks, the state refers to the state of the leaf
765     // descendants (as described above in the SelectionState enum declaration).
766     virtual SelectionState selectionState() const { return SelectionNone; }
767     
768     // Sets the selection state for an object.
769     virtual void setSelectionState(SelectionState s) { if (parent()) parent()->setSelectionState(s); }
770
771     // A single rectangle that encompasses all of the selected objects within this object.  Used to determine the tightest
772     // possible bounding box for the selection.
773     virtual IntRect selectionRect() { return IntRect(); }
774     
775     // Whether or not an object can be part of the leaf elements of the selection.
776     virtual bool canBeSelectionLeaf() const { return false; }
777
778     // Whether or not a block has selected children.
779     virtual bool hasSelectedChildren() const { return false; }
780
781     // Whether or not a selection can be attempted on this object.
782     bool canSelect() const;
783
784     // Whether or not a selection can be attempted on this object.  Should only be called right before actually beginning a selection,
785     // since it fires the selectstart DOM event.
786     bool shouldSelect() const;
787     
788     // Obtains the selection background color that should be used when painting a selection.
789     virtual Color selectionColor(GraphicsContext*) const;
790     
791     // Whether or not a given block needs to paint selection gaps.
792     virtual bool shouldPaintSelectionGaps() const { return false; }
793
794     // This struct is used when the selection changes to cache the old and new state of the selection for each RenderObject.
795     struct SelectionInfo {
796         RenderObject* m_object;
797         IntRect m_rect;
798         RenderObject::SelectionState m_state;
799
800         RenderObject* object() const { return m_object; }
801         IntRect rect() const { return m_rect; }
802         SelectionState state() const { return m_state; }
803         
804         SelectionInfo() { m_object = 0; m_state = SelectionNone; }
805         SelectionInfo(RenderObject* o) :m_object(o), m_rect(o->selectionRect()), m_state(o->selectionState()) {}
806     };
807
808     NodeImpl* draggableNode(bool dhtmlOK, bool uaOK, int x, int y, bool& dhtmlWillDrag) const;
809
810     /**
811      * Returns the content coordinates of the caret within this render object.
812      * @param offset zero-based offset determining position within the render object.
813      * @param override @p true if input overrides existing characters,
814      * @p false if it inserts them. The width of the caret depends on this one.
815      * @param extraWidthToEndOfLine optional out arg to give extra width to end of line -
816      * useful for character range rect computations
817      */
818     virtual IntRect caretRect(int offset, EAffinity affinity = UPSTREAM, int *extraWidthToEndOfLine = 0);
819
820     virtual int lowestPosition(bool includeOverflowInterior=true, bool includeSelf=true) const { return 0; }
821     virtual int rightmostPosition(bool includeOverflowInterior=true, bool includeSelf=true) const { return 0; }
822     virtual int leftmostPosition(bool includeOverflowInterior=true, bool includeSelf=true) const { return 0; }
823     
824     virtual void calcVerticalMargins() {}
825     void removeFromObjectLists();
826
827     // When performing a global document tear-down, the renderer of the document is cleared.  We use this
828     // as a hook to detect the case of document destruction and don't waste time doing unnecessary work.
829     bool documentBeingDestroyed() const;
830
831     virtual void destroy();
832
833     const Font& font(bool firstLine) const {
834         return style(firstLine)->font();
835     }
836
837     // Virtual function helpers for CSS3 Flexible Box Layout
838     virtual bool isFlexibleBox() const { return false; }
839     virtual bool isFlexingChildren() const { return false; }
840     virtual bool isStretchingChildren() const { return false; }
841
842     // Convenience, to avoid repeating the code to dig down to get this.
843     QChar backslashAsCurrencySymbol() const;
844
845     virtual int caretMinOffset() const;
846     virtual int caretMaxOffset() const;
847     virtual unsigned caretMaxRenderedOffset() const;
848
849     virtual int previousOffset (int current) const;
850     virtual int nextOffset (int current) const;
851
852     virtual void imageChanged(CachedImage*);
853     virtual bool willRenderImage(CachedImage*);
854
855     virtual void selectionStartEnd(int& spos, int& epos);
856
857     RenderObject* paintingRootForChildren(PaintInfo &i) const {
858         // if we're the painting root, kids draw normally, and see root of 0
859         return (!i.paintingRoot || i.paintingRoot == this) ? 0 : i.paintingRoot;
860     }
861
862     bool shouldPaintWithinRoot(PaintInfo &i) const {
863         return !i.paintingRoot || i.paintingRoot == this;
864     }
865     
866 protected:
867     virtual void printBoxDecorations(GraphicsContext*, int /*x*/, int /*y*/,
868         int /*w*/, int /*h*/, int /*tx*/, int /*ty*/) {}
869
870     virtual IntRect viewRect() const;
871
872     void remove();
873
874     void invalidateVerticalPositions();
875     short getVerticalPosition(bool firstLine) const;
876
877     virtual void removeLeftoverAnonymousBoxes();
878     
879     void arenaDelete(RenderArena*, void* objectBase);
880
881 private:
882     RenderStyle* m_style;
883
884     NodeImpl* m_node;
885
886     RenderObject *m_parent;
887     RenderObject *m_previous;
888     RenderObject *m_next;
889
890     mutable short m_verticalPosition;
891
892     bool m_needsLayout               : 1;
893     bool m_normalChildNeedsLayout    : 1;
894     bool m_posChildNeedsLayout       : 1;
895     bool m_minMaxKnown               : 1;
896     bool m_floating                  : 1;
897
898     bool m_positioned                : 1;
899     bool m_relPositioned             : 1;
900     bool m_paintBackground           : 1; // if the box has something to paint in the
901                                           // background painting phase (background, border, etc)
902
903     bool m_isAnonymous               : 1;
904     bool m_recalcMinMax              : 1;
905     bool m_isText                    : 1;
906     bool m_inline                    : 1;
907     bool m_replaced                  : 1;
908     bool m_isDragging                : 1;
909     
910     bool m_hasOverflowClip           : 1;
911
912     // note: do not add unnecessary bitflags, we have 32 bit already!
913     friend class RenderListItem;
914     friend class RenderContainer;
915     friend class RenderCanvas;
916 };
917
918
919 enum VerticalPositionHint {
920     PositionTop = -0x4000,
921     PositionBottom = 0x4000,
922     PositionUndefined = 0x3fff
923 };
924
925 } //namespace
926
927 #endif