Add a way to get the UI-side scrolling tree as text via UIScriptController
[WebKit-https.git] / Source / WebCore / page / scrolling / mac / ScrollingTreeStickyNode.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 #pragma once
27
28 #if ENABLE(ASYNC_SCROLLING)
29
30 #include "ScrollingConstraints.h"
31 #include "ScrollingTreeNode.h"
32 #include <wtf/RetainPtr.h>
33
34 OBJC_CLASS CALayer;
35
36 namespace WebCore {
37
38 class StickyPositionViewportConstraints;
39
40 class ScrollingTreeStickyNode : public ScrollingTreeNode {
41 public:
42     WEBCORE_EXPORT static Ref<ScrollingTreeStickyNode> create(ScrollingTree&, ScrollingNodeID);
43
44     virtual ~ScrollingTreeStickyNode();
45
46 private:
47     ScrollingTreeStickyNode(ScrollingTree&, ScrollingNodeID);
48
49     void commitStateBeforeChildren(const ScrollingStateNode&) override;
50     void updateLayersAfterAncestorChange(const ScrollingTreeNode& changedNode, const FloatRect& fixedPositionRect, const FloatSize& cumulativeDelta) override;
51
52     void dumpProperties(TextStream&, ScrollingStateTreeAsTextBehavior) const override;
53
54     StickyPositionViewportConstraints m_constraints;
55     RetainPtr<CALayer> m_layer;
56 };
57
58 } // namespace WebCore
59
60 SPECIALIZE_TYPE_TRAITS_SCROLLING_NODE(ScrollingTreeStickyNode, isStickyNode())
61
62 #endif // ENABLE(ASYNC_SCROLLING)