Fixed and sticky nodes have no nodeID set
[WebKit-https.git] / Source / WebCore / page / scrolling / mac / ScrollingTreeScrollingNodeMac.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 ScrollingTreeScrollingNodeMac_h
27 #define ScrollingTreeScrollingNodeMac_h
28
29 #if ENABLE(THREADED_SCROLLING)
30
31 #include "ScrollElasticityController.h"
32 #include "ScrollingTreeScrollingNode.h"
33 #include <wtf/RetainPtr.h>
34
35 OBJC_CLASS CALayer;
36
37 namespace WebCore {
38
39 class ScrollingTreeScrollingNodeMac : public ScrollingTreeScrollingNode, private ScrollElasticityControllerClient {
40 public:
41     explicit ScrollingTreeScrollingNodeMac(ScrollingTree*, ScrollingNodeID);
42     virtual ~ScrollingTreeScrollingNodeMac();
43
44 private:
45     // ScrollingTreeNode member functions.
46     virtual void update(ScrollingStateNode*) OVERRIDE;
47     virtual void handleWheelEvent(const PlatformWheelEvent&) OVERRIDE;
48
49     // ScrollElasticityController member functions.
50     virtual bool allowsHorizontalStretching() OVERRIDE;
51     virtual bool allowsVerticalStretching() OVERRIDE;
52     virtual IntSize stretchAmount() OVERRIDE;
53     virtual bool pinnedInDirection(const FloatSize&) OVERRIDE;
54     virtual bool canScrollHorizontally() OVERRIDE;
55     virtual bool canScrollVertically() OVERRIDE;
56     virtual bool shouldRubberBandInDirection(ScrollDirection) OVERRIDE;
57     virtual IntPoint absoluteScrollPosition() OVERRIDE;
58     virtual void immediateScrollBy(const FloatSize&) OVERRIDE;
59     virtual void immediateScrollByWithoutContentEdgeConstraints(const FloatSize&) OVERRIDE;
60     virtual void startSnapRubberbandTimer() OVERRIDE;
61     virtual void stopSnapRubberbandTimer() OVERRIDE;
62
63     IntPoint scrollPosition() const;
64     void setScrollPosition(const IntPoint&);
65     void setScrollPositionWithoutContentEdgeConstraints(const IntPoint&);
66
67     void setScrollLayerPosition(const IntPoint&);
68
69     IntPoint minimumScrollPosition() const;
70     IntPoint maximumScrollPosition() const;
71
72     void scrollBy(const IntSize&);
73     void scrollByWithoutContentEdgeConstraints(const IntSize&);
74
75     void updateMainFramePinState(const IntPoint& scrollPosition);
76
77     void logExposedUnfilledArea();
78
79     ScrollElasticityController m_scrollElasticityController;
80     RetainPtr<CFRunLoopTimerRef> m_snapRubberbandTimer;
81
82     RetainPtr<CALayer> m_scrollLayer;
83     RetainPtr<CALayer> m_counterScrollingLayer;
84     IntPoint m_probableMainThreadScrollPosition;
85     bool m_lastScrollHadUnfilledPixels;
86 };
87
88 } // namespace WebCore
89
90 #endif // ENABLE(THREADED_SCROLLING)
91
92 #endif // ScrollingTreeScrollingNodeMac_h