Fixed and sticky nodes have no nodeID set
[WebKit-https.git] / Source / WebCore / page / scrolling / ScrollingTreeNode.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 ScrollingTreeNode_h
27 #define ScrollingTreeNode_h
28
29 #if ENABLE(THREADED_SCROLLING)
30
31 #include "IntRect.h"
32 #include "ScrollTypes.h"
33 #include "ScrollingCoordinator.h"
34 #include <wtf/PassOwnPtr.h>
35
36 namespace WebCore {
37
38 class ScrollingStateFixedNode;
39 class ScrollingStateNode;
40 class ScrollingStateScrollingNode;
41
42 class ScrollingTreeNode {
43 public:
44     explicit ScrollingTreeNode(ScrollingTree*, ScrollingNodeID);
45     virtual ~ScrollingTreeNode();
46
47     virtual void update(ScrollingStateNode*) = 0;
48
49     virtual void parentScrollPositionDidChange(const IntRect& viewportRect, const FloatSize& cumulativeDelta) = 0;
50
51     ScrollingNodeID scrollingNodeID() const { return m_nodeID; }
52
53     ScrollingTreeNode* parent() const { return m_parent; }
54     void setParent(ScrollingTreeNode* parent) { m_parent = parent; }
55
56     void appendChild(PassOwnPtr<ScrollingTreeNode>);
57     void removeChild(ScrollingTreeNode*);
58
59 protected:
60     ScrollingTree* scrollingTree() const { return m_scrollingTree; }
61
62     typedef Vector<OwnPtr<ScrollingTreeNode> > ScrollingTreeChildrenVector;
63     OwnPtr<ScrollingTreeChildrenVector> m_children;
64
65 private:
66     ScrollingTree* m_scrollingTree;
67
68     ScrollingNodeID m_nodeID;
69
70     ScrollingTreeNode* m_parent;
71 };
72
73 } // namespace WebCore
74
75 #endif // ENABLE(THREADED_SCROLLING)
76
77 #endif // ScrollingTreeNode_h