src/third_party/WebKit/Source/core/page/AutoscrollController.h

   1 /*
   2  * Copyright (C) 2006, 2007, 2009, 2010, 2011 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 COMPUTER, 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 COMPUTER, 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 AutoscrollController_h
  27 #define AutoscrollController_h
  28
  29 #include "platform/geometry/IntPoint.h"
  30 #include "wtf/PassOwnPtr.h"
  31
  32 namespace blink {
  33
  34 class LocalFrame;
  35 class FrameView;
  36 class Node;
  37 class Page;
  38 class PlatformMouseEvent;
  39 class RenderBox;
  40 class RenderObject;
  41
  42 enum AutoscrollType {
  43     NoAutoscroll,
  44     AutoscrollForDragAndDrop,
  45     AutoscrollForSelection,
  46 #if OS(WIN)
  47     AutoscrollForPanCanStop,
  48     AutoscrollForPan,
  49 #endif
  50 };
  51
  52 // AutscrollController handels autoscroll and pan scroll for EventHandler.
  53 class AutoscrollController {
  54 public:
  55     static PassOwnPtr<AutoscrollController> create(Page&);
  56
  57     void animate(double monotonicFrameBeginTime);
  58     bool autoscrollInProgress() const;
  59     bool autoscrollInProgress(const RenderBox*) const;
  60     bool panScrollInProgress() const;
  61     void startAutoscrollForSelection(RenderObject*);
  62     void stopAutoscroll();
  63     void stopAutoscrollIfNeeded(RenderObject*);
  64     void updateAutoscrollRenderer();
  65     void updateDragAndDrop(Node* targetNode, const IntPoint& eventPosition, double eventTime);
  66 #if OS(WIN)
  67     void handleMouseReleaseForPanScrolling(LocalFrame*, const PlatformMouseEvent&);
  68     void startPanScrolling(RenderBox*, const IntPoint&);
  69 #endif
  70
  71 private:
  72     explicit AutoscrollController(Page&);
  73
  74     void startAutoscroll();
  75
  76 #if OS(WIN)
  77     void updatePanScrollState(FrameView*, const IntPoint& lastKnownMousePosition);
  78 #endif
  79
  80     Page& m_page;
  81     RenderBox* m_autoscrollRenderer;
  82     AutoscrollType m_autoscrollType;
  83     IntPoint m_dragAndDropAutoscrollReferencePosition;
  84     double m_dragAndDropAutoscrollStartTime;
  85 #if OS(WIN)
  86     IntPoint m_panScrollStartPos;
  87 #endif
  88 };
  89
  90 } // namespace blink
  91
  92 #endif // AutoscrollController_h