Scrollbars and ScrollAnimators must always have a ScrollableArea
[WebKit-https.git] / Source / WebCore / rendering / RenderScrollbar.h
1 /*
2  * Copyright (C) 2008, 2009, 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 #ifndef RenderScrollbar_h
27 #define RenderScrollbar_h
28
29 #include "RenderPtr.h"
30 #include "RenderStyleConstants.h"
31 #include "Scrollbar.h"
32 #include <wtf/HashMap.h>
33
34 namespace WebCore {
35
36 class Frame;
37 class Element;
38 class RenderBox;
39 class RenderScrollbarPart;
40 class RenderStyle;
41
42 class RenderScrollbar final : public Scrollbar {
43 public:
44     friend class Scrollbar;
45     static RefPtr<Scrollbar> createCustomScrollbar(ScrollableArea&, ScrollbarOrientation, Element*, Frame* owningFrame = nullptr);
46     virtual ~RenderScrollbar();
47
48     RenderBox* owningRenderer() const;
49
50     void paintPart(GraphicsContext*, ScrollbarPart, const IntRect&);
51
52     IntRect buttonRect(ScrollbarPart);
53     IntRect trackRect(int startLength, int endLength);
54     IntRect trackPieceRectWithMargins(ScrollbarPart, const IntRect&);
55
56     int minimumThumbLength();
57
58     virtual bool isOverlayScrollbar() const override { return false; }
59
60     float opacity();
61
62     PassRefPtr<RenderStyle> getScrollbarPseudoStyle(ScrollbarPart, PseudoId);
63
64 private:
65     RenderScrollbar(ScrollableArea&, ScrollbarOrientation, Element*, Frame*);
66
67     virtual void setParent(ScrollView*) override;
68     virtual void setEnabled(bool) override;
69
70     virtual void paint(GraphicsContext*, const IntRect& damageRect) override;
71
72     virtual void setHoveredPart(ScrollbarPart) override;
73     virtual void setPressedPart(ScrollbarPart) override;
74
75     virtual void styleChanged() override;
76
77     void updateScrollbarParts();
78
79     void updateScrollbarPart(ScrollbarPart);
80
81     // This Scrollbar(Widget) may outlive the DOM which created it (during tear down),
82     // so we keep a reference to the Element which caused this custom scrollbar creation.
83     // This will not create a reference cycle as the Widget tree is owned by our containing
84     // FrameView which this Element pointer can in no way keep alive. See webkit bug 80610.
85     RefPtr<Element> m_ownerElement;
86
87     Frame* m_owningFrame;
88     HashMap<unsigned, RenderPtr<RenderScrollbarPart>> m_parts;
89 };
90
91 } // namespace WebCore
92
93 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::RenderScrollbar)
94     static bool isType(const WebCore::ScrollbarThemeClient& scrollbar) { return scrollbar.isCustomScrollbar(); }
95 SPECIALIZE_TYPE_TRAITS_END()
96
97 #endif // RenderScrollbar_h