Scroll latching logic can get stuck in 'scrollable="no"' iframes
[WebKit-https.git] / Source / WebCore / page / scrolling / ScrollLatchingState.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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef ScrollLatchingState_h
27 #define ScrollLatchingState_h
28
29 #include <wtf/RefPtr.h>
30
31 namespace WebCore {
32
33 class ContainerNode;
34 class Element;
35 class Frame;
36
37 class ScrollLatchingState final {
38 public:
39     ScrollLatchingState();
40     ~ScrollLatchingState();
41
42     void clear();
43
44     Element* wheelEventElement() { return m_wheelEventElement.get(); }
45     void setWheelEventElement(PassRefPtr<Element>);
46     Frame* frame() { return m_frame; }
47     void setFrame(Frame* frame) { m_frame = frame; }
48
49     bool widgetIsLatched() const { return m_widgetIsLatched; }
50     void setWidgetIsLatched(bool isOverWidget);
51
52     Element* previousWheelScrolledElement() { return m_previousWheelScrolledElement.get(); }
53     void setPreviousWheelScrolledElement(RefPtr<Element>&&);
54     
55     ContainerNode* scrollableContainer() { return m_scrollableContainer.get(); }
56     void setScrollableContainer(PassRefPtr<ContainerNode>);
57     bool startedGestureAtScrollLimit() const { return m_startedGestureAtScrollLimit; }
58     void setStartedGestureAtScrollLimit(bool startedAtLimit) { m_startedGestureAtScrollLimit = startedAtLimit; }
59
60 private:
61     RefPtr<Element> m_wheelEventElement;
62     RefPtr<Element> m_previousWheelScrolledElement;
63     RefPtr<ContainerNode> m_scrollableContainer;
64
65     Frame* m_frame;
66     
67     bool m_widgetIsLatched;
68     bool m_startedGestureAtScrollLimit;
69 };
70     
71 }
72
73 #endif