.. include:: headings.inc

.. currentmodule:: lib.dragscroller

.. highlight:: python



.. _lib.dragscroller.DragScroller:

==========================================================================================================================================
|phoenix_title|  **DragScroller**
==========================================================================================================================================

Scrolls a wx.ScrollWindow in the direction and speed of a mouse drag.

Call Start with the position of the drag start.
Call Stop on the drag release. 



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **DragScroller**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.dragscroller.DragScroller_inheritance.png" alt="Inheritance diagram of DragScroller" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.dragscroller.DragScroller.html" title="Scrolls a wx.ScrollWindow in the direction and speed of a mouse drag." alt="" coords="5,5,211,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~lib.dragscroller.DragScroller.__init__`                                  
:meth:`~lib.dragscroller.DragScroller.GetScrollWindow`                           
:meth:`~lib.dragscroller.DragScroller.GetSensitivity`                            
:meth:`~lib.dragscroller.DragScroller.GetUpdateRate`                             
:meth:`~lib.dragscroller.DragScroller.OnTimerDoScroll`                           
:meth:`~lib.dragscroller.DragScroller.SetScrollWindow`                           
:meth:`~lib.dragscroller.DragScroller.SetSensitivity`                            
:meth:`~lib.dragscroller.DragScroller.SetUpdateRate`                             
:meth:`~lib.dragscroller.DragScroller.Start`                                     Start a drag scroll operation
:meth:`~lib.dragscroller.DragScroller.Stop`                                      Stops a drag scroll operation
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: DragScroller

   Scrolls a wx.ScrollWindow in the direction and speed of a mouse drag.
   
   Call Start with the position of the drag start.
   Call Stop on the drag release. 

   .. method:: __init__(self, scrollwin, rate=30, sensitivity=0.75)


   .. method:: GetScrollWindow(self)


   .. method:: GetSensitivity(self)


   .. method:: GetUpdateRate(self)


   .. method:: OnTimerDoScroll(self, event)


   .. method:: SetScrollWindow(self, scrollwin)


   .. method:: SetSensitivity(self, sensitivity)


   .. method:: SetUpdateRate(self, rate)


   .. method:: Start(self, pos)

      Start a drag scroll operation 


   .. method:: Stop(self)

      Stops a drag scroll operation