Source/WebCore/platform/ScrollView.h

   1 /*
   2  * Copyright (C) 2004, 2006, 2007, 2008 Apple Inc. All rights reserved.
   3  * Copyright (C) 2009 Holger Hans Peter Freyther
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef ScrollView_h
  28 #define ScrollView_h
  29
  30 #include "IntRect.h"
  31 #include "Scrollbar.h"
  32 #include "ScrollableArea.h"
  33 #include "ScrollTypes.h"
  34 #include "Widget.h"
  35
  36 #include <wtf/HashSet.h>
  37
  38 #if PLATFORM(MAC) && defined __OBJC__
  39 @protocol WebCoreFrameScrollView;
  40 #endif
  41
  42 #if PLATFORM(GTK)
  43 #include "GRefPtrGtk.h"
  44 typedef struct _GtkAdjustment GtkAdjustment;
  45 #endif
  46
  47 #if PLATFORM(WX)
  48 class wxScrollWinEvent;
  49 #endif
  50
  51 namespace WebCore {
  52
  53 class HostWindow;
  54 class Scrollbar;
  55
  56 class ScrollView : public Widget, public ScrollableArea {
  57 public:
  58     ~ScrollView();
  59
  60     // ScrollableArea functions.  FrameView overrides the others.
  61     virtual int scrollSize(ScrollbarOrientation orientation) const;
  62     virtual int scrollPosition(Scrollbar*) const;
  63     virtual void setScrollOffset(const IntPoint&);
  64     virtual void didCompleteRubberBand(const IntSize&) const;
  65
  66     // NOTE: This should only be called by the overriden setScrollOffset from ScrollableArea.
  67     virtual void scrollTo(const IntSize& newOffset);
  68
  69     // The window thats hosts the ScrollView. The ScrollView will communicate scrolls and repaints to the
  70     // host window in the window's coordinate space.
  71     virtual HostWindow* hostWindow() const = 0;
  72
  73     // Returns a clip rect in host window coordinates. Used to clip the blit on a scroll.
  74     virtual IntRect windowClipRect(bool clipToContents = true) const = 0;
  75
  76     // Functions for child manipulation and inspection.
  77     const HashSet<RefPtr<Widget> >* children() const { return &m_children; }
  78     void addChild(PassRefPtr<Widget>);
  79     void removeChild(Widget*);
  80
  81     // If the scroll view does not use a native widget, then it will have cross-platform Scrollbars. These functions
  82     // can be used to obtain those scrollbars.
  83     virtual Scrollbar* horizontalScrollbar() const { return m_horizontalScrollbar.get(); }
  84     virtual Scrollbar* verticalScrollbar() const { return m_verticalScrollbar.get(); }
  85     bool isScrollViewScrollbar(const Widget* child) const { return horizontalScrollbar() == child || verticalScrollbar() == child; }
  86
  87     // Functions for setting and retrieving the scrolling mode in each axis (horizontal/vertical). The mode has values of
  88     // AlwaysOff, AlwaysOn, and Auto. AlwaysOff means never show a scrollbar, AlwaysOn means always show a scrollbar.
  89     // Auto means show a scrollbar only when one is needed.
  90     // Note that for platforms with native widgets, these modes are considered advisory. In other words the underlying native
  91     // widget may choose not to honor the requested modes.
  92     void setScrollbarModes(ScrollbarMode horizontalMode, ScrollbarMode verticalMode, bool horizontalLock = false, bool verticalLock = false);
  93     void setHorizontalScrollbarMode(ScrollbarMode mode, bool lock = false) { setScrollbarModes(mode, verticalScrollbarMode(), lock, verticalScrollbarLock()); }
  94     void setVerticalScrollbarMode(ScrollbarMode mode, bool lock = false) { setScrollbarModes(horizontalScrollbarMode(), mode, horizontalScrollbarLock(), lock); };
  95     void scrollbarModes(ScrollbarMode& horizontalMode, ScrollbarMode& verticalMode) const;
  96     ScrollbarMode horizontalScrollbarMode() const { ScrollbarMode horizontal, vertical; scrollbarModes(horizontal, vertical); return horizontal; }
  97     ScrollbarMode verticalScrollbarMode() const { ScrollbarMode horizontal, vertical; scrollbarModes(horizontal, vertical); return vertical; }
  98
  99     void setHorizontalScrollbarLock(bool lock = true) { m_horizontalScrollbarLock = lock; }
 100     bool horizontalScrollbarLock() const { return m_horizontalScrollbarLock; }
 101     void setVerticalScrollbarLock(bool lock = true) { m_verticalScrollbarLock = lock; }
 102     bool verticalScrollbarLock() const { return m_verticalScrollbarLock; }
 103
 104     void setScrollingModesLock(bool lock = true) { m_horizontalScrollbarLock = m_verticalScrollbarLock = lock; }
 105
 106     virtual void setCanHaveScrollbars(bool);
 107     bool canHaveScrollbars() const { return horizontalScrollbarMode() != ScrollbarAlwaysOff || verticalScrollbarMode() != ScrollbarAlwaysOff; }
 108
 109     virtual bool avoidScrollbarCreation() const { return false; }
 110
 111     // By default you only receive paint events for the area that is visible. In the case of using a
 112     // tiled backing store, this function can be set, so that the view paints the entire contents.
 113     bool paintsEntireContents() const { return m_paintsEntireContents; }
 114     void setPaintsEntireContents(bool);
 115
 116     // By default, paint events are clipped to the visible area.  If set to
 117     // false, paint events are no longer clipped.  paintsEntireContents() implies !clipsRepaints().
 118     bool clipsRepaints() const { return m_clipsRepaints; }
 119     void setClipsRepaints(bool);
 120
 121     // By default programmatic scrolling is handled by WebCore and not by the UI application.
 122     // In the case of using a tiled backing store, this mode can be set, so that the scroll requests
 123     // are delegated to the UI application.
 124     bool delegatesScrolling() const { return m_delegatesScrolling; }
 125     void setDelegatesScrolling(bool);
 126
 127     // Overridden by FrameView to create custom CSS scrollbars if applicable.
 128     virtual PassRefPtr<Scrollbar> createScrollbar(ScrollbarOrientation);
 129
 130     // If the prohibits scrolling flag is set, then all scrolling in the view (even programmatic scrolling) is turned off.
 131     void setProhibitsScrolling(bool b) { m_prohibitsScrolling = b; }
 132     bool prohibitsScrolling() const { return m_prohibitsScrolling; }
 133
 134     // Whether or not a scroll view will blit visible contents when it is scrolled. Blitting is disabled in situations
 135     // where it would cause rendering glitches (such as with fixed backgrounds or when the view is partially transparent).
 136     void setCanBlitOnScroll(bool);
 137     bool canBlitOnScroll() const;
 138
 139     // The visible content rect has a location that is the scrolled offset of the document. The width and height are the viewport width
 140     // and height. By default the scrollbars themselves are excluded from this rectangle, but an optional boolean argument allows them to be
 141     // included.
 142     // In the situation the client is responsible for the scrolling (ie. with a tiled backing store) it is possible to use
 143     // the actualVisibleContentRect instead, though this must be updated manually, e.g after panning ends.
 144     IntRect visibleContentRect(bool includeScrollbars = false) const;
 145     IntRect actualVisibleContentRect() const { return m_actualVisibleContentRect.isEmpty() ? visibleContentRect() : m_actualVisibleContentRect; }
 146     void setActualVisibleContentRect(const IntRect& actualVisibleContentRect) { m_actualVisibleContentRect = actualVisibleContentRect; }
 147     int visibleWidth() const { return visibleContentRect().width(); }
 148     int visibleHeight() const { return visibleContentRect().height(); }
 149
 150     // Functions for getting/setting the size webkit should use to layout the contents. By default this is the same as the visible
 151     // content size. Explicitly setting a layout size value will cause webkit to layout the contents using this size instead.
 152     int layoutWidth() const;
 153     int layoutHeight() const;
 154     IntSize fixedLayoutSize() const;
 155     void setFixedLayoutSize(const IntSize&);
 156     bool useFixedLayout() const;
 157     void setUseFixedLayout(bool enable);
 158
 159     // Functions for getting/setting the size of the document contained inside the ScrollView (as an IntSize or as individual width and height
 160     // values).
 161     IntSize contentsSize() const; // Always at least as big as the visibleWidth()/visibleHeight().
 162     int contentsWidth() const { return contentsSize().width(); }
 163     int contentsHeight() const { return contentsSize().height(); }
 164     virtual void setContentsSize(const IntSize&);
 165
 166 #if PLATFORM(ANDROID)
 167     int actualWidth() const;
 168     int actualHeight() const;
 169     int actualScrollX() const;
 170     int actualScrollY() const;
 171 #endif
 172
 173     // Functions for querying the current scrolled position (both as a point, a size, or as individual X and Y values).
 174     IntPoint scrollPosition() const { return visibleContentRect().location(); }
 175     IntSize scrollOffset() const { return visibleContentRect().location() - IntPoint(); } // Gets the scrolled position as an IntSize. Convenient for adding to other sizes.
 176     IntPoint maximumScrollPosition() const; // The maximum position we can be scrolled to.
 177     IntPoint minimumScrollPosition() const; // The minimum position we can be scrolled to.
 178     // Adjust the passed in scroll position to keep it between the minimum and maximum positions.
 179     IntPoint adjustScrollPositionWithinRange(const IntPoint&) const;
 180     int scrollX() const { return scrollPosition().x(); }
 181     int scrollY() const { return scrollPosition().y(); }
 182
 183     IntSize overhangAmount() const;
 184
 185     // Functions for scrolling the view.
 186     void setScrollPosition(const IntPoint&);
 187     void scrollBy(const IntSize& s) { return setScrollPosition(scrollPosition() + s); }
 188
 189     // This function scrolls by lines, pages or pixels.
 190     bool scroll(ScrollDirection, ScrollGranularity);
 191
 192     // A logical scroll that just ends up calling the corresponding physical scroll() based off the document's writing mode.
 193     bool logicalScroll(ScrollLogicalDirection, ScrollGranularity);
 194
 195     // Scroll the actual contents of the view (either blitting or invalidating as needed).
 196     void scrollContents(const IntSize& scrollDelta);
 197
 198     // This gives us a means of blocking painting on our scrollbars until the first layout has occurred.
 199     void setScrollbarsSuppressed(bool suppressed, bool repaintOnUnsuppress = false);
 200     bool scrollbarsSuppressed() const { return m_scrollbarsSuppressed; }
 201
 202     // Event coordinates are assumed to be in the coordinate space of a window that contains
 203     // the entire widget hierarchy. It is up to the platform to decide what the precise definition
 204     // of containing window is. (For example on Mac it is the containing NSWindow.)
 205     IntPoint windowToContents(const IntPoint&) const;
 206     IntPoint contentsToWindow(const IntPoint&) const;
 207     IntRect windowToContents(const IntRect&) const;
 208     IntRect contentsToWindow(const IntRect&) const;
 209
 210     // Functions for converting to and from screen coordinates.
 211     IntRect contentsToScreen(const IntRect&) const;
 212     IntPoint screenToContents(const IntPoint&) const;
 213
 214     // The purpose of this function is to answer whether or not the scroll view is currently visible. Animations and painting updates can be suspended if
 215     // we know that we are either not in a window right now or if that window is not visible.
 216     bool isOffscreen() const;
 217
 218     // These functions are used to enable scrollbars to avoid window resizer controls that overlap the scroll view. This happens on Mac
 219     // for example.
 220     virtual IntRect windowResizerRect() const { return IntRect(); }
 221     bool containsScrollbarsAvoidingResizer() const;
 222     void adjustScrollbarsAvoidingResizerCount(int overlapDelta);
 223     void windowResizerRectChanged();
 224
 225     virtual void setParent(ScrollView*); // Overridden to update the overlapping scrollbar count.
 226
 227     // Called when our frame rect changes (or the rect/scroll position of an ancestor changes).
 228     virtual void frameRectsChanged();
 229
 230     // Widget override to update our scrollbars and notify our contents of the resize.
 231     virtual void setFrameRect(const IntRect&);
 232     virtual void setBoundsSize(const IntSize&);
 233
 234     // For platforms that need to hit test scrollbars from within the engine's event handlers (like Win32).
 235     Scrollbar* scrollbarAtPoint(const IntPoint& windowPoint);
 236
 237     // This function exists for scrollviews that need to handle wheel events manually.
 238     // On Mac the underlying NSScrollView just does the scrolling, but on other platforms
 239     // (like Windows), we need this function in order to do the scroll ourselves.
 240     void wheelEvent(PlatformWheelEvent&);
 241 #if ENABLE(GESTURE_EVENTS)
 242     void gestureEvent(const PlatformGestureEvent&);
 243 #endif
 244
 245     IntPoint convertChildToSelf(const Widget* child, const IntPoint& point) const
 246     {
 247         IntPoint newPoint = point;
 248         if (!isScrollViewScrollbar(child))
 249             newPoint = point - scrollOffset();
 250         newPoint.move(child->x(), child->y());
 251         return newPoint;
 252     }
 253
 254     IntPoint convertSelfToChild(const Widget* child, const IntPoint& point) const
 255     {
 256         IntPoint newPoint = point;
 257         if (!isScrollViewScrollbar(child))
 258             newPoint = point + scrollOffset();
 259         newPoint.move(-child->x(), -child->y());
 260         return newPoint;
 261     }
 262
 263     // Widget override. Handles painting of the contents of the view as well as the scrollbars.
 264     virtual void paint(GraphicsContext*, const IntRect&);
 265     void paintScrollbars(GraphicsContext*, const IntRect&);
 266
 267     // Widget overrides to ensure that our children's visibility status is kept up to date when we get shown and hidden.
 268     virtual void show();
 269     virtual void hide();
 270     virtual void setParentVisible(bool);
 271
 272     // Pan scrolling.
 273     static const int noPanScrollRadius = 15;
 274     void addPanScrollIcon(const IntPoint&);
 275     void removePanScrollIcon();
 276     void paintPanScrollIcon(GraphicsContext*);
 277
 278     virtual bool isPointInScrollbarCorner(const IntPoint&);
 279     virtual bool scrollbarCornerPresent() const;
 280
 281     virtual IntRect convertFromScrollbarToContainingView(const Scrollbar*, const IntRect&) const;
 282     virtual IntRect convertFromContainingViewToScrollbar(const Scrollbar*, const IntRect&) const;
 283     virtual IntPoint convertFromScrollbarToContainingView(const Scrollbar*, const IntPoint&) const;
 284     virtual IntPoint convertFromContainingViewToScrollbar(const Scrollbar*, const IntPoint&) const;
 285
 286 protected:
 287     ScrollView();
 288
 289     virtual void repaintContentRectangle(const IntRect&, bool now = false);
 290     virtual void paintContents(GraphicsContext*, const IntRect& damageRect) = 0;
 291
 292     void calculateOverhangAreasForPainting(IntRect& horizontalOverhangRect, IntRect& verticalOverhangRect);
 293     virtual void paintOverhangAreas(GraphicsContext*, const IntRect& horizontalOverhangArea, const IntRect& verticalOverhangArea, const IntRect& dirtyRect);
 294
 295     virtual void contentsResized() = 0;
 296     virtual void visibleContentsResized() = 0;
 297
 298     IntSize boundsSize() const { return m_boundsSize; }
 299     void setInitialBoundsSize(const IntSize&);
 300
 301     // These functions are used to create/destroy scrollbars.
 302     void setHasHorizontalScrollbar(bool);
 303     void setHasVerticalScrollbar(bool);
 304
 305     IntRect scrollCornerRect() const;
 306     virtual void updateScrollCorner();
 307     virtual void paintScrollCorner(GraphicsContext*, const IntRect& cornerRect);
 308
 309     // Scroll the content by blitting the pixels.
 310     virtual bool scrollContentsFastPath(const IntSize& scrollDelta, const IntRect& rectToScroll, const IntRect& clipRect);
 311     // Scroll the content by invalidating everything.
 312     virtual void scrollContentsSlowPath(const IntRect& updateRect);
 313
 314     void setScrollOrigin(const IntPoint&, bool updatePositionAtAll, bool updatePositionSynchronously);
 315     IntPoint scrollOrigin() { return m_scrollOrigin; }
 316
 317     // Subclassed by FrameView to check the writing-mode of the document.
 318     virtual bool isVerticalDocument() const { return true; }
 319     virtual bool isFlippedDocument() const { return false; }
 320
 321 private:
 322     RefPtr<Scrollbar> m_horizontalScrollbar;
 323     RefPtr<Scrollbar> m_verticalScrollbar;
 324     ScrollbarMode m_horizontalScrollbarMode;
 325     ScrollbarMode m_verticalScrollbarMode;
 326
 327     bool m_horizontalScrollbarLock;
 328     bool m_verticalScrollbarLock;
 329
 330     bool m_prohibitsScrolling;
 331
 332     HashSet<RefPtr<Widget> > m_children;
 333
 334     // This bool is unused on Mac OS because we directly ask the platform widget
 335     // whether it is safe to blit on scroll.
 336     bool m_canBlitOnScroll;
 337
 338     IntRect m_actualVisibleContentRect;
 339     IntSize m_scrollOffset; // FIXME: Would rather store this as a position, but we will wait to make this change until more code is shared.
 340     IntSize m_fixedLayoutSize;
 341     IntSize m_contentsSize;
 342
 343     int m_scrollbarsAvoidingResizer;
 344     bool m_scrollbarsSuppressed;
 345
 346     bool m_inUpdateScrollbars;
 347     unsigned m_updateScrollbarsPass;
 348
 349     IntPoint m_panScrollIconPoint;
 350     bool m_drawPanScrollIcon;
 351     bool m_useFixedLayout;
 352
 353     bool m_paintsEntireContents;
 354     bool m_clipsRepaints;
 355     bool m_delegatesScrolling;
 356
 357     // There are 8 possible combinations of writing mode and direction.  Scroll origin will be non-zero in the x or y axis
 358     // if there is any reversed direction or writing-mode.  The combinations are:
 359     // writing-mode / direction     scrollOrigin.x() set    scrollOrigin.y() set
 360     // horizontal-tb / ltr          NO                      NO
 361     // horizontal-tb / rtl          YES                     NO
 362     // horizontal-bt / ltr          NO                      YES
 363     // horizontal-bt / rtl          YES                     YES
 364     // vertical-lr / ltr            NO                      NO
 365     // vertical-lr / rtl            NO                      YES
 366     // vertical-rl / ltr            YES                     NO
 367     // vertical-rl / rtl            YES                     YES
 368     IntPoint m_scrollOrigin;
 369
 370     IntSize m_boundsSize;
 371
 372     void init();
 373     void destroy();
 374
 375     // Called to update the scrollbars to accurately reflect the state of the view.
 376     void updateScrollbars(const IntSize& desiredOffset);
 377
 378     // Called when the scroll position within this view changes.  FrameView overrides this to generate repaint invalidations.
 379     virtual void repaintFixedElementsAfterScrolling() {}
 380
 381     void platformInit();
 382     void platformDestroy();
 383     void platformAddChild(Widget*);
 384     void platformRemoveChild(Widget*);
 385     void platformSetScrollbarModes();
 386     void platformScrollbarModes(ScrollbarMode& horizontal, ScrollbarMode& vertical) const;
 387     void platformSetCanBlitOnScroll(bool);
 388     bool platformCanBlitOnScroll() const;
 389     IntRect platformVisibleContentRect(bool includeScrollbars) const;
 390     IntSize platformContentsSize() const;
 391     void platformSetContentsSize();
 392     IntRect platformContentsToScreen(const IntRect&) const;
 393     IntPoint platformScreenToContents(const IntPoint&) const;
 394     void platformSetScrollPosition(const IntPoint&);
 395     bool platformScroll(ScrollDirection, ScrollGranularity);
 396     void platformSetScrollbarsSuppressed(bool repaintOnUnsuppress);
 397     void platformRepaintContentRectangle(const IntRect&, bool now);
 398     bool platformIsOffscreen() const;
 399
 400     void platformSetScrollOrigin(const IntPoint&, bool updatePositionAtAll, bool updatePositionSynchronously);
 401
 402 #if PLATFORM(ANDROID)
 403     int platformActualWidth() const;
 404     int platformActualHeight() const;
 405     int platformActualScrollX() const;
 406     int platformActualScrollY() const;
 407 #endif
 408
 409 #if PLATFORM(MAC) && defined __OBJC__
 410 public:
 411     NSView* documentView() const;
 412
 413 private:
 414     NSScrollView<WebCoreFrameScrollView>* scrollView() const;
 415 #endif
 416
 417 #if PLATFORM(GTK)
 418 public:
 419     void setGtkAdjustments(GtkAdjustment* hadj, GtkAdjustment* vadj, bool resetValues = true);
 420     void setHorizontalAdjustment(GtkAdjustment* hadj, bool resetValues = true);
 421     void setVerticalAdjustment(GtkAdjustment* vadj, bool resetValues = true);
 422     void setScrollOffset(const IntSize& offset) { m_scrollOffset = offset; }
 423
 424 private:
 425     GRefPtr<GtkAdjustment> m_horizontalAdjustment;
 426     GRefPtr<GtkAdjustment> m_verticalAdjustment;
 427 #endif
 428
 429 #if PLATFORM(WX)
 430 public:
 431     virtual void setPlatformWidget(wxWindow*);
 432     void adjustScrollbars(int x = -1, int y = -1, bool refresh = true);
 433 private:
 434     class ScrollViewPrivate;
 435     ScrollViewPrivate* m_data;
 436 #endif
 437
 438 #ifdef ANDROID_CAPTURE_OFFSCREEN_PAINTS
 439 public:
 440     // capture parts of rect not contained by vis
 441     void platformOffscreenContentRectangle(const IntRect& vis,
 442         const IntRect& rect);
 443 #endif
 444 }; // class ScrollView
 445
 446 } // namespace WebCore
 447
 448 #endif // ScrollView_h