Fix reload and programmatic scrolling in RTL documents
[WebKit-https.git] / Source / WebCore / page / scrolling / ScrollingTreeFrameScrollingNode.h
1 /*
2  * Copyright (C) 2014 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 ScrollingTreeFrameScrollingNode_h
27 #define ScrollingTreeFrameScrollingNode_h
28
29 #if ENABLE(ASYNC_SCROLLING)
30
31 #include "ScrollingTreeScrollingNode.h"
32
33 namespace WebCore {
34
35 class PlatformWheelEvent;
36 class ScrollingTree;
37 class ScrollingStateScrollingNode;
38
39 class ScrollingTreeFrameScrollingNode : public ScrollingTreeScrollingNode {
40 public:
41     virtual ~ScrollingTreeFrameScrollingNode();
42
43     virtual void updateBeforeChildren(const ScrollingStateNode&) override;
44     
45     // FIXME: We should implement this when we support ScrollingTreeScrollingNodes as children.
46     virtual void updateLayersAfterAncestorChange(const ScrollingTreeNode& /*changedNode*/, const FloatRect& /*fixedPositionRect*/, const FloatSize& /*cumulativeDelta*/) override { }
47
48     virtual void handleWheelEvent(const PlatformWheelEvent&) override = 0;
49     virtual void setScrollPosition(const FloatPoint&) override;
50     virtual void setScrollPositionWithoutContentEdgeConstraints(const FloatPoint&) override = 0;
51
52     virtual void updateLayersAfterViewportChange(const FloatRect& fixedPositionRect, double scale) override = 0;
53     virtual void updateLayersAfterDelegatedScroll(const FloatPoint&) override { }
54
55     SynchronousScrollingReasons synchronousScrollingReasons() const { return m_synchronousScrollingReasons; }
56     bool shouldUpdateScrollLayerPositionSynchronously() const { return m_synchronousScrollingReasons; }
57     bool fixedElementsLayoutRelativeToFrame() const { return m_fixedElementsLayoutRelativeToFrame; }
58
59     FloatSize viewToContentsOffset(const FloatPoint& scrollPosition) const;
60
61 protected:
62     ScrollingTreeFrameScrollingNode(ScrollingTree&, ScrollingNodeID);
63
64     void scrollBy(const FloatSize&);
65     void scrollByWithoutContentEdgeConstraints(const FloatSize&);
66
67     float frameScaleFactor() const { return m_frameScaleFactor; }
68     int headerHeight() const { return m_headerHeight; }
69     int footerHeight() const { return m_footerHeight; }
70     float topContentInset() const { return m_topContentInset; }
71     
72     ScrollBehaviorForFixedElements scrollBehaviorForFixedElements() const { return m_behaviorForFixed; }
73     
74 private:
75     float m_frameScaleFactor { 1 };
76     float m_topContentInset { 0 };
77
78     int m_headerHeight { 0 };
79     int m_footerHeight { 0 };
80     
81     SynchronousScrollingReasons m_synchronousScrollingReasons { 0 };
82     ScrollBehaviorForFixedElements m_behaviorForFixed { StickToDocumentBounds };
83     
84     bool m_fixedElementsLayoutRelativeToFrame { false };
85 };
86
87 } // namespace WebCore
88
89 SPECIALIZE_TYPE_TRAITS_SCROLLING_NODE(ScrollingTreeFrameScrollingNode, isFrameScrollingNode())
90
91 #endif // ENABLE(ASYNC_SCROLLING)
92
93 #endif // ScrollingTreeScrollingNode_h