*****************
wx.ScrollWinEvent
*****************

Inheritance diagram for `wx.ScrollWinEvent`:

|

.. inheritance-diagram:: wx.ScrollWinEvent

|

Description
===========

A scroll event holds information about events sent from scrolling windows.


.. seealso:: `wx.ScrollEvent <wx.ScrollEvent.html>`_


Derived From
^^^^^^^^^^^^^

* `wx.Event <wx.Event.html>`_ 
* `wx.Object <../Widgets/wx.Object.html>`_ 


Event Handling
^^^^^^^^^^^^^^

==================================================  ==================================================  
Event Name                                          Description
==================================================  ==================================================  
wx.EVT_SCROLLWIN(func)                              Process all scroll events.  
wx.EVT_SCROLLWIN_TOP(func)                          Process ``wx.wxEVT_SCROLLWIN_TOP`` scroll-to-top events.  
wx.EVT_SCROLLWIN_BOTTOM(func)                       Process ``wx.wxEVT_SCROLLWIN_BOTTOM`` scroll-to-bottom events.  
wx.EVT_SCROLLWIN_LINEUP(func)                       Process ``wx.wxEVT_SCROLLWIN_LINEUP`` line up events.  
wx.EVT_SCROLLWIN_LINEDOWN(func)                     Process ``wx.wxEVT_SCROLLWIN_LINEDOWN`` line down events.  
wx.EVT_SCROLLWIN_PAGEUP(func)                       Process ``wx.wxEVT_SCROLLWIN_PAGEUP`` page up events.  
wx.EVT_SCROLLWIN_PAGEDOWN(func)                     Process ``wx.wxEVT_SCROLLWIN_PAGEDOWN`` page down events.  
wx.EVT_SCROLLWIN_THUMBTRACK(func)                   Process ``wx.wxEVT_SCROLLWIN_THUMBTRACK`` thumbtrack events (frequent events sent as the user drags the thumbtrack).  
wx.EVT_SCROLLWIN_THUMBRELEASE(func)                 Process ``wx.wxEVT_SCROLLWIN_THUMBRELEASE`` thumb release events.  
==================================================  ==================================================  


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetOrientation <#GetOrientation>`_ 
* `GetPosition <#GetPosition>`_ 
* `SetOrientation <#SetOrientation>`_ 
* `SetPosition <#SetPosition>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `Orientation <#Orientation>`_ 
* `Position <#Position>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(commandType=wx.wxEVT_NULL, pos=0, orient=0)

   A `wx.ScrollWinEvent` holds information about scrolling and is sent from
   scrolling windows.
   
   **Parameters:**

   * `commandType` (eventtype)
   * `pos` (int)
   * `orient` (int)

   |

   **Returns:**

   `wx.ScrollWinEvent <wx.ScrollWinEvent.html>`_
 

--------

.. method:: GetOrientation()

   Returns ``wx.HORIZONTAL`` or ``wx.VERTICAL``, depending on the orientation of the scrollbar.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetPosition()

   Returns the position of the scrollbar for the thumb track and release events. 

   |  

   **Returns:**

   `int` 


.. note:: Note that this field can't be used for the other events, you need to query the window itself for the current position in that case.

--------

.. method:: SetOrientation(orient)

   |
   
   **Parameters:**

   * `orient` (int)

--------

.. method:: SetPosition(pos)

   |

   **Parameters:**

   * `pos` (int)


--------

Properties
^^^^^^^^^^


.. attribute:: Orientation

   See `GetOrientation <#GetOrientation>`_ and `SetOrientation <#SetOrientation>`_

.. attribute:: Position

   See `GetPosition <#GetPosition>`_ and `SetPosition <#SetPosition>`_