wxspinbutton

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 but wxspinctrl is as it degenerates to a simple wxtextctrl on such 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.

derived from

wxcontrol
wxwindow
wxevthandler
wxobject

see also

wxspinctrl

include files

window styles

wxsp_horizontal	specifies a horizontal spin button (note that this style is not supported in wxgtk).
wxsp_vertical	specifies a vertical spin button.
wxsp_arrow_keys	the user can use arrow keys to change the value.
wxsp_wrap	the value wraps at the minimum and maximum.

see also window styles overview.

event handling

to process input from a spin button, use one of these event handler macros to direct input to member functions that take a wxspinevent argument:

evt_spin(id, func)	generated whenever an arrow is pressed.
evt_spin_up(id, func)	generated when left/up arrow is pressed.
evt_spin_down(id, func)	generated when right/down arrow is pressed.

note that if you handle both spin and up or down events, you will be notified about each of them twice: first the up/down event will be receieved and then, if it wasn't vetoed, the spin event will be sent. see also

event handling overview

members

wxspinbutton::wxspinbutton
wxspinbutton::~wxspinbutton
wxspinbutton::create
wxspinbutton::getmax
wxspinbutton::getmin
wxspinbutton::getvalue
wxspinbutton::setrange
wxspinbutton::setvalue

wxspinbutton::wxspinbutton

wxspinbutton()

default constructor.

wxspinbutton(wxwindow* parent, wxwindowid id, const wxpoint& pos = wxdefaultposition, const wxsize& size = wxdefaultsize, long style = wxsp_horizontal, const wxstring& name = "spinbutton")

constructor, creating and showing a spin button.

parameters

parent

parent window. must not be null.

window identifier. a value of -1 indicates a default value.

pos

window position. if the position (-1, -1) is specified then a default position is chosen.

size

window size. if the default size (-1, -1) is specified then a default size is chosen.

style

wxspinbutton

name

window name.

see also

wxspinbutton::create

wxspinbutton::~wxspinbutton

void ~wxspinbutton()

destructor, destroys the spin button control.

wxspinbutton::create

bool create(wxwindow* parent, wxwindowid id, const wxpoint& pos = wxdefaultposition, const wxsize& size = wxdefaultsize, long style = wxsp_horizontal, const wxstring& name = "spinbutton")

scrollbar creation function called by the spin button constructor. see wxspinbutton::wxspinbutton for details.

wxspinbutton::getmax

int getmax() const

returns the maximum permissible value.

see also

wxspinbutton::setrange

wxspinbutton::getmin

int getmin() const

returns the minimum permissible value.

see also

wxspinbutton::setrange

wxspinbutton::getvalue

int getvalue() const

returns the current spin button value.

see also

wxspinbutton::setvalue

wxspinbutton::setrange

void setrange(int min, int max)

sets the range of the spin button.

parameters

min

the minimum value for the spin button.

max

the maximum value for the spin button.

wxspinbutton::setvalue

void setvalue(int value)

sets the value of the spin button.

parameters

value

the value for the spin button.

see also

wxspinbutton::getvalue