Source/WebCore/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 "Node.h"
  30 #include "RenderStyleConstants.h"
  31 #include "Scrollbar.h"
  32 #include <wtf/HashMap.h>
  33
  34 namespace WebCore {
  35
  36 class Frame;
  37 class RenderBox;
  38 class RenderScrollbarPart;
  39 class RenderStyle;
  40
  41 class RenderScrollbar : public Scrollbar {
  42 protected:
  43     RenderScrollbar(ScrollableArea*, ScrollbarOrientation, Node*, Frame*);
  44
  45 public:
  46     friend class Scrollbar;
  47     static PassRefPtr<Scrollbar> createCustomScrollbar(ScrollableArea*, ScrollbarOrientation, Node*, Frame* owningFrame = 0);
  48     virtual ~RenderScrollbar();
  49
  50     static ScrollbarPart partForStyleResolve();
  51     static RenderScrollbar* scrollbarForStyleResolve();
  52
  53     RenderBox* owningRenderer() const;
  54
  55     void paintPart(GraphicsContext*, ScrollbarPart, const IntRect&);
  56
  57     IntRect buttonRect(ScrollbarPart);
  58     IntRect trackRect(int startLength, int endLength);
  59     IntRect trackPieceRectWithMargins(ScrollbarPart, const IntRect&);
  60
  61     int minimumThumbLength();
  62
  63     virtual bool isOverlayScrollbar() const { return false; }
  64
  65 private:
  66     virtual void setParent(ScrollView*);
  67     virtual void setEnabled(bool);
  68
  69     virtual void paint(GraphicsContext*, const IntRect& damageRect);
  70
  71     virtual void setHoveredPart(ScrollbarPart);
  72     virtual void setPressedPart(ScrollbarPart);
  73
  74     virtual void styleChanged();
  75
  76     virtual bool isCustomScrollbar() const { return true; }
  77
  78     void updateScrollbarParts(bool destroy = false);
  79
  80     PassRefPtr<RenderStyle> getScrollbarPseudoStyle(ScrollbarPart, PseudoId);
  81     void updateScrollbarPart(ScrollbarPart, bool destroy = false);
  82
  83     // This Scrollbar(Widget) may outlive the DOM which created it (during tear down),
  84     // so we keep a reference to the Node which caused this custom scrollbar creation.
  85     // This will not create a reference cycle as the Widget tree is owned by our containing
  86     // FrameView which this Node pointer can in no way keep alive. See webkit bug 80610.
  87     RefPtr<Node> m_owner;
  88
  89     Frame* m_owningFrame;
  90     HashMap<unsigned, RenderScrollbarPart*> m_parts;
  91 };
  92
  93 inline RenderScrollbar* toRenderScrollbar(ScrollbarThemeClient* scrollbar)
  94 {
  95     ASSERT(!scrollbar || scrollbar->isCustomScrollbar());
  96     return static_cast<RenderScrollbar*>(scrollbar);
  97 }
  98
  99 // This will catch anyone doing an unnecessary cast.
 100 void toRenderScrollbar(const RenderScrollbar*);
 101
 102 } // namespace WebCore
 103
 104 #endif // RenderScrollbar_h