| /* |
| * Copyright (C) 2011 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. |
| */ |
| |
| #include "platform/scroll/ScrollbarTheme.h" |
| |
| #include "platform/PlatformMouseEvent.h" |
| #include "platform/RuntimeEnabledFeatures.h" |
| #include "platform/graphics/Color.h" |
| #include "platform/graphics/GraphicsContext.h" |
| #include "platform/graphics/paint/CompositingRecorder.h" |
| #include "platform/graphics/paint/CullRect.h" |
| #include "platform/graphics/paint/DrawingDisplayItem.h" |
| #include "platform/graphics/paint/DrawingRecorder.h" |
| #include "platform/graphics/paint/PaintController.h" |
| #include "platform/scroll/Scrollbar.h" |
| #include "platform/scroll/ScrollbarThemeMock.h" |
| #include "platform/scroll/ScrollbarThemeOverlayMock.h" |
| #include "public/platform/Platform.h" |
| #include "public/platform/WebPoint.h" |
| #include "public/platform/WebRect.h" |
| #include "public/platform/WebScrollbarBehavior.h" |
| #include "wtf/Optional.h" |
| |
| #if !OS(MACOSX) |
| #include "public/platform/WebThemeEngine.h" |
| #endif |
| |
| namespace blink { |
| |
| bool ScrollbarTheme::gMockScrollbarsEnabled = false; |
| |
| static inline bool shouldPaintScrollbarPart(const IntRect& partRect, |
| const CullRect& cullRect) { |
| return (!partRect.isEmpty()) || cullRect.intersectsCullRect(partRect); |
| } |
| |
| bool ScrollbarTheme::paint(const Scrollbar& scrollbar, |
| GraphicsContext& graphicsContext, |
| const CullRect& cullRect) { |
| // Create the ScrollbarControlPartMask based on the cullRect |
| ScrollbarControlPartMask scrollMask = NoPart; |
| |
| IntRect backButtonStartPaintRect; |
| IntRect backButtonEndPaintRect; |
| IntRect forwardButtonStartPaintRect; |
| IntRect forwardButtonEndPaintRect; |
| if (hasButtons(scrollbar)) { |
| backButtonStartPaintRect = |
| backButtonRect(scrollbar, BackButtonStartPart, true); |
| if (shouldPaintScrollbarPart(backButtonStartPaintRect, cullRect)) |
| scrollMask |= BackButtonStartPart; |
| backButtonEndPaintRect = backButtonRect(scrollbar, BackButtonEndPart, true); |
| if (shouldPaintScrollbarPart(backButtonEndPaintRect, cullRect)) |
| scrollMask |= BackButtonEndPart; |
| forwardButtonStartPaintRect = |
| forwardButtonRect(scrollbar, ForwardButtonStartPart, true); |
| if (shouldPaintScrollbarPart(forwardButtonStartPaintRect, cullRect)) |
| scrollMask |= ForwardButtonStartPart; |
| forwardButtonEndPaintRect = |
| forwardButtonRect(scrollbar, ForwardButtonEndPart, true); |
| if (shouldPaintScrollbarPart(forwardButtonEndPaintRect, cullRect)) |
| scrollMask |= ForwardButtonEndPart; |
| } |
| |
| IntRect startTrackRect; |
| IntRect thumbRect; |
| IntRect endTrackRect; |
| IntRect trackPaintRect = trackRect(scrollbar, true); |
| scrollMask |= TrackBGPart; |
| bool thumbPresent = hasThumb(scrollbar); |
| if (thumbPresent) { |
| IntRect track = trackRect(scrollbar); |
| splitTrack(scrollbar, track, startTrackRect, thumbRect, endTrackRect); |
| if (shouldPaintScrollbarPart(thumbRect, cullRect)) |
| scrollMask |= ThumbPart; |
| if (shouldPaintScrollbarPart(startTrackRect, cullRect)) |
| scrollMask |= BackTrackPart; |
| if (shouldPaintScrollbarPart(endTrackRect, cullRect)) |
| scrollMask |= ForwardTrackPart; |
| } |
| |
| // Paint the scrollbar background (only used by custom CSS scrollbars). |
| paintScrollbarBackground(graphicsContext, scrollbar); |
| |
| // Paint the back and forward buttons. |
| if (scrollMask & BackButtonStartPart) |
| paintButton(graphicsContext, scrollbar, backButtonStartPaintRect, |
| BackButtonStartPart); |
| if (scrollMask & BackButtonEndPart) |
| paintButton(graphicsContext, scrollbar, backButtonEndPaintRect, |
| BackButtonEndPart); |
| if (scrollMask & ForwardButtonStartPart) |
| paintButton(graphicsContext, scrollbar, forwardButtonStartPaintRect, |
| ForwardButtonStartPart); |
| if (scrollMask & ForwardButtonEndPart) |
| paintButton(graphicsContext, scrollbar, forwardButtonEndPaintRect, |
| ForwardButtonEndPart); |
| |
| if (scrollMask & TrackBGPart) |
| paintTrackBackground(graphicsContext, scrollbar, trackPaintRect); |
| |
| if ((scrollMask & ForwardTrackPart) || (scrollMask & BackTrackPart)) { |
| // Paint the track pieces above and below the thumb. |
| if (scrollMask & BackTrackPart) |
| paintTrackPiece(graphicsContext, scrollbar, startTrackRect, |
| BackTrackPart); |
| if (scrollMask & ForwardTrackPart) |
| paintTrackPiece(graphicsContext, scrollbar, endTrackRect, |
| ForwardTrackPart); |
| |
| paintTickmarks(graphicsContext, scrollbar, trackPaintRect); |
| } |
| |
| // Paint the thumb. |
| if (scrollMask & ThumbPart) { |
| Optional<CompositingRecorder> compositingRecorder; |
| float opacity = thumbOpacity(scrollbar); |
| if (opacity != 1.0f) { |
| FloatRect floatThumbRect(thumbRect); |
| floatThumbRect.inflate(1); // some themes inflate thumb bounds |
| compositingRecorder.emplace(graphicsContext, scrollbar, |
| SkXfermode::kSrcOver_Mode, opacity, |
| &floatThumbRect); |
| } |
| |
| paintThumb(graphicsContext, scrollbar, thumbRect); |
| } |
| |
| return true; |
| } |
| |
| ScrollbarPart ScrollbarTheme::hitTest(const ScrollbarThemeClient& scrollbar, |
| const IntPoint& positionInRootFrame) { |
| ScrollbarPart result = NoPart; |
| if (!scrollbar.enabled()) |
| return result; |
| |
| IntPoint testPosition = scrollbar.convertFromRootFrame(positionInRootFrame); |
| testPosition.move(scrollbar.x(), scrollbar.y()); |
| |
| if (!scrollbar.frameRect().contains(testPosition)) |
| return NoPart; |
| |
| result = ScrollbarBGPart; |
| |
| IntRect track = trackRect(scrollbar); |
| if (track.contains(testPosition)) { |
| IntRect beforeThumbRect; |
| IntRect thumbRect; |
| IntRect afterThumbRect; |
| splitTrack(scrollbar, track, beforeThumbRect, thumbRect, afterThumbRect); |
| if (thumbRect.contains(testPosition)) |
| result = ThumbPart; |
| else if (beforeThumbRect.contains(testPosition)) |
| result = BackTrackPart; |
| else if (afterThumbRect.contains(testPosition)) |
| result = ForwardTrackPart; |
| else |
| result = TrackBGPart; |
| } else if (backButtonRect(scrollbar, BackButtonStartPart) |
| .contains(testPosition)) { |
| result = BackButtonStartPart; |
| } else if (backButtonRect(scrollbar, BackButtonEndPart) |
| .contains(testPosition)) { |
| result = BackButtonEndPart; |
| } else if (forwardButtonRect(scrollbar, ForwardButtonStartPart) |
| .contains(testPosition)) { |
| result = ForwardButtonStartPart; |
| } else if (forwardButtonRect(scrollbar, ForwardButtonEndPart) |
| .contains(testPosition)) { |
| result = ForwardButtonEndPart; |
| } |
| return result; |
| } |
| |
| void ScrollbarTheme::paintScrollCorner( |
| GraphicsContext& context, |
| const DisplayItemClient& displayItemClient, |
| const IntRect& cornerRect) { |
| if (cornerRect.isEmpty()) |
| return; |
| |
| if (DrawingRecorder::useCachedDrawingIfPossible( |
| context, displayItemClient, DisplayItem::kScrollbarCorner)) |
| return; |
| |
| DrawingRecorder recorder(context, displayItemClient, |
| DisplayItem::kScrollbarCorner, cornerRect); |
| #if OS(MACOSX) |
| context.fillRect(cornerRect, Color::white); |
| #else |
| Platform::current()->themeEngine()->paint( |
| context.canvas(), WebThemeEngine::PartScrollbarCorner, |
| WebThemeEngine::StateNormal, WebRect(cornerRect), 0); |
| #endif |
| } |
| |
| bool ScrollbarTheme::shouldCenterOnThumb(const ScrollbarThemeClient& scrollbar, |
| const PlatformMouseEvent& evt) { |
| return Platform::current()->scrollbarBehavior()->shouldCenterOnThumb( |
| evt.pointerProperties().button, evt.shiftKey(), evt.altKey()); |
| } |
| |
| bool ScrollbarTheme::shouldSnapBackToDragOrigin( |
| const ScrollbarThemeClient& scrollbar, |
| const PlatformMouseEvent& evt) { |
| IntPoint mousePosition = scrollbar.convertFromRootFrame(evt.position()); |
| mousePosition.move(scrollbar.x(), scrollbar.y()); |
| return Platform::current()->scrollbarBehavior()->shouldSnapBackToDragOrigin( |
| mousePosition, trackRect(scrollbar), |
| scrollbar.orientation() == HorizontalScrollbar); |
| } |
| |
| int ScrollbarTheme::thumbPosition(const ScrollbarThemeClient& scrollbar, |
| float scrollPosition) { |
| if (scrollbar.enabled()) { |
| float size = scrollbar.totalSize() - scrollbar.visibleSize(); |
| // Avoid doing a floating point divide by zero and return 1 when |
| // usedTotalSize == visibleSize. |
| if (!size) |
| return 0; |
| float pos = std::max(0.0f, scrollPosition) * |
| (trackLength(scrollbar) - thumbLength(scrollbar)) / size; |
| return (pos < 1 && pos > 0) ? 1 : pos; |
| } |
| return 0; |
| } |
| |
| int ScrollbarTheme::thumbLength(const ScrollbarThemeClient& scrollbar) { |
| if (!scrollbar.enabled()) |
| return 0; |
| |
| float overhang = fabsf(scrollbar.elasticOverscroll()); |
| float proportion = 0.0f; |
| float totalSize = scrollbar.totalSize(); |
| if (totalSize > 0.0f) { |
| proportion = (scrollbar.visibleSize() - overhang) / totalSize; |
| } |
| int trackLen = trackLength(scrollbar); |
| int length = round(proportion * trackLen); |
| length = std::max(length, minimumThumbLength(scrollbar)); |
| if (length > trackLen) |
| length = 0; // Once the thumb is below the track length, it just goes away |
| // (to make more room for the track). |
| return length; |
| } |
| |
| int ScrollbarTheme::trackPosition(const ScrollbarThemeClient& scrollbar) { |
| IntRect constrainedTrackRect = |
| constrainTrackRectToTrackPieces(scrollbar, trackRect(scrollbar)); |
| return (scrollbar.orientation() == HorizontalScrollbar) |
| ? constrainedTrackRect.x() - scrollbar.x() |
| : constrainedTrackRect.y() - scrollbar.y(); |
| } |
| |
| int ScrollbarTheme::trackLength(const ScrollbarThemeClient& scrollbar) { |
| IntRect constrainedTrackRect = |
| constrainTrackRectToTrackPieces(scrollbar, trackRect(scrollbar)); |
| return (scrollbar.orientation() == HorizontalScrollbar) |
| ? constrainedTrackRect.width() |
| : constrainedTrackRect.height(); |
| } |
| |
| IntRect ScrollbarTheme::thumbRect(const ScrollbarThemeClient& scrollbar) { |
| if (!hasThumb(scrollbar)) |
| return IntRect(); |
| |
| IntRect track = trackRect(scrollbar); |
| IntRect startTrackRect; |
| IntRect thumbRect; |
| IntRect endTrackRect; |
| splitTrack(scrollbar, track, startTrackRect, thumbRect, endTrackRect); |
| |
| return thumbRect; |
| } |
| |
| int ScrollbarTheme::thumbThickness(const ScrollbarThemeClient& scrollbar) { |
| IntRect track = trackRect(scrollbar); |
| return scrollbar.orientation() == HorizontalScrollbar ? track.height() |
| : track.width(); |
| } |
| |
| int ScrollbarTheme::minimumThumbLength(const ScrollbarThemeClient& scrollbar) { |
| return scrollbarThickness(scrollbar.controlSize()); |
| } |
| |
| void ScrollbarTheme::splitTrack(const ScrollbarThemeClient& scrollbar, |
| const IntRect& unconstrainedTrackRect, |
| IntRect& beforeThumbRect, |
| IntRect& thumbRect, |
| IntRect& afterThumbRect) { |
| // This function won't even get called unless we're big enough to have some |
| // combination of these three rects where at least one of them is non-empty. |
| IntRect trackRect = |
| constrainTrackRectToTrackPieces(scrollbar, unconstrainedTrackRect); |
| int thumbPos = thumbPosition(scrollbar); |
| if (scrollbar.orientation() == HorizontalScrollbar) { |
| thumbRect = IntRect(trackRect.x() + thumbPos, trackRect.y(), |
| thumbLength(scrollbar), scrollbar.height()); |
| beforeThumbRect = |
| IntRect(trackRect.x(), trackRect.y(), thumbPos + thumbRect.width() / 2, |
| trackRect.height()); |
| afterThumbRect = |
| IntRect(trackRect.x() + beforeThumbRect.width(), trackRect.y(), |
| trackRect.maxX() - beforeThumbRect.maxX(), trackRect.height()); |
| } else { |
| thumbRect = IntRect(trackRect.x(), trackRect.y() + thumbPos, |
| scrollbar.width(), thumbLength(scrollbar)); |
| beforeThumbRect = IntRect(trackRect.x(), trackRect.y(), trackRect.width(), |
| thumbPos + thumbRect.height() / 2); |
| afterThumbRect = |
| IntRect(trackRect.x(), trackRect.y() + beforeThumbRect.height(), |
| trackRect.width(), trackRect.maxY() - beforeThumbRect.maxY()); |
| } |
| } |
| |
| ScrollbarTheme& ScrollbarTheme::theme() { |
| if (ScrollbarTheme::mockScrollbarsEnabled()) { |
| if (RuntimeEnabledFeatures::overlayScrollbarsEnabled()) { |
| DEFINE_STATIC_LOCAL(ScrollbarThemeOverlayMock, overlayMockTheme, ()); |
| return overlayMockTheme; |
| } |
| |
| DEFINE_STATIC_LOCAL(ScrollbarThemeMock, mockTheme, ()); |
| return mockTheme; |
| } |
| return nativeTheme(); |
| } |
| |
| void ScrollbarTheme::setMockScrollbarsEnabled(bool flag) { |
| gMockScrollbarsEnabled = flag; |
| } |
| |
| bool ScrollbarTheme::mockScrollbarsEnabled() { |
| return gMockScrollbarsEnabled; |
| } |
| |
| DisplayItem::Type ScrollbarTheme::buttonPartToDisplayItemType( |
| ScrollbarPart part) { |
| switch (part) { |
| case BackButtonStartPart: |
| return DisplayItem::kScrollbarBackButtonStart; |
| case BackButtonEndPart: |
| return DisplayItem::kScrollbarBackButtonEnd; |
| case ForwardButtonStartPart: |
| return DisplayItem::kScrollbarForwardButtonStart; |
| case ForwardButtonEndPart: |
| return DisplayItem::kScrollbarForwardButtonEnd; |
| default: |
| ASSERT_NOT_REACHED(); |
| return DisplayItem::kScrollbarBackButtonStart; |
| } |
| } |
| |
| DisplayItem::Type ScrollbarTheme::trackPiecePartToDisplayItemType( |
| ScrollbarPart part) { |
| switch (part) { |
| case BackTrackPart: |
| return DisplayItem::kScrollbarBackTrack; |
| case ForwardTrackPart: |
| return DisplayItem::kScrollbarForwardTrack; |
| default: |
| ASSERT_NOT_REACHED(); |
| return DisplayItem::kScrollbarBackTrack; |
| } |
| } |
| |
| } // namespace blink |
