Incorrect position when dragging jQuery Draggable elements with position fixed after...
[WebKit-https.git] / Source / WebCore / platform / Scrollbar.h
1 /*
2  * Copyright (C) 2004, 2006, 2014-2015 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 #pragma once
27
28 #include "ScrollTypes.h"
29 #include "Timer.h"
30 #include "Widget.h"
31 #include <wtf/WeakPtr.h>
32
33 namespace WebCore {
34
35 class GraphicsContext;
36 class IntRect;
37 class PlatformMouseEvent;
38 class ScrollableArea;
39 class ScrollbarTheme;
40
41 class Scrollbar : public Widget {
42 public:
43     // Must be implemented by platforms that can't simply use the Scrollbar base class.  Right now the only platform that is not using the base class is GTK.
44     WEBCORE_EXPORT static Ref<Scrollbar> createNativeScrollbar(ScrollableArea&, ScrollbarOrientation, ScrollbarControlSize);
45
46     virtual ~Scrollbar();
47
48     // Called by the ScrollableArea when the scroll offset changes.
49     void offsetDidChange();
50
51     static int pixelsPerLineStep() { return 40; }
52     static float minFractionToStepWhenPaging() { return 0.8; }
53     WEBCORE_EXPORT static int maxOverlapBetweenPages();
54     static int pageStep(int viewWidthOrHeight, int contentWidthOrHeight) { return std::max(std::max<int>(lroundf(viewWidthOrHeight * Scrollbar::minFractionToStepWhenPaging()), lroundf(contentWidthOrHeight - Scrollbar::maxOverlapBetweenPages())), 1); }
55     static int pageStep(int viewWidthOrHeight) { return pageStep(viewWidthOrHeight, viewWidthOrHeight); }
56     static float pageStepDelta(int widthOrHeight) { return std::max(std::max(static_cast<float>(widthOrHeight) * Scrollbar::minFractionToStepWhenPaging(), static_cast<float>(widthOrHeight) - Scrollbar::maxOverlapBetweenPages()), 1.0f); }
57
58     ScrollableArea& scrollableArea() const { return m_scrollableArea; }
59
60     bool isCustomScrollbar() const { return m_isCustomScrollbar; }
61     ScrollbarOrientation orientation() const { return m_orientation; }
62
63     int value() const { return lroundf(m_currentPos); }
64     float currentPos() const { return m_currentPos; }
65     int pressedPos() const { return m_pressedPos; }
66     int visibleSize() const { return m_visibleSize; }
67     int totalSize() const { return m_totalSize; }
68     int maximum() const { return m_totalSize - m_visibleSize; }
69     ScrollbarControlSize controlSize() const { return m_controlSize; }
70     
71     int occupiedWidth() const;
72     int occupiedHeight() const;
73
74     int lineStep() const { return m_lineStep; }
75     int pageStep() const { return m_pageStep; }
76     float pixelStep() const { return m_pixelStep; }
77
78     ScrollbarPart pressedPart() const { return m_pressedPart; }
79     ScrollbarPart hoveredPart() const { return m_hoveredPart; }
80     virtual void setHoveredPart(ScrollbarPart);
81     virtual void setPressedPart(ScrollbarPart);
82
83     WEBCORE_EXPORT void setSteps(int lineStep, int pageStep, int pixelsPerStep = 1);
84     WEBCORE_EXPORT void setProportion(int visibleSize, int totalSize);
85     void setPressedPos(int p) { m_pressedPos = p; }
86
87     void paint(GraphicsContext&, const IntRect& damageRect, Widget::SecurityOriginPaintPolicy = SecurityOriginPaintPolicy::AnyOrigin) override;
88
89     bool enabled() const { return m_enabled; }
90     virtual void setEnabled(bool);
91
92     virtual bool isOverlayScrollbar() const;
93     bool shouldParticipateInHitTesting();
94
95     bool isWindowActive() const;
96
97     // These methods are used for platform scrollbars to give :hover feedback.  They will not get called
98     // when the mouse went down in a scrollbar, since it is assumed the scrollbar will start
99     // grabbing all events in that case anyway.
100 #if !PLATFORM(IOS)
101     WEBCORE_EXPORT bool mouseMoved(const PlatformMouseEvent&);
102 #endif
103     WEBCORE_EXPORT void mouseEntered();
104     WEBCORE_EXPORT bool mouseExited();
105
106     // Used by some platform scrollbars to know when they've been released from capture.
107     WEBCORE_EXPORT bool mouseUp(const PlatformMouseEvent&);
108
109     WEBCORE_EXPORT bool mouseDown(const PlatformMouseEvent&);
110
111     ScrollbarTheme& theme() const { return m_theme; }
112
113     void invalidateRect(const IntRect&) override;
114
115     bool suppressInvalidation() const { return m_suppressInvalidation; }
116     void setSuppressInvalidation(bool s) { m_suppressInvalidation = s; }
117
118     virtual void styleChanged() { }
119
120     IntRect convertToContainingView(const IntRect&) const override;
121     IntRect convertFromContainingView(const IntRect&) const override;
122
123     IntPoint convertToContainingView(const IntPoint&) const override;
124     IntPoint convertFromContainingView(const IntPoint&) const override;
125
126     void moveThumb(int pos, bool draggingDocument = false);
127
128     bool isAlphaLocked() const { return m_isAlphaLocked; }
129     void setIsAlphaLocked(bool flag) { m_isAlphaLocked = flag; }
130
131     float opacity() const { return m_opacity; }
132     void setOpacity(float opacity) { m_opacity = opacity; }
133
134     bool supportsUpdateOnSecondaryThread() const;
135
136     WeakPtr<Scrollbar> createWeakPtr() { return m_weakPtrFactory.createWeakPtr(); }
137
138 protected:
139     Scrollbar(ScrollableArea&, ScrollbarOrientation, ScrollbarControlSize, ScrollbarTheme* = 0, bool isCustomScrollbar = false);
140
141     void updateThumb();
142     virtual void updateThumbPosition();
143     virtual void updateThumbProportion();
144
145     void autoscrollTimerFired();
146     void startTimerIfNeeded(Seconds delay);
147     void stopTimerIfNeeded();
148     void autoscrollPressedPart(Seconds delay);
149     ScrollDirection pressedPartScrollDirection();
150     ScrollGranularity pressedPartScrollGranularity();
151
152     ScrollableArea& m_scrollableArea;
153     ScrollbarOrientation m_orientation;
154     ScrollbarControlSize m_controlSize;
155     ScrollbarTheme& m_theme;
156
157     int m_visibleSize;
158     int m_totalSize;
159     float m_currentPos;
160     float m_dragOrigin;
161     int m_lineStep;
162     int m_pageStep;
163     float m_pixelStep;
164
165     ScrollbarPart m_hoveredPart;
166     ScrollbarPart m_pressedPart;
167     int m_pressedPos;
168     float m_scrollPos;
169     bool m_draggingDocument;
170     int m_documentDragPos;
171
172     bool m_enabled;
173
174     Timer m_scrollTimer;
175
176     bool m_suppressInvalidation;
177
178     bool m_isAlphaLocked;
179
180     bool m_isCustomScrollbar;
181
182     float m_opacity { 1 };
183
184 private:
185     bool isScrollbar() const override { return true; }
186
187     WeakPtrFactory<Scrollbar> m_weakPtrFactory;
188 };
189
190 } // namespace WebCore
191
192 SPECIALIZE_TYPE_TRAITS_WIDGET(Scrollbar, isScrollbar())
193