File: ScrollbarTheme.h

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (205 lines) | stat: -rw-r--r-- 8,681 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
/*
 * Copyright (C) 2008 Apple Inc. All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ScrollbarTheme_h
#define ScrollbarTheme_h

#include "platform/PlatformExport.h"
#include "platform/geometry/IntRect.h"
#include "platform/graphics/paint/DisplayItem.h"
#include "platform/scroll/ScrollTypes.h"
#include "platform/scroll/Scrollbar.h"
#include "public/platform/WebScrollbarButtonsPlacement.h"

namespace blink {

class CullRect;
class GraphicsContext;
class PlatformMouseEvent;

class PLATFORM_EXPORT ScrollbarTheme {
  WTF_MAKE_NONCOPYABLE(ScrollbarTheme);
  USING_FAST_MALLOC(ScrollbarTheme);

 public:
  ScrollbarTheme() {}
  virtual ~ScrollbarTheme() {}

  // If true, then scrollbars with this theme will be painted every time
  // Scrollbar::setNeedsPaintInvalidation is called. If false, then only parts
  // which are explicitly invalidated will be repainted.
  virtual bool shouldRepaintAllPartsOnInvalidation() const { return true; }

  virtual void updateEnabledState(const ScrollbarThemeClient&) {}

  virtual bool paint(const Scrollbar&, GraphicsContext&, const CullRect&);

  virtual ScrollbarPart hitTest(const ScrollbarThemeClient&, const IntPoint&);

  // This returns a fixed value regardless of device-scale-factor.
  // This returns thickness when scrollbar is painted.  i.e. It's not 0 even in
  // overlay scrollbar mode.
  // See also Scrollbar::scrollbarThickness().
  virtual int scrollbarThickness(ScrollbarControlSize = RegularScrollbar) {
    return 0;
  }
  virtual int scrollbarMargin() const { return 0; }

  virtual WebScrollbarButtonsPlacement buttonsPlacement() const {
    return WebScrollbarButtonsPlacementSingle;
  }

  virtual bool supportsControlTints() const { return false; }
  virtual bool usesOverlayScrollbars() const { return false; }
  virtual void updateScrollbarOverlayColorTheme(const ScrollbarThemeClient&) {}

  // If true, scrollbars that become invisible (i.e. overlay scrollbars that
  // fade out) should be marked as disabled. This option exists since Mac and
  // Aura overlays implement the fade out differently, with Mac painting code
  // fading out the scrollbars. Aura scrollbars require disabling the scrollbar
  // to prevent painting it.
  virtual bool shouldDisableInvisibleScrollbars() const { return true; }

  virtual bool invalidateOnMouseEnterExit() { return false; }
  virtual bool invalidateOnWindowActiveChange() const { return false; }

  // Returns parts of the scrollbar which must be repainted following a change
  // in the thumb position, given scroll positions before and after.
  virtual ScrollbarPart invalidateOnThumbPositionChange(
      const ScrollbarThemeClient&,
      float oldPosition,
      float newPosition) const {
    return AllParts;
  }

  // Returns parts of the scrollbar which must be repainted following a change
  // in enabled state.
  virtual ScrollbarPart invalidateOnEnabledChange() const { return AllParts; }

  virtual void paintScrollCorner(GraphicsContext&,
                                 const DisplayItemClient&,
                                 const IntRect& cornerRect);
  virtual void paintTickmarks(GraphicsContext&,
                              const Scrollbar&,
                              const IntRect&);

  virtual bool shouldCenterOnThumb(const ScrollbarThemeClient&,
                                   const PlatformMouseEvent&);
  virtual bool shouldSnapBackToDragOrigin(const ScrollbarThemeClient&,
                                          const PlatformMouseEvent&);
  virtual bool shouldDragDocumentInsteadOfThumb(const ScrollbarThemeClient&,
                                                const PlatformMouseEvent&) {
    return false;
  }

  // The position of the thumb relative to the track.
  int thumbPosition(const ScrollbarThemeClient& scrollbar) {
    return thumbPosition(scrollbar, scrollbar.currentPos());
  }
  virtual double overlayScrollbarFadeOutDelaySeconds() const;
  virtual double overlayScrollbarFadeOutDurationSeconds() const;
  // The position the thumb would have, relative to the track, at the specified
  // scroll position.
  virtual int thumbPosition(const ScrollbarThemeClient&, float scrollPosition);
  // The length of the thumb along the axis of the scrollbar.
  virtual int thumbLength(const ScrollbarThemeClient&);
  // The position of the track relative to the scrollbar.
  virtual int trackPosition(const ScrollbarThemeClient&);
  // The length of the track along the axis of the scrollbar.
  virtual int trackLength(const ScrollbarThemeClient&);
  // The opacity to be applied to the thumb.
  virtual float thumbOpacity(const ScrollbarThemeClient&) const { return 1.0f; }

  virtual bool hasButtons(const ScrollbarThemeClient&) = 0;
  virtual bool hasThumb(const ScrollbarThemeClient&) = 0;

  virtual IntRect backButtonRect(const ScrollbarThemeClient&,
                                 ScrollbarPart,
                                 bool painting = false) = 0;
  virtual IntRect forwardButtonRect(const ScrollbarThemeClient&,
                                    ScrollbarPart,
                                    bool painting = false) = 0;
  virtual IntRect trackRect(const ScrollbarThemeClient&,
                            bool painting = false) = 0;
  virtual IntRect thumbRect(const ScrollbarThemeClient&);
  virtual int thumbThickness(const ScrollbarThemeClient&);

  virtual int minimumThumbLength(const ScrollbarThemeClient&);

  virtual void splitTrack(const ScrollbarThemeClient&,
                          const IntRect& track,
                          IntRect& startTrack,
                          IntRect& thumb,
                          IntRect& endTrack);

  virtual void paintScrollbarBackground(GraphicsContext&, const Scrollbar&) {}
  virtual void paintTrackBackground(GraphicsContext&,
                                    const Scrollbar&,
                                    const IntRect&) {}
  virtual void paintTrackPiece(GraphicsContext&,
                               const Scrollbar&,
                               const IntRect&,
                               ScrollbarPart) {}
  virtual void paintButton(GraphicsContext&,
                           const Scrollbar&,
                           const IntRect&,
                           ScrollbarPart) {}
  virtual void paintThumb(GraphicsContext&, const Scrollbar&, const IntRect&) {}

  virtual int maxOverlapBetweenPages() {
    return std::numeric_limits<int>::max();
  }

  virtual double initialAutoscrollTimerDelay() { return 0.25; }
  virtual double autoscrollTimerDelay() { return 0.05; }

  virtual IntRect constrainTrackRectToTrackPieces(const ScrollbarThemeClient&,
                                                  const IntRect& rect) {
    return rect;
  }

  virtual void registerScrollbar(ScrollbarThemeClient&) {}
  virtual void unregisterScrollbar(ScrollbarThemeClient&) {}

  virtual bool isMockTheme() const { return false; }

  static ScrollbarTheme& theme();

  static void setMockScrollbarsEnabled(bool flag);
  static bool mockScrollbarsEnabled();

 protected:
  virtual int tickmarkBorderWidth() { return 0; }
  static DisplayItem::Type buttonPartToDisplayItemType(ScrollbarPart);
  static DisplayItem::Type trackPiecePartToDisplayItemType(ScrollbarPart);

 private:
  static ScrollbarTheme&
  nativeTheme();  // Must be implemented to return the correct theme subclass.
  static bool gMockScrollbarsEnabled;
};

}  // namespace blink
#endif