Latching in iframes is not working as expected
[WebKit-https.git] / Source / WebCore / page / MainFrame.h
1 /*
2  * Copyright (C) 2013-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 MainFrame_h
27 #define MainFrame_h
28
29 #include "Frame.h"
30
31 namespace WebCore {
32
33 class ScrollLatchingState;
34 class WheelEventDeltaTracker;
35
36 class MainFrame final : public Frame {
37 public:
38     static RefPtr<MainFrame> create(Page&, FrameLoaderClient&);
39
40     virtual ~MainFrame();
41
42     void selfOnlyRef();
43     void selfOnlyDeref();
44
45     WheelEventDeltaTracker* wheelEventDeltaTracker() { return m_recentWheelEventDeltaTracker.get(); }
46
47 #if PLATFORM(MAC)
48     ScrollLatchingState* latchingState() { return m_latchingState.get(); }
49     void resetLatchingState();
50 #endif
51
52 private:
53     MainFrame(Page&, FrameLoaderClient&);
54
55     void dropChildren();
56
57     unsigned m_selfOnlyRefCount;
58
59 #if PLATFORM(MAC)
60     std::unique_ptr<ScrollLatchingState> m_latchingState;
61 #endif
62     std::unique_ptr<WheelEventDeltaTracker> m_recentWheelEventDeltaTracker;
63 };
64
65 inline bool Frame::isMainFrame() const
66 {
67     return this == &m_mainFrame;
68 }
69
70 }
71
72 #endif