1wxSlider(3)                Erlang Module Definition                wxSlider(3)
2
3
4

NAME

6       wxSlider - Functions for wxSlider class
7

DESCRIPTION

9       A  slider is a control with a handle which can be pulled back and forth
10       to change the value.
11
12       On Windows, the track bar control is used.
13
14       On GTK+, tick marks are only available for version 2.16 and later.
15
16       Slider generates the same events as wxScrollBar  but  in  practice  the
17       most  convenient  way  to  process  wxSlider updates is by handling the
18       slider-specific wxEVT_SLIDER event which  carries  wxCommandEvent  con‐
19       taining just the latest slider position.
20
21       Styles
22
23       This class supports the following styles:
24
25       The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
26
27       The  EVT_SCROLL_THUMBRELEASE  event is only emitted when actually drag‐
28       ging the thumb using the mouse and releasing it (This  EVT_SCROLL_THUM‐
29       BRELEASE event is also followed by an EVT_SCROLL_CHANGED event).
30
31       The  EVT_SCROLL_CHANGED  event  also  occurs when using the keyboard to
32       change the thumb position, and when clicking next to the thumb (In  all
33       these  cases  the  EVT_SCROLL_THUMBRELEASE  event  does not happen). In
34       short, the EVT_SCROLL_CHANGED event is triggered when scrolling/ moving
35       has  finished  independently  of the way it had started. Please see the
36       page_samples_widgets ("Slider" page)  to  see  the  difference  between
37       EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
38
39       See: Overview events, wxScrollBar
40
41       This  class is derived (and can use functions) from: wxControl wxWindow
42       wxEvtHandler
43
44       wxWidgets docs: wxSlider
45

EVENTS

47       Event  types  emitted  from  this  class:  scroll_top,   scroll_bottom,
48       scroll_lineup,    scroll_linedown,    scroll_pageup,   scroll_pagedown,
49       scroll_thumbtrack,  scroll_thumbrelease,  scroll_changed,   scroll_top,
50       scroll_bottom,     scroll_lineup,    scroll_linedown,    scroll_pageup,
51       scroll_pagedown,        scroll_thumbtrack,         scroll_thumbrelease,
52       scroll_changed, command_slider_updated
53

DATA TYPES

55       wxSlider() = wx:wx_object()
56

EXPORTS

58       new() -> wxSlider()
59
60              Default constructor.
61
62       new(Parent, Id, Value, MinValue, MaxValue) -> wxSlider()
63
64              Types:
65
66                 Parent = wxWindow:wxWindow()
67                 Id = Value = MinValue = MaxValue = integer()
68
69       new(Parent, Id, Value, MinValue, MaxValue, Options :: [Option]) ->
70              wxSlider()
71
72              Types:
73
74                 Parent = wxWindow:wxWindow()
75                 Id = Value = MinValue = MaxValue = integer()
76                 Option =
77                     {pos, {X :: integer(), Y :: integer()}} |
78                     {size, {W :: integer(), H :: integer()}} |
79                     {style, integer()} |
80                     {validator, wx:wx_object()}
81
82              Constructor, creating and showing a slider.
83
84              See: create/7, wxValidator (not implemented in wx)
85
86       destroy(This :: wxSlider()) -> ok
87
88              Destructor, destroying the slider.
89
90       create(This, Parent, Id, Value, MinValue, MaxValue) -> boolean()
91
92              Types:
93
94                 This = wxSlider()
95                 Parent = wxWindow:wxWindow()
96                 Id = Value = MinValue = MaxValue = integer()
97
98       create(This, Parent, Id, Value, MinValue, MaxValue,
99              Options :: [Option]) ->
100                 boolean()
101
102              Types:
103
104                 This = wxSlider()
105                 Parent = wxWindow:wxWindow()
106                 Id = Value = MinValue = MaxValue = integer()
107                 Option =
108                     {pos, {X :: integer(), Y :: integer()}} |
109                     {size, {W :: integer(), H :: integer()}} |
110                     {style, integer()} |
111                     {validator, wx:wx_object()}
112
113              Used for two-step slider construction.
114
115              See new/6 for further details.
116
117       getLineSize(This) -> integer()
118
119              Types:
120
121                 This = wxSlider()
122
123              Returns the line size.
124
125              See: setLineSize/2
126
127       getMax(This) -> integer()
128
129              Types:
130
131                 This = wxSlider()
132
133              Gets the maximum slider value.
134
135              See: getMin/1, setRange/3
136
137       getMin(This) -> integer()
138
139              Types:
140
141                 This = wxSlider()
142
143              Gets the minimum slider value.
144
145              See: getMin/1, setRange/3
146
147       getPageSize(This) -> integer()
148
149              Types:
150
151                 This = wxSlider()
152
153              Returns the page size.
154
155              See: setPageSize/2
156
157       getThumbLength(This) -> integer()
158
159              Types:
160
161                 This = wxSlider()
162
163              Returns the thumb length.
164
165              Only for:wxmsw
166
167              See: setThumbLength/2
168
169       getValue(This) -> integer()
170
171              Types:
172
173                 This = wxSlider()
174
175              Gets the current slider value.
176
177              See: getMin/1, getMax/1, setValue/2
178
179       setLineSize(This, LineSize) -> ok
180
181              Types:
182
183                 This = wxSlider()
184                 LineSize = integer()
185
186              Sets the line size for the slider.
187
188              See: getLineSize/1
189
190       setPageSize(This, PageSize) -> ok
191
192              Types:
193
194                 This = wxSlider()
195                 PageSize = integer()
196
197              Sets the page size for the slider.
198
199              See: getPageSize/1
200
201       setRange(This, MinValue, MaxValue) -> ok
202
203              Types:
204
205                 This = wxSlider()
206                 MinValue = MaxValue = integer()
207
208              Sets the minimum and maximum slider values.
209
210              See: getMin/1, getMax/1
211
212       setThumbLength(This, Len) -> ok
213
214              Types:
215
216                 This = wxSlider()
217                 Len = integer()
218
219              Sets the slider thumb length.
220
221              Only for:wxmsw
222
223              See: getThumbLength/1
224
225       setValue(This, Value) -> ok
226
227              Types:
228
229                 This = wxSlider()
230                 Value = integer()
231
232              Sets the slider position.
233
234
235
236wxWidgets team.                     wx 2.1                         wxSlider(3)