src/third_party/WebKit/Source/platform/scroll/FramelessScrollView.h

   1 /*
   2  * Copyright (c) 2008, 2009, Google 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 are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef FramelessScrollView_h
  32 #define FramelessScrollView_h
  33
  34 #include "platform/PlatformExport.h"
  35 #include "platform/scroll/ScrollView.h"
  36
  37 namespace blink {
  38
  39 class FramelessScrollViewClient;
  40 class PlatformGestureEvent;
  41 class PlatformKeyboardEvent;
  42 class PlatformMouseEvent;
  43 class PlatformTouchEvent;
  44 class PlatformWheelEvent;
  45
  46 // A FramelessScrollView is a ScrollView that can be used to render custom
  47 // content, which does not have an associated LocalFrame.
  48 //
  49 // NOTE: It may be better to just develop a custom subclass of Widget that
  50 // can have scroll bars for this instead of trying to reuse ScrollView.
  51 //
  52 class PLATFORM_EXPORT FramelessScrollView : public ScrollView {
  53 public:
  54     FramelessScrollView() : m_client(0) { }
  55     virtual ~FramelessScrollView();
  56
  57     FramelessScrollViewClient* client() const { return m_client; }
  58     void setClient(FramelessScrollViewClient* client) { m_client = client; }
  59
  60     // Event handlers that subclasses must implement.
  61     virtual bool handleMouseDownEvent(const PlatformMouseEvent&) = 0;
  62     virtual bool handleMouseMoveEvent(const PlatformMouseEvent&) = 0;
  63     virtual bool handleMouseReleaseEvent(const PlatformMouseEvent&) = 0;
  64     virtual bool handleWheelEvent(const PlatformWheelEvent&) = 0;
  65     virtual bool handleKeyEvent(const PlatformKeyboardEvent&) = 0;
  66     virtual bool handleTouchEvent(const PlatformTouchEvent&) = 0;
  67     virtual bool handleGestureEvent(const PlatformGestureEvent&) = 0;
  68
  69     // ScrollableArea public methods:
  70     virtual void invalidateScrollbarRect(Scrollbar*, const IntRect&) OVERRIDE;
  71     virtual bool isActive() const OVERRIDE;
  72     virtual bool scrollbarsCanBeActive() const OVERRIDE;
  73     virtual IntRect scrollableAreaBoundingBox() const OVERRIDE;
  74
  75     // Widget public methods:
  76     virtual void invalidateRect(const IntRect&) OVERRIDE;
  77
  78     // ScrollView public methods:
  79     virtual HostWindow* hostWindow() const OVERRIDE;
  80     virtual IntRect windowClipRect(IncludeScrollbarsInRect = ExcludeScrollbars) const OVERRIDE;
  81
  82 protected:
  83     // ScrollView protected methods:
  84     virtual void paintContents(GraphicsContext*, const IntRect&) OVERRIDE;
  85     virtual void contentsResized() OVERRIDE;
  86     virtual void scrollbarExistenceDidChange() OVERRIDE;
  87
  88 private:
  89     FramelessScrollViewClient* m_client;
  90 };
  91
  92 } // namespace blink
  93
  94 #endif