24898cddb4764682921b8adfd6e0d62fc9ce134f
[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, 2014 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 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 #pragma once
32
33 #include "RenderBlockFlow.h"
34 #include "ScrollableArea.h"
35 #include <wtf/Optional.h>
36
37 namespace WebCore {
38
39 class HTMLSelectElement;
40
41 class RenderListBox final : public RenderBlockFlow, public ScrollableArea {
42 public:
43     RenderListBox(HTMLSelectElement&, RenderStyle&&);
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     bool scroll(ScrollDirection, ScrollGranularity, float multiplier = 1, Element** stopElement = nullptr, RenderBox* startBox = nullptr, const IntPoint& wheelEventAbsolutePoint = IntPoint()) override;
63
64     bool scrolledToTop() const override;
65     bool scrolledToBottom() const override;
66     bool scrolledToLeft() const override;
67     bool scrolledToRight() const override;
68
69 private:
70     void willBeDestroyed() override;
71
72     void element() const = delete;
73
74     const char* renderName() const override { return "RenderListBox"; }
75
76     bool isListBox() const override { return true; }
77
78     void updateFromElement() override;
79     bool hasControlClip() const override { return true; }
80     void paintObject(PaintInfo&, const LayoutPoint&) override;
81     LayoutRect controlClipRect(const LayoutPoint&) const override;
82
83     bool isPointInOverflowControl(HitTestResult&, const LayoutPoint& locationInContainer, const LayoutPoint& accumulatedOffset) override;
84
85     bool logicalScroll(ScrollLogicalDirection, ScrollGranularity, float multiplier = 1, Element** stopElement = nullptr) override;
86
87     void computeIntrinsicLogicalWidths(LayoutUnit& minLogicalWidth, LayoutUnit& maxLogicalWidth) const override;
88     void computePreferredLogicalWidths() override;
89     int baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const override;
90     LogicalExtentComputedValues computeLogicalHeight(LayoutUnit logicalHeight, LayoutUnit logicalTop) const override;
91
92     void layout() override;
93
94     void addFocusRingRects(Vector<LayoutRect>&, const LayoutPoint& additionalOffset, const RenderLayerModelObject* paintContainer = nullptr) override;
95
96     bool canBeProgramaticallyScrolled() const override { return true; }
97     void autoscroll(const IntPoint&) override;
98     void stopAutoscroll() override;
99
100     virtual bool shouldPanScroll() const { return true; }
101     void panScroll(const IntPoint&) override;
102
103     int verticalScrollbarWidth() const override;
104     int scrollLeft() const override;
105     int scrollTop() const override;
106     int scrollWidth() const override;
107     int scrollHeight() const override;
108     void setScrollLeft(int) override;
109     void setScrollTop(int) override;
110
111     bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) override;
112
113     // ScrollableArea interface.
114     int scrollSize(ScrollbarOrientation) const override;
115     int scrollOffset(ScrollbarOrientation) const override;
116     void setScrollOffset(const ScrollOffset&) override;
117     ScrollPosition minimumScrollPosition() const override;
118     ScrollPosition maximumScrollPosition() const override;
119     void invalidateScrollbarRect(Scrollbar&, const IntRect&) override;
120     bool isActive() const override;
121     bool isScrollCornerVisible() const override { return false; } // We don't support resize on list boxes yet. If we did these would have to change.
122     IntRect scrollCornerRect() const override { return IntRect(); }
123     void invalidateScrollCornerRect(const IntRect&) override { }
124     IntRect convertFromScrollbarToContainingView(const Scrollbar&, const IntRect&) const override;
125     IntRect convertFromContainingViewToScrollbar(const Scrollbar&, const IntRect&) const override;
126     IntPoint convertFromScrollbarToContainingView(const Scrollbar&, const IntPoint&) const override;
127     IntPoint convertFromContainingViewToScrollbar(const Scrollbar&, const IntPoint&) const override;
128     Scrollbar* verticalScrollbar() const override { return m_vBar.get(); }
129     IntSize contentsSize() const override;
130     IntSize visibleSize() const override { return IntSize(width(), height()); }
131     IntPoint lastKnownMousePosition() const override;
132     bool isHandlingWheelEvent() const override;
133     bool shouldSuspendScrollAnimations() const override;
134     bool forceUpdateScrollbarsOnMainThreadForPerformanceTesting() const override;
135
136     ScrollableArea* enclosingScrollableArea() const override;
137     bool isScrollableOrRubberbandable() override;
138     bool hasScrollableOrRubberbandableAncestor() override;
139     IntRect scrollableAreaBoundingBox(bool* = nullptr) const override;
140     bool usesMockScrollAnimator() const override;
141     void logMockScrollAnimatorMessage(const String&) const override;
142
143     // NOTE: This should only be called by the overriden setScrollOffset from ScrollableArea.
144     void scrollTo(int newOffset);
145
146     using PaintFunction = WTF::Function<void(PaintInfo&, const LayoutPoint&, int listItemIndex)>;
147     void paintItem(PaintInfo&, const LayoutPoint&, const PaintFunction&);
148
149     void setHasVerticalScrollbar(bool hasScrollbar);
150     Ref<Scrollbar> createScrollbar();
151     void destroyScrollbar();
152     
153     int maximumNumberOfItemsThatFitInPaddingBottomArea() const;
154
155     int numberOfVisibleItemsInPaddingTop() const;
156     int numberOfVisibleItemsInPaddingBottom() const;
157
158     void computeFirstIndexesVisibleInPaddingTopBottomAreas();
159
160     LayoutUnit itemHeight() const;
161     void valueChanged(unsigned listIndex);
162
163     enum class ConsiderPadding { Yes, No };
164     int numVisibleItems(ConsiderPadding = ConsiderPadding::No) const;
165     int numItems() const;
166     LayoutUnit listHeight() const;
167     void paintScrollbar(PaintInfo&, const LayoutPoint&);
168     void paintItemForeground(PaintInfo&, const LayoutPoint&, int listIndex);
169     void paintItemBackground(PaintInfo&, const LayoutPoint&, int listIndex);
170     void scrollToRevealSelection();
171
172     bool shouldPlaceBlockDirectionScrollbarOnLeft() const final { return RenderBlockFlow::shouldPlaceBlockDirectionScrollbarOnLeft(); }
173
174     bool m_optionsChanged;
175     bool m_scrollToRevealSelectionAfterLayout;
176     bool m_inAutoscroll;
177     int m_optionsWidth;
178     int m_indexOffset;
179
180     std::optional<int> m_indexOfFirstVisibleItemInsidePaddingTopArea;
181     std::optional<int> m_indexOfFirstVisibleItemInsidePaddingBottomArea;
182
183     RefPtr<Scrollbar> m_vBar;
184 };
185
186 } // namepace WebCore
187
188 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderListBox, isListBox())