Allow different types of ScrollingTrees to have different types of ScrollingTreeNode...
[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 #include <wtf/PassOwnPtr.h>
36
37 namespace WebCore {
38
39 class PlatformWheelEvent;
40 class ScrollingTree;
41 class ScrollingStateScrollingNode;
42
43 class ScrollingTreeScrollingNode : public ScrollingTreeNode {
44 public:
45     virtual ~ScrollingTreeScrollingNode();
46
47     virtual void updateBeforeChildren(const ScrollingStateNode&) OVERRIDE;
48
49     // FIXME: We should implement this when we support ScrollingTreeScrollingNodes as children.
50     virtual void parentScrollPositionDidChange(const IntRect& /*viewportRect*/, const FloatSize& /*cumulativeDelta*/) OVERRIDE { }
51
52     virtual void handleWheelEvent(const PlatformWheelEvent&) = 0;
53     virtual void setScrollPosition(const IntPoint&) = 0;
54
55     SynchronousScrollingReasons synchronousScrollingReasons() const { return m_synchronousScrollingReasons; }
56     bool shouldUpdateScrollLayerPositionSynchronously() const { return m_synchronousScrollingReasons; }
57
58 protected:
59     ScrollingTreeScrollingNode(ScrollingTree&, ScrollingNodeID);
60
61     const IntRect& viewportRect() const { return m_viewportRect; }
62     const IntSize& totalContentsSize() const { return m_totalContentsSize; }
63     const IntPoint& scrollOrigin() const { return m_scrollOrigin; }
64
65     // If the totalContentsSize changes in the middle of a rubber-band, we still want to use the old totalContentsSize for the sake of
66     // computing the stretchAmount(). Using the old value will keep the animation smooth. When there is no rubber-band in progress at
67     // all, m_totalContentsSizeForRubberBand should be equivalent to m_totalContentsSize.
68     const IntSize& totalContentsSizeForRubberBand() const { return m_totalContentsSizeForRubberBand; }
69     void setTotalContentsSizeForRubberBand(const IntSize& totalContentsSizeForRubberBand) { m_totalContentsSizeForRubberBand = totalContentsSizeForRubberBand; }
70
71     float frameScaleFactor() const { return m_frameScaleFactor; }
72
73     ScrollElasticity horizontalScrollElasticity() const { return m_scrollableAreaParameters.horizontalScrollElasticity; }
74     ScrollElasticity verticalScrollElasticity() const { return m_scrollableAreaParameters.verticalScrollElasticity; }
75
76     bool hasEnabledHorizontalScrollbar() const { return m_scrollableAreaParameters.hasEnabledHorizontalScrollbar; }
77     bool hasEnabledVerticalScrollbar() const { return m_scrollableAreaParameters.hasEnabledVerticalScrollbar; }
78
79     bool canHaveScrollbars() const { return m_scrollableAreaParameters.horizontalScrollbarMode != ScrollbarAlwaysOff || m_scrollableAreaParameters.verticalScrollbarMode != ScrollbarAlwaysOff; }
80
81     int headerHeight() const { return m_headerHeight; }
82     int footerHeight() const { return m_footerHeight; }
83
84     ScrollBehaviorForFixedElements scrollBehaviorForFixedElements() const { return m_behaviorForFixed; }
85
86 private:
87     IntRect m_viewportRect;
88     IntSize m_totalContentsSize;
89     IntSize m_totalContentsSizeForRubberBand;
90     IntPoint m_scrollOrigin;
91     
92     ScrollableAreaParameters m_scrollableAreaParameters;
93     
94     float m_frameScaleFactor;
95
96     int m_headerHeight;
97     int m_footerHeight;
98
99     SynchronousScrollingReasons m_synchronousScrollingReasons;
100     ScrollBehaviorForFixedElements m_behaviorForFixed;
101 };
102
103 } // namespace WebCore
104
105 #endif // ENABLE(ASYNC_SCROLLING)
106
107 #endif // ScrollingTreeScrollingNode_h