View Source wxSlider (wx v2.4.2)
Functions for wxSlider class
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.
On GTK+, tick marks are only available for version 2.16 and later.
Slider generates the same events as wxScrollBar
but in practice the most
convenient way to process wxSlider
updates is by handling the
slider-specific wxEVT_SLIDER
event which carries wxCommandEvent
containing
just the latest slider position.
Styles
This class supports the following styles:
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 page_samples_widgets ("Slider" page) to see the difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
See:
Overview events,
wxScrollBar
This class is derived (and can use functions) from: wxControl
wxWindow
wxEvtHandler
wxWidgets docs: wxSlider
Events
Event types emitted from this class: scroll_top
,
scroll_bottom
, scroll_lineup
,
scroll_linedown
, scroll_pageup
,
scroll_pagedown
,
scroll_thumbtrack
,
scroll_thumbrelease
,
scroll_changed
, scroll_top
,
scroll_bottom
, scroll_lineup
,
scroll_linedown
, scroll_pageup
,
scroll_pagedown
,
scroll_thumbtrack
,
scroll_thumbrelease
,
scroll_changed
,
command_slider_updated
Summary
Functions
Used for two-step slider construction.
Destructor, destroying the slider.
Returns the line size.
Gets the maximum slider value.
Gets the minimum slider value.
Returns the page size.
Returns the thumb length.
Gets the current slider value.
Default constructor.
Constructor, creating and showing a slider.
Sets the line size for the slider.
Sets the page size for the slider.
Sets the minimum and maximum slider values.
Sets the slider thumb length.
Sets the slider position.
Types
-type wxSlider() :: wx:wx_object().
Functions
-spec create(This, Parent, Id, Value, MinValue, MaxValue, [Option]) -> boolean() when This :: wxSlider(), Parent :: wxWindow:wxWindow(), Id :: integer(), Value :: integer(), MinValue :: integer(), MaxValue :: integer(), Option :: {pos, {X :: integer(), Y :: integer()}} | {size, {W :: integer(), H :: integer()}} | {style, integer()} | {validator, wx:wx_object()}.
Used for two-step slider construction.
See new/6
for further details.
-spec destroy(This :: wxSlider()) -> ok.
Destructor, destroying the slider.
Returns the line size.
See: setLineSize/2
Gets the maximum slider value.
See: getMin/1
, setRange/3
Gets the minimum slider value.
See: getMin/1
, setRange/3
Returns the page size.
See: setPageSize/2
Returns the thumb length.
Only for:wxmsw
See: setThumbLength/2
Gets the current slider value.
See: getMin/1
, getMax/1
, setValue/2
-spec new() -> wxSlider().
Default constructor.
-spec new(Parent, Id, Value, MinValue, MaxValue, [Option]) -> wxSlider() when Parent :: wxWindow:wxWindow(), Id :: integer(), Value :: integer(), MinValue :: integer(), MaxValue :: integer(), Option :: {pos, {X :: integer(), Y :: integer()}} | {size, {W :: integer(), H :: integer()}} | {style, integer()} | {validator, wx:wx_object()}.
Constructor, creating and showing a slider.
See: create/7
, wxValidator
(not implemented in wx)
Sets the line size for the slider.
See: getLineSize/1
Sets the page size for the slider.
See: getPageSize/1
-spec setRange(This, MinValue, MaxValue) -> ok when This :: wxSlider(), MinValue :: integer(), MaxValue :: integer().
Sets the minimum and maximum slider values.
Sets the slider thumb length.
Only for:wxmsw
See: getThumbLength/1
Sets the slider position.