Prepare scrolling tree to handle > 1 scrolling node
[WebKit-https.git] / Source / WebKit2 / UIProcess / Scrolling / RemoteScrollingTree.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 RemoteScrollingTree_h
27 #define RemoteScrollingTree_h
28
29 #if ENABLE(ASYNC_SCROLLING)
30
31 #include "RemoteScrollingCoordinator.h"
32 #include <WebCore/ScrollingConstraints.h>
33 #include <WebCore/ScrollingTree.h>
34
35 namespace WebKit {
36
37 class RemoteScrollingCoordinatorProxy;
38
39 class RemoteScrollingTree : public WebCore::ScrollingTree {
40 public:
41     static RefPtr<RemoteScrollingTree> create(RemoteScrollingCoordinatorProxy&);
42     virtual ~RemoteScrollingTree();
43
44     virtual bool isRemoteScrollingTree() const override { return true; }
45     virtual EventResult tryToHandleWheelEvent(const WebCore::PlatformWheelEvent&) override;
46
47     const RemoteScrollingCoordinatorProxy& scrollingCoordinatorProxy() const { return m_scrollingCoordinatorProxy; }
48
49 private:
50     explicit RemoteScrollingTree(RemoteScrollingCoordinatorProxy&);
51
52 #if PLATFORM(MAC) && !PLATFORM(IOS)
53     virtual void handleWheelEventPhase(WebCore::PlatformWheelEventPhase) override;
54 #endif
55     virtual void scrollingTreeNodeDidScroll(WebCore::ScrollingNodeID, const WebCore::IntPoint& scrollPosition, WebCore::SetOrSyncScrollingLayerPosition = WebCore::SyncScrollingLayerPosition) override;
56
57     virtual PassOwnPtr<WebCore::ScrollingTreeNode> createNode(WebCore::ScrollingNodeType, WebCore::ScrollingNodeID);
58     
59     RemoteScrollingCoordinatorProxy& m_scrollingCoordinatorProxy;
60 };
61
62 SCROLLING_TREE_TYPE_CASTS(RemoteScrollingTree, isRemoteScrollingTree());
63
64 } // namespace WebKit
65
66 #endif // ENABLE(ASYNC_SCROLLING)
67
68 #endif // RemoteScrollingTree_h