.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxSpinButton 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxSpinButton \- 
  A spin or `up-down' control
 
.SH DESCRIPTION

  


   A wxSpinButton has two small up and down (or left and right) arrow buttons.
   It is often used next to a text control for increment and decrementing a
   value. Portable programs should try to use
   wxSpinCtrl
   instead as wxSpinButton is not implemented for all platforms.
  
  


   
    NB:
   
   the range supported by this control (and wxSpinCtrl) depends on the platform
   but is at least
   -0x8000
   to
   0x7fff
   . Under GTK and Win32 with sufficiently new version of
   comctrl32.dll
   (at least 4.71 is required, 5.80 is recommended) the full 32 bit range is
   supported.
  
 
.SH "PARENTS"

  wxControl
   
  wxWindow
   
  wxEvtHandler
   
  wxObject
 
.SH "INCLUDE FILES"
wx/spinbutt.h
.SH MEMBERS

  
.SS  wxSpinButton ()

     


      Default constructor.
     
    
.SS  wxSpinButton (wxWindow* parentwxWindowID idconst wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = wxSP_HORIZONTALconst wxString& name = ``spinButton")

     


      Constructor, creating and showing a spin button.
     
    
   
  
.SS void ~wxSpinButton ()

     


      Destructor, destroys the spin button control.
     
    
   
  
.SS bool Create (wxWindow* parentwxWindowID idconst wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = wxSP_HORIZONTALconst wxString& name = ``spinButton")

     


      Scrollbar creation function called by the spin button constructor. See
      wxSpinButton::wxSpinButton
      for details.
     
    
   
  
.SS int GetMax ()

     


      Returns the maximum permissible value.
     
    
   
  
.SS int GetMin ()

     


      Returns the minimum permissible value.
     
    
   
  
.SS int GetValue ()

     


      Returns the current spin button value.
     
    
   
  
.SS void SetRange (int minint max)

   
  
.SS void SetValue (int value)

     


      Sets the value of the spin button.
     
    
 
.SH "WINDOW STYLES"

.SS wxSP_HORIZONTAL

   Specifies a horizontal spin button (note that this style is not supported in
   wxGTK).
  
.SS wxSP_VERTICAL

   Specifies a vertical spin button.
  
.SS wxSP_ARROW_KEYS

   The user can use arrow keys to change the value.
  
.SS wxSP_WRAP

   The value wraps at the minimum and maximum.
  
.SH "SEE ALSO"

  wxControl
   
  wxWindow
   
  wxEvtHandler
   
  wxObject
 
  Event handling overview
  wxSpinCtrl
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.