wxslider

a slider is a control with a handle which can be pulled back and forth to change the value.

on windows, the track bar control is used.

slider events are handled in the same way as a scrollbar.

derived from

wxcontrol
wxwindow
wxevthandler
wxobject

include files

window styles

wxsl_horizontal	displays the slider horizontally (this is the default).
wxsl_vertical	displays the slider vertically.
wxsl_autoticks	displays tick marks.
wxsl_labels	displays minimum, maximum and value labels.
wxsl_left	displays ticks on the left and forces the slider to be vertical.
wxsl_right	displays ticks on the right and forces the slider to be vertical.
wxsl_top	displays ticks on the top.
wxsl_bottom	displays ticks on the bottom (this is the default).
wxsl_selrange	allows the user to select a range on the slider. windows only.
wxsl_inverse	inverses the mininum and maximum endpoints on the slider. not compatible with wxsl_selrange.

see also window styles overview.

event table macros

to process a scroll event, use these event handler macros to direct input to member functions that take a wxscrollevent argument. you can use evt_command_scroll... macros with window ids for when intercepting scroll events from controls, or evt_scroll... macros without window ids for intercepting scroll events from the receiving window -- except for this, the macros behave exactly the same.

evt_scroll(func)	process all scroll events.
evt_scroll_top(func)	process wxevt_scroll_top scroll-to-top events (minimum position).
evt_scroll_bottom(func)	process wxevt_scroll_bottom scroll-to-bottom events (maximum position).
evt_scroll_lineup(func)	process wxevt_scroll_lineup line up events.
evt_scroll_linedown(func)	process wxevt_scroll_linedown line down events.
evt_scroll_pageup(func)	process wxevt_scroll_pageup page up events.
evt_scroll_pagedown(func)	process wxevt_scroll_pagedown page down events.
evt_scroll_thumbtrack(func)	process wxevt_scroll_thumbtrack thumbtrack events (frequent events sent as the user drags the thumbtrack).
evt_scroll_thumbrelease(func)	process wxevt_scroll_thumbrelease thumb release events.
evt_scroll_changed(func)	process wxevt_scroll_changed end of scrolling events (msw only).
evt_command_scroll(id, func)	process all scroll events.
evt_command_scroll_top(id, func)	process wxevt_scroll_top scroll-to-top events (minimum position).
evt_command_scroll_bottom(id, func)	process wxevt_scroll_bottom scroll-to-bottom events (maximum position).
evt_command_scroll_lineup(id, func)	process wxevt_scroll_lineup line up events.
evt_command_scroll_linedown(id, func)	process wxevt_scroll_linedown line down events.
evt_command_scroll_pageup(id, func)	process wxevt_scroll_pageup page up events.
evt_command_scroll_pagedown(id, func)	process wxevt_scroll_pagedown page down events.
evt_command_scroll_thumbtrack(id, func)	process wxevt_scroll_thumbtrack thumbtrack events (frequent events sent as the user drags the thumbtrack).
evt_command_scroll_thumbrelease(func)	process wxevt_scroll_thumbrelease thumb release events.
evt_command_scroll_changed(func)	process wxevt_scroll_changed end of scrolling events (msw only).

the difference between evt_scroll_thumbrelease and evt_scroll_changed

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).

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 widgets sample ("slider" page) to see the difference between evt_scroll_thumbrelease and evt_scroll_changed in action.

see also

event handling overview, wxscrollbar

members

wxslider::wxslider
wxslider::~wxslider
wxslider::clearsel
wxslider::clearticks
wxslider::create
wxslider::getlinesize
wxslider::getmax
wxslider::getmin
wxslider::getpagesize
wxslider::getselend
wxslider::getselstart
wxslider::getthumblength
wxslider::gettickfreq
wxslider::getvalue
wxslider::setlinesize
wxslider::setpagesize
wxslider::setrange
wxslider::setselection
wxslider::setthumblength
wxslider::settick
wxslider::settickfreq
wxslider::setvalue

wxslider::wxslider

wxslider()

default slider.

wxslider(wxwindow* parent, wxwindowid id, int value , int minvalue, int maxvalue, const wxpoint& point = wxdefaultposition, const wxsize& size = wxdefaultsize, long style = wxsl_horizontal, const wxvalidator& validator = wxdefaultvalidator, const wxstring& name = "slider")

constructor, creating and showing a slider.

parameters

parent

parent window. must not be null.

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

value

initial position for the slider.

minvalue

minimum slider position.

maxvalue

maximum slider position.

size

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

style

wxslider

validator

window validator.

name

window name.

see also

wxslider::create, wxvalidator

wxslider::~wxslider

void ~wxslider()

destructor, destroying the slider.

wxslider::clearsel

void clearsel()

clears the selection, for a slider with the wxsl_selrange style.

remarks

windows 95 only.

wxslider::clearticks

void clearticks()

clears the ticks.

remarks

windows 95 only.

wxslider::create

bool create(wxwindow* parent, wxwindowid id, int value , int minvalue, int maxvalue, const wxpoint& point = wxdefaultposition, const wxsize& size = wxdefaultsize, long style = wxsl_horizontal, const wxvalidator& validator = wxdefaultvalidator, const wxstring& name = "slider")

used for two-step slider construction. see wxslider::wxslider for further details.

wxslider::getlinesize

int getlinesize() const

returns the line size.

see also

wxslider::setlinesize

wxslider::getmax

int getmax() const

gets the maximum slider value.

see also

wxslider::getmin, wxslider::setrange

wxslider::getmin

int getmin() const

gets the minimum slider value.

see also

wxslider::getmin, wxslider::setrange

wxslider::getpagesize

int getpagesize() const

returns the page size.

see also

wxslider::setpagesize

wxslider::getselend

int getselend() const

returns the selection end point.

remarks

windows 95 only.

wxslider::getselstart

int getselstart() const

returns the selection start point.

remarks

windows 95 only.

wxslider::getthumblength

int getthumblength() const

returns the thumb length.

remarks

windows 95 only.

see also

wxslider::setthumblength

wxslider::gettickfreq

int gettickfreq() const

returns the tick frequency.

remarks

windows 95 only.

see also

wxslider::settickfreq

wxslider::getvalue

int getvalue() const

gets the current slider value.

wxslider::setlinesize

void setlinesize(int linesize)

sets the line size for the slider.

parameters

linesize

the number of steps the slider moves when the user moves it up or down a line.

see also

wxslider::getlinesize

wxslider::setpagesize

void setpagesize(int pagesize)

sets the page size for the slider.

parameters

pagesize

the number of steps the slider moves when the user pages up or down.

see also

wxslider::getpagesize

wxslider::setrange

void setrange(int minvalue, int maxvalue)

sets the minimum and maximum slider values.

see also

wxslider::getmin, wxslider::getmax

wxslider::setselection

void setselection(int startpos, int endpos)

sets the selection.

parameters

startpos

the selection start position.

endpos

the selection end position.

remarks

windows 95 only.

wxslider::setthumblength

void setthumblength(int len)

sets the slider thumb length.

parameters

len

the thumb length.

remarks

windows 95 only.

see also

wxslider::getthumblength

wxslider::settick

void settick(int tickpos)

sets a tick position.

parameters

tickpos

the tick position.

remarks

windows 95 only.

see also

wxslider::settickfreq

void settickfreq(int n, int pos)

sets the tick mark frequency and position.

parameters

frequency. for example, if the frequency is set to two, a tick mark is displayed for every other increment in the slider's range.

pos

position. must be greater than zero. todo: what is this for?

remarks

windows 95 only.

see also

wxslider::gettickfreq

wxslider::setvalue

void setvalue(int value)

sets the slider position.

parameters

value

the slider position.

see also

wxslider::getvalue