src/third_party/WebKit/Source/core/rendering/RenderScrollbar.h

   1 /*
   2  * Copyright (C) 2008, 2009 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 "core/rendering/style/RenderStyleConstants.h"
  30 #include "platform/heap/Handle.h"
  31 #include "platform/scroll/Scrollbar.h"
  32 #include "wtf/HashMap.h"
  33
  34 namespace blink {
  35
  36 class LocalFrame;
  37 class Node;
  38 class RenderBox;
  39 class RenderScrollbarPart;
  40 class RenderStyle;
  41
  42 class RenderScrollbar final : public Scrollbar {
  43 #if ENABLE(OILPAN)
  44     USING_PRE_FINALIZER(RenderScrollbar, destroyParts);
  45 #endif
  46 public:
  47     static PassRefPtrWillBeRawPtr<Scrollbar> createCustomScrollbar(ScrollableArea*, ScrollbarOrientation, Node*, LocalFrame* owningFrame = 0);
  48     virtual ~RenderScrollbar();
  49
  50     RenderBox* owningRenderer() const;
  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     RenderScrollbarPart* getPart(ScrollbarPart partType) { return m_parts.get(partType); }
  61
  62     virtual void trace(Visitor*) override;
  63
  64 protected:
  65     RenderScrollbar(ScrollableArea*, ScrollbarOrientation, Node*, LocalFrame*);
  66
  67 private:
  68     friend class Scrollbar;
  69
  70     virtual void setParent(Widget*) override;
  71     virtual void setEnabled(bool) override;
  72
  73     virtual void setHoveredPart(ScrollbarPart) override;
  74     virtual void setPressedPart(ScrollbarPart) override;
  75
  76     virtual void styleChanged() override;
  77
  78     virtual bool isCustomScrollbar() const override { return true; }
  79
  80     void updateScrollbarParts(bool destroy = false);
  81
  82     PassRefPtr<RenderStyle> getScrollbarPseudoStyle(ScrollbarPart, PseudoId);
  83     void updateScrollbarPart(ScrollbarPart, bool destroy = false);
  84
  85     void destroyParts();
  86
  87     // This Scrollbar(Widget) may outlive the DOM which created it (during tear down),
  88     // so we keep a reference to the Node which caused this custom scrollbar creation.
  89     // This will not create a reference cycle as the Widget tree is owned by our containing
  90     // FrameView which this Node pointer can in no way keep alive. See webkit bug 80610.
  91     RefPtrWillBeMember<Node> m_owner;
  92
  93     RawPtrWillBeMember<LocalFrame> m_owningFrame;
  94
  95     WillBeHeapHashMap<unsigned, RawPtrWillBeMember<RenderScrollbarPart> > m_parts;
  96 };
  97
  98 DEFINE_TYPE_CASTS(RenderScrollbar, ScrollbarThemeClient, scrollbar, scrollbar->isCustomScrollbar(), scrollbar.isCustomScrollbar());
  99
 100 } // namespace blink
 101
 102 #endif // RenderScrollbar_h