Introduce RENDER_OBJECT_TYPE_CASTS to replace manual toFoo() in child render object
[WebKit-https.git] / Source / WebCore / rendering / RenderListBox.h
1 /*
2  * This file is part of the select element renderer in WebCore.
3  *
4  * Copyright (C) 2006, 2007, 2009 Apple Inc. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1.  Redistributions of source code must retain the above copyright
11  *     notice, this list of conditions and the following disclaimer. 
12  * 2.  Redistributions in binary form must reproduce the above copyright
13  *     notice, this list of conditions and the following disclaimer in the
14  *     documentation and/or other materials provided with the distribution. 
15  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
16  *     its contributors may be used to endorse or promote products derived
17  *     from this software without specific prior written permission. 
18  *
19  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef RenderListBox_h
32 #define RenderListBox_h
33
34 #include "RenderBlockFlow.h"
35 #include "ScrollableArea.h"
36
37 namespace WebCore {
38
39 class HTMLSelectElement;
40
41 class RenderListBox FINAL : public RenderBlockFlow, private ScrollableArea {
42 public:
43     explicit RenderListBox(HTMLSelectElement&);
44     virtual ~RenderListBox();
45
46     HTMLSelectElement& selectElement() const;
47
48     void selectionChanged();
49
50     void setOptionsChanged(bool changed) { m_optionsChanged = changed; }
51
52     int listIndexAtOffset(const LayoutSize&);
53     LayoutRect itemBoundingBoxRect(const LayoutPoint&, int index);
54
55     bool scrollToRevealElementAtListIndex(int index);
56     bool listIndexIsVisible(int index);
57
58     int scrollToward(const IntPoint&); // Returns the new index or -1 if no scroll occurred
59
60     int size() const;
61
62 private:
63     void element() const WTF_DELETED_FUNCTION;
64
65     virtual const char* renderName() const OVERRIDE { return "RenderListBox"; }
66
67     virtual bool isListBox() const OVERRIDE { return true; }
68
69     virtual void updateFromElement() OVERRIDE;
70     virtual bool canBeReplacedWithInlineRunIn() const OVERRIDE;
71     virtual bool hasControlClip() const OVERRIDE { return true; }
72     virtual void paintObject(PaintInfo&, const LayoutPoint&) OVERRIDE;
73     virtual LayoutRect controlClipRect(const LayoutPoint&) const OVERRIDE;
74
75     virtual bool isPointInOverflowControl(HitTestResult&, const LayoutPoint& locationInContainer, const LayoutPoint& accumulatedOffset) OVERRIDE;
76
77     virtual bool scroll(ScrollDirection, ScrollGranularity, float multiplier = 1, Element** stopElement = 0) OVERRIDE;
78     virtual bool logicalScroll(ScrollLogicalDirection, ScrollGranularity, float multiplier = 1, Element** stopElement = 0) OVERRIDE;
79
80     virtual void computeIntrinsicLogicalWidths(LayoutUnit& minLogicalWidth, LayoutUnit& maxLogicalWidth) const OVERRIDE;
81     virtual void computePreferredLogicalWidths() OVERRIDE;
82     virtual int baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const OVERRIDE;
83     virtual void computeLogicalHeight(LayoutUnit logicalHeight, LayoutUnit logicalTop, LogicalExtentComputedValues&) const OVERRIDE;
84
85     virtual void layout() OVERRIDE;
86
87     virtual void addFocusRingRects(Vector<IntRect>&, const LayoutPoint& additionalOffset, const RenderLayerModelObject* paintContainer = 0) OVERRIDE;
88
89     virtual bool canBeProgramaticallyScrolled() const OVERRIDE { return true; }
90     virtual void autoscroll(const IntPoint&) OVERRIDE;
91     virtual void stopAutoscroll() OVERRIDE;
92
93     virtual bool shouldPanScroll() const { return true; }
94     virtual void panScroll(const IntPoint&) OVERRIDE;
95
96     virtual int verticalScrollbarWidth() const OVERRIDE;
97     virtual int scrollLeft() const OVERRIDE;
98     virtual int scrollTop() const OVERRIDE;
99     virtual int scrollWidth() const OVERRIDE;
100     virtual int scrollHeight() const OVERRIDE;
101     virtual void setScrollLeft(int) OVERRIDE;
102     virtual void setScrollTop(int) OVERRIDE;
103
104     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) OVERRIDE;
105
106     // ScrollableArea interface.
107     virtual int scrollSize(ScrollbarOrientation) const OVERRIDE;
108     virtual int scrollPosition(Scrollbar*) const OVERRIDE;
109     virtual void setScrollOffset(const IntPoint&) OVERRIDE;
110     virtual void invalidateScrollbarRect(Scrollbar*, const IntRect&) OVERRIDE;
111     virtual bool isActive() const OVERRIDE;
112     virtual bool isScrollCornerVisible() const OVERRIDE { return false; } // We don't support resize on list boxes yet. If we did these would have to change.
113     virtual IntRect scrollCornerRect() const OVERRIDE { return IntRect(); }
114     virtual void invalidateScrollCornerRect(const IntRect&) OVERRIDE { }
115     virtual IntRect convertFromScrollbarToContainingView(const Scrollbar*, const IntRect&) const OVERRIDE;
116     virtual IntRect convertFromContainingViewToScrollbar(const Scrollbar*, const IntRect&) const OVERRIDE;
117     virtual IntPoint convertFromScrollbarToContainingView(const Scrollbar*, const IntPoint&) const OVERRIDE;
118     virtual IntPoint convertFromContainingViewToScrollbar(const Scrollbar*, const IntPoint&) const OVERRIDE;
119     virtual Scrollbar* verticalScrollbar() const OVERRIDE { return m_vBar.get(); }
120     virtual IntSize contentsSize() const OVERRIDE;
121     virtual int visibleHeight() const OVERRIDE;
122     virtual int visibleWidth() const OVERRIDE;
123     virtual IntPoint lastKnownMousePosition() const OVERRIDE;
124     virtual bool isHandlingWheelEvent() const OVERRIDE;
125     virtual bool shouldSuspendScrollAnimations() const OVERRIDE;
126     virtual bool updatesScrollLayerPositionOnMainThread() const OVERRIDE { return true; }
127
128     virtual ScrollableArea* enclosingScrollableArea() const OVERRIDE;
129     virtual IntRect scrollableAreaBoundingBox() const OVERRIDE;
130
131     // NOTE: This should only be called by the overriden setScrollOffset from ScrollableArea.
132     void scrollTo(int newOffset);
133
134     void setHasVerticalScrollbar(bool hasScrollbar);
135     PassRefPtr<Scrollbar> createScrollbar();
136     void destroyScrollbar();
137     
138     LayoutUnit itemHeight() const;
139     void valueChanged(unsigned listIndex);
140     int numVisibleItems() const;
141     int numItems() const;
142     LayoutUnit listHeight() const;
143     void paintScrollbar(PaintInfo&, const LayoutPoint&);
144     void paintItemForeground(PaintInfo&, const LayoutPoint&, int listIndex);
145     void paintItemBackground(PaintInfo&, const LayoutPoint&, int listIndex);
146     void scrollToRevealSelection();
147
148     bool m_optionsChanged;
149     bool m_scrollToRevealSelectionAfterLayout;
150     bool m_inAutoscroll;
151     int m_optionsWidth;
152     int m_indexOffset;
153
154     RefPtr<Scrollbar> m_vBar;
155 };
156
157 RENDER_OBJECT_TYPE_CASTS(RenderListBox, isListBox())
158
159 } // namepace WebCore
160
161 #endif // RenderListBox_h