Remove "virtual" from all lines that have both "virtual" and "override".
[WebKit-https.git] / Source / WebCore / page / scrolling / ScrollingTreeScrollingNode.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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef ScrollingTreeScrollingNode_h
27 #define ScrollingTreeScrollingNode_h
28
29 #if ENABLE(ASYNC_SCROLLING)
30
31 #include "IntRect.h"
32 #include "ScrollTypes.h"
33 #include "ScrollingCoordinator.h"
34 #include "ScrollingTreeNode.h"
35
36 namespace WebCore {
37
38 class ScrollingTree;
39 class ScrollingStateScrollingNode;
40
41 class ScrollingTreeScrollingNode : public ScrollingTreeNode {
42 public:
43     virtual ~ScrollingTreeScrollingNode();
44
45     WEBCORE_EXPORT void updateBeforeChildren(const ScrollingStateNode&) override;
46     WEBCORE_EXPORT void updateAfterChildren(const ScrollingStateNode&) override;
47
48     WEBCORE_EXPORT void updateLayersAfterAncestorChange(const ScrollingTreeNode& changedNode, const FloatRect& fixedPositionRect, const FloatSize& cumulativeDelta) override;
49
50     virtual void handleWheelEvent(const PlatformWheelEvent&) = 0;
51     WEBCORE_EXPORT virtual void setScrollPosition(const FloatPoint&);
52     WEBCORE_EXPORT virtual void setScrollPositionWithoutContentEdgeConstraints(const FloatPoint&);
53
54     virtual void updateLayersAfterViewportChange(const FloatRect& fixedPositionRect, double scale) = 0;
55     virtual void updateLayersAfterDelegatedScroll(const FloatPoint&) { }
56
57     virtual FloatPoint scrollPosition() const = 0;
58
59 #if ENABLE(CSS_SCROLL_SNAP)
60     const Vector<float>& horizontalSnapOffsets() const { return m_horizontalSnapOffsets; }
61     const Vector<float>& verticalSnapOffsets() const { return m_verticalSnapOffsets; }
62     unsigned currentHorizontalSnapPointIndex() const { return m_currentHorizontalSnapPointIndex; }
63     unsigned currentVerticalSnapPointIndex() const { return m_currentVerticalSnapPointIndex; }
64     void setCurrentHorizontalSnapPointIndex(unsigned index) { m_currentHorizontalSnapPointIndex = index; }
65     void setCurrentVerticalSnapPointIndex(unsigned index) { m_currentVerticalSnapPointIndex = index; }
66 #endif
67
68 protected:
69     ScrollingTreeScrollingNode(ScrollingTree&, ScrollingNodeType, ScrollingNodeID);
70
71     WEBCORE_EXPORT virtual FloatPoint minimumScrollPosition() const;
72     WEBCORE_EXPORT virtual FloatPoint maximumScrollPosition() const;
73
74     virtual void setScrollLayerPosition(const FloatPoint&) = 0;
75
76     FloatPoint lastCommittedScrollPosition() const { return m_lastCommittedScrollPosition; }
77     const FloatSize& scrollableAreaSize() const { return m_scrollableAreaSize; }
78     const FloatSize& totalContentsSize() const { return m_totalContentsSize; }
79     const FloatSize& reachableContentsSize() const { return m_reachableContentsSize; }
80     const IntPoint& scrollOrigin() const { return m_scrollOrigin; }
81
82     // If the totalContentsSize changes in the middle of a rubber-band, we still want to use the old totalContentsSize for the sake of
83     // computing the stretchAmount(). Using the old value will keep the animation smooth. When there is no rubber-band in progress at
84     // all, m_totalContentsSizeForRubberBand should be equivalent to m_totalContentsSize.
85     const FloatSize& totalContentsSizeForRubberBand() const { return m_totalContentsSizeForRubberBand; }
86     void setTotalContentsSizeForRubberBand(const FloatSize& totalContentsSizeForRubberBand) { m_totalContentsSizeForRubberBand = totalContentsSizeForRubberBand; }
87
88     ScrollElasticity horizontalScrollElasticity() const { return m_scrollableAreaParameters.horizontalScrollElasticity; }
89     ScrollElasticity verticalScrollElasticity() const { return m_scrollableAreaParameters.verticalScrollElasticity; }
90
91     bool hasEnabledHorizontalScrollbar() const { return m_scrollableAreaParameters.hasEnabledHorizontalScrollbar; }
92     bool hasEnabledVerticalScrollbar() const { return m_scrollableAreaParameters.hasEnabledVerticalScrollbar; }
93
94     bool canHaveScrollbars() const { return m_scrollableAreaParameters.horizontalScrollbarMode != ScrollbarAlwaysOff || m_scrollableAreaParameters.verticalScrollbarMode != ScrollbarAlwaysOff; }
95
96 private:
97     FloatSize m_scrollableAreaSize;
98     FloatSize m_totalContentsSize;
99     FloatSize m_totalContentsSizeForRubberBand;
100     FloatSize m_reachableContentsSize;
101     FloatPoint m_lastCommittedScrollPosition;
102     IntPoint m_scrollOrigin;
103 #if ENABLE(CSS_SCROLL_SNAP)
104     Vector<float> m_horizontalSnapOffsets;
105     Vector<float> m_verticalSnapOffsets;
106     unsigned m_currentHorizontalSnapPointIndex { 0 };
107     unsigned m_currentVerticalSnapPointIndex { 0 };
108 #endif
109     ScrollableAreaParameters m_scrollableAreaParameters;
110 };
111
112 } // namespace WebCore
113
114 SPECIALIZE_TYPE_TRAITS_SCROLLING_NODE(ScrollingTreeScrollingNode, isScrollingNode())
115
116 #endif // ENABLE(ASYNC_SCROLLING)
117
118 #endif // ScrollingTreeScrollingNode_h