<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year><year>2021</year>
    <holder>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxScrollEvent</title>
</header>
<module>wxScrollEvent</module>
<modulesummary>Functions for wxScrollEvent class</modulesummary>
<description><p>A scroll event holds information about events sent from stand-alone scrollbars (see <seeerl marker="wxScrollBar"><c>wxScrollBar</c></seeerl>) and sliders (see <seeerl marker="wxSlider"><c>wxSlider</c></seeerl>).
      </p><p>Note that scrolled windows send the <seeerl marker="wxScrollWinEvent"><c>wxScrollWinEvent</c></seeerl> which does not derive from <seeerl marker="wxCommandEvent"><c>wxCommandEvent</c></seeerl>, but from <seeerl marker="wxEvent"><c>wxEvent</c></seeerl> directly - don't confuse these two kinds of events and use the event table macros mentioned below only for the scrollbar-like controls.
      </p><p>The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED</p> <p>The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the thumb using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event is also followed by an EVT_SCROLL_CHANGED event).
      </p> <p>The EVT_SCROLL_CHANGED event also occurs when using the keyboard to change the thumb position, and when clicking next to the thumb (In all these cases the EVT_SCROLL_THUMBRELEASE event does not happen).
      </p> <p>In short, the EVT_SCROLL_CHANGED event is triggered when scrolling/ moving has finished independently of the way it had started. Please see the page_samples_widgets ("Slider" page) to see the difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
      </p> <p>Remark: Note that unless specifying a scroll control identifier, you will need to test for scrollbar orientation with <seemfa marker="#getOrientation/1"><c>getOrientation/1</c></seemfa>, since horizontal and vertical scroll events are processed using the same event handler.
      </p><p>See: <seeerl marker="wxScrollBar"><c>wxScrollBar</c></seeerl>, <seeerl marker="wxSlider"><c>wxSlider</c></seeerl>, <seeerl marker="wxSpinButton"><c>wxSpinButton</c></seeerl>, <seeerl marker="wxScrollWinEvent"><c>wxScrollWinEvent</c></seeerl>, <url href="https://docs.wxwidgets.org/3.1/overview_events.html#overview_events">Overview events</url>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxCommandEvent"><c>wxCommandEvent</c></seeerl> <seeerl marker="wxEvent"><c>wxEvent</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_scroll_event.html">wxScrollEvent</url></p>
  </description><section><title>Events</title><p>Use <seemfa marker="wxEvtHandler#connect/3"><c>wxEvtHandler:connect/3</c></seemfa> with <seetype marker="#wxScrollEventType"><c>wxScrollEventType</c></seetype> to subscribe to events of this type.</p></section>
<datatypes>
    <datatype><name name="wxScrollEvent"/></datatype>
    <datatype><name name="wxScroll"/></datatype>
    <datatype><name name="wxScrollEventType"/></datatype></datatypes>

<funcs>
  <func>
    <name name="getOrientation" arity="1" clause_i="1" since=""/>
    <fsummary>Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the scrollbar. </fsummary>
    <desc><p>Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the scrollbar. 
      </p></desc>
  </func>
  
  <func>
    <name name="getPosition" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the position of the scrollbar. </fsummary>
    <desc><p>Returns the position of the scrollbar. 
      </p></desc>
  </func>
  </funcs>
</erlref>
