<?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>
    <holder>Ericsson AB. All Rights Reserved.</holder></copyright>
  <legalnotice>
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

  </legalnotice>
  <title>wxSpinButton</title>
</header>
<module>wxSpinButton</module>
<modulesummary>Functions for wxSpinButton class</modulesummary>
<description><p>A <seeerl marker="wxSpinButton"><c>wxSpinButton</c></seeerl> has two small up and down (or left and right) arrow buttons.
      </p><p>It is often used next to a text control for increment and decrementing a value. Portable programs should try to use <seeerl marker="wxSpinCtrl"><c>wxSpinCtrl</c></seeerl> instead as <seeerl marker="wxSpinButton"><c>wxSpinButton</c></seeerl> is not implemented for all platforms but <seeerl marker="wxSpinCtrl"><c>wxSpinCtrl</c></seeerl> is as it degenerates to a simple <seeerl marker="wxTextCtrl"><c>wxTextCtrl</c></seeerl> on such platforms.
      </p><p>Note: the range supported by this control (and <seeerl marker="wxSpinCtrl"><c>wxSpinCtrl</c></seeerl>) depends on the platform but is at least <c>-0x8000</c> to <c>0x7fff</c>. Under GTK and Win32 with sufficiently new version of <c>comctrl32.dll</c> (at least 4.71 is required, 5.80 is recommended) the full 32 bit range is supported.
      </p><p>Styles</p><p>This class supports the following styles:
      </p><p>See: <seeerl marker="wxSpinCtrl"><c>wxSpinCtrl</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_spin_button.html">wxSpinButton</url></p>
  </description><section><title>Events</title><p>Event types emitted from this class: <seeerl marker="wxSpinEvent"><c>spin</c></seeerl>, <seeerl marker="wxSpinEvent"><c>spin_up</c></seeerl>, <seeerl marker="wxSpinEvent"><c>spin_down</c></seeerl></p></section>
<datatypes><datatype><name name="wxSpinButton"/></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="1" clause_i="1" since=""/>
    <fsummary>See: <c>new/2</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary>Constructor, creating and showing a spin button. </fsummary>
    <desc><p>Constructor, creating and showing a spin button. 
      </p><p>See: <seemfa marker="#create/3"><c>create/3</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor, destroys the spin button control. </fsummary>
    <desc><p>Destructor, destroys the spin button control. 
      </p></desc>
  </func>
  
  <func>
    <name name="create" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>create/3</c></fsummary>
  </func>
  
  <func>
    <name name="create" arity="3" clause_i="1" since=""/>
    <fsummary>Scrollbar creation function called by the spin button constructor. </fsummary>
    <desc><p>Scrollbar creation function called by the spin button constructor. 
      </p><p>See <seemfa marker="#new/2"><c>new/2</c></seemfa> for details. 
      </p></desc>
  </func>
  
  <func>
    <name name="getMax" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the maximum permissible value. </fsummary>
    <desc><p>Returns the maximum permissible value. 
      </p><p>See: <seemfa marker="#setRange/3"><c>setRange/3</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getMin" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the minimum permissible value. </fsummary>
    <desc><p>Returns the minimum permissible value. 
      </p><p>See: <seemfa marker="#setRange/3"><c>setRange/3</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getValue" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the current spin button value. </fsummary>
    <desc><p>Returns the current spin button value. 
      </p><p>See: <seemfa marker="#setValue/2"><c>setValue/2</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="setRange" arity="3" clause_i="1" since=""/>
    <fsummary>Sets the range of the spin button. </fsummary>
    <desc><p>Sets the range of the spin button. 
      </p><p>In portable code, <c>min</c> should be less than or equal to <c>max</c>. In wxMSW it is possible to specify minimum greater than maximum and the native control supports the same range as if they were reversed, but swaps the meaning of up and down arrows, however this dubious feature is not supported on other platforms.
      </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="setValue" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the value of the spin button. </fsummary>
    <desc><p>Sets the value of the spin button. 
      </p></desc>
  </func>
  </funcs>
</erlref>
