<?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>wxSlider</title>
</header>
<module>wxSlider</module>
<modulesummary>Functions for wxSlider class</modulesummary>
<description><p>A slider is a control with a handle which can be pulled back and forth to change the value.
      </p><p>On Windows, the track bar control is used.
      </p><p>On GTK+, tick marks are only available for version 2.16 and later.
      </p><p>Slider generates the same events as <seeerl marker="wxScrollBar"><c>wxScrollBar</c></seeerl> but in practice the most convenient way to process <seeerl marker="wxSlider"><c>wxSlider</c></seeerl> updates is by handling the slider-specific <c>wxEVT_SLIDER</c> event which carries <seeerl marker="wxCommandEvent"><c>wxCommandEvent</c></seeerl> containing just the latest slider position.
      </p><p>Styles</p><p>This class supports the following styles:
      </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). 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>See: <url href="https://docs.wxwidgets.org/3.1/overview_events.html#overview_events">Overview events</url>, <seeerl marker="wxScrollBar"><c>wxScrollBar</c></seeerl>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxControl"><c>wxControl</c></seeerl> <seeerl marker="wxWindow"><c>wxWindow</c></seeerl> <seeerl marker="wxEvtHandler"><c>wxEvtHandler</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_slider.html">wxSlider</url></p>
  </description><section><title>Events</title><p>Event types emitted from this class: <seeerl marker="wxScrollEvent"><c>scroll_top</c></seeerl>, <seeerl marker="wxScrollEvent"><c>scroll_bottom</c></seeerl>, <seeerl marker="wxScrollEvent"><c>scroll_lineup</c></seeerl>, <seeerl marker="wxScrollEvent"><c>scroll_linedown</c></seeerl>, <seeerl marker="wxScrollEvent"><c>scroll_pageup</c></seeerl>, <seeerl marker="wxScrollEvent"><c>scroll_pagedown</c></seeerl>, <seeerl marker="wxScrollEvent"><c>scroll_thumbtrack</c></seeerl>, <seeerl marker="wxScrollEvent"><c>scroll_thumbrelease</c></seeerl>, <seeerl marker="wxScrollEvent"><c>scroll_changed</c></seeerl>, <seeerl marker="wxScrollEvent"><c>scroll_top</c></seeerl>, <seeerl marker="wxScrollEvent"><c>scroll_bottom</c></seeerl>, <seeerl marker="wxScrollEvent"><c>scroll_lineup</c></seeerl>, <seeerl marker="wxScrollEvent"><c>scroll_linedown</c></seeerl>, <seeerl marker="wxScrollEvent"><c>scroll_pageup</c></seeerl>, <seeerl marker="wxScrollEvent"><c>scroll_pagedown</c></seeerl>, <seeerl marker="wxScrollEvent"><c>scroll_thumbtrack</c></seeerl>, <seeerl marker="wxScrollEvent"><c>scroll_thumbrelease</c></seeerl>, <seeerl marker="wxScrollEvent"><c>scroll_changed</c></seeerl>, <seeerl marker="wxCommandEvent"><c>command_slider_updated</c></seeerl></p></section>
<datatypes><datatype><name name="wxSlider"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Default constructor. </fsummary>
    <desc><p>Default constructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="5" clause_i="1" since=""/>
    <fsummary>See: <c>new/6</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="6" clause_i="1" since=""/>
    <fsummary>Constructor, creating and showing a slider. </fsummary>
    <desc><p>Constructor, creating and showing a slider. 
      </p><p>See: <seemfa marker="#create/7"><c>create/7</c></seemfa>, <c>wxValidator</c> (not implemented in wx)
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor, destroying the slider. </fsummary>
    <desc><p>Destructor, destroying the slider. 
      </p></desc>
  </func>
  
  <func>
    <name name="create" arity="6" clause_i="1" since=""/>
    <fsummary>See: <c>create/7</c></fsummary>
  </func>
  
  <func>
    <name name="create" arity="7" clause_i="1" since=""/>
    <fsummary>Used for two-step slider construction. </fsummary>
    <desc><p>Used for two-step slider construction. 
      </p><p>See <seemfa marker="#new/6"><c>new/6</c></seemfa> for further details. 
      </p></desc>
  </func>
  
  <func>
    <name name="getLineSize" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the line size. </fsummary>
    <desc><p>Returns the line size. 
      </p><p>See: <seemfa marker="#setLineSize/2"><c>setLineSize/2</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getMax" arity="1" clause_i="1" since=""/>
    <fsummary>Gets the maximum slider value. </fsummary>
    <desc><p>Gets the maximum slider value. 
      </p><p>See: <seemfa marker="#getMin/1"><c>getMin/1</c></seemfa>, <seemfa marker="#setRange/3"><c>setRange/3</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getMin" arity="1" clause_i="1" since=""/>
    <fsummary>Gets the minimum slider value. </fsummary>
    <desc><p>Gets the minimum slider value. 
      </p><p>See: <seemfa marker="#getMin/1"><c>getMin/1</c></seemfa>, <seemfa marker="#setRange/3"><c>setRange/3</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getPageSize" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the page size. </fsummary>
    <desc><p>Returns the page size. 
      </p><p>See: <seemfa marker="#setPageSize/2"><c>setPageSize/2</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getThumbLength" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the thumb length. </fsummary>
    <desc><p>Returns the thumb length. 
      </p><p>Only for:wxmsw</p><p>See: <seemfa marker="#setThumbLength/2"><c>setThumbLength/2</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getValue" arity="1" clause_i="1" since=""/>
    <fsummary>Gets the current slider value. </fsummary>
    <desc><p>Gets the current slider value. 
      </p><p>See: <seemfa marker="#getMin/1"><c>getMin/1</c></seemfa>, <seemfa marker="#getMax/1"><c>getMax/1</c></seemfa>, <seemfa marker="#setValue/2"><c>setValue/2</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="setLineSize" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the line size for the slider. </fsummary>
    <desc><p>Sets the line size for the slider. 
      </p><p>See: <seemfa marker="#getLineSize/1"><c>getLineSize/1</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="setPageSize" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the page size for the slider. </fsummary>
    <desc><p>Sets the page size for the slider. 
      </p><p>See: <seemfa marker="#getPageSize/1"><c>getPageSize/1</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="setRange" arity="3" clause_i="1" since=""/>
    <fsummary>Sets the minimum and maximum slider values. </fsummary>
    <desc><p>Sets the minimum and maximum slider values. 
      </p><p>See: <seemfa marker="#getMin/1"><c>getMin/1</c></seemfa>, <seemfa marker="#getMax/1"><c>getMax/1</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="setThumbLength" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the slider thumb length. </fsummary>
    <desc><p>Sets the slider thumb length. 
      </p><p>Only for:wxmsw</p><p>See: <seemfa marker="#getThumbLength/1"><c>getThumbLength/1</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="setValue" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the slider position. </fsummary>
    <desc><p>Sets the slider position. 
      </p></desc>
  </func>
  </funcs>
</erlref>
