1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
|
/////////////////////////////////////////////////////////////////////////////
// Name: slider.h
// Purpose: interface of wxSlider
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#define wxSL_HORIZONTAL wxHORIZONTAL /* 0x0004 */
#define wxSL_VERTICAL wxVERTICAL /* 0x0008 */
#define wxSL_TICKS 0x0010
#define wxSL_AUTOTICKS wxSL_TICKS // we don't support manual ticks
#define wxSL_LEFT 0x0040
#define wxSL_TOP 0x0080
#define wxSL_RIGHT 0x0100
#define wxSL_BOTTOM 0x0200
#define wxSL_BOTH 0x0400
#define wxSL_SELRANGE 0x0800
#define wxSL_INVERSE 0x1000
#define wxSL_MIN_MAX_LABELS 0x2000
#define wxSL_VALUE_LABEL 0x4000
#define wxSL_LABELS (wxSL_MIN_MAX_LABELS|wxSL_VALUE_LABEL)
/**
@class 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 generates the same events as wxScrollBar but in practice the most
convenient way to process wxSlider updates is by handling the
slider-specific @c wxEVT_SLIDER event which carries wxCommandEvent
containing just the latest slider position.
@beginStyleTable
@style{wxSL_HORIZONTAL}
Displays the slider horizontally (this is the default).
@style{wxSL_VERTICAL}
Displays the slider vertically.
@style{wxSL_AUTOTICKS}
Displays tick marks. Windows only.
@style{wxSL_MIN_MAX_LABELS}
Displays minimum, maximum labels (new since wxWidgets 2.9.1).
@style{wxSL_VALUE_LABEL}
Displays value label (new since wxWidgets 2.9.1).
@style{wxSL_LABELS}
Displays minimum, maximum and value labels (same as wxSL_VALUE_LABEL
and wxSL_MIN_MAX_LABELS together).
@style{wxSL_LEFT}
Displays ticks on the left and forces the slider to be vertical.
@style{wxSL_RIGHT}
Displays ticks on the right and forces the slider to be vertical.
@style{wxSL_TOP}
Displays ticks on the top.
@style{wxSL_BOTTOM}
Displays ticks on the bottom (this is the default).
@style{wxSL_SELRANGE}
Allows the user to select a range on the slider. Windows only.
@style{wxSL_INVERSE}
Inverses the minimum and maximum endpoints on the slider. Not
compatible with wxSL_SELRANGE.
@endStyleTable
Notice that @c wxSL_LEFT, @c wxSL_TOP, @c wxSL_RIGHT and @c wxSL_BOTTOM
specify the position of the slider ticks in MSW implementation and that the
slider labels, if any, are positioned on the opposite side. So, to have a
label on the left side of a vertical slider, @b wxSL_RIGHT must be used (or
none of these styles at all should be specified as left and top are default
positions for the vertical and horizontal sliders respectively).
@beginEventEmissionTable{wxScrollEvent}
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.
@event{EVT_SCROLL(func)}
Process all scroll events.
@event{EVT_SCROLL_TOP(func)}
Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
@event{EVT_SCROLL_BOTTOM(func)}
Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
@event{EVT_SCROLL_LINEUP(func)}
Process @c wxEVT_SCROLL_LINEUP line up events.
@event{EVT_SCROLL_LINEDOWN(func)}
Process @c wxEVT_SCROLL_LINEDOWN line down events.
@event{EVT_SCROLL_PAGEUP(func)}
Process @c wxEVT_SCROLL_PAGEUP page up events.
@event{EVT_SCROLL_PAGEDOWN(func)}
Process @c wxEVT_SCROLL_PAGEDOWN page down events.
@event{EVT_SCROLL_THUMBTRACK(func)}
Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events
(frequent events sent as the user drags the thumbtrack).
@event{EVT_SCROLL_THUMBRELEASE(func)}
Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.
@event{EVT_SCROLL_CHANGED(func)}
Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
@event{EVT_COMMAND_SCROLL(id, func)}
Process all scroll events.
@event{EVT_COMMAND_SCROLL_TOP(id, func)}
Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
@event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}
Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
@event{EVT_COMMAND_SCROLL_LINEUP(id, func)}
Process @c wxEVT_SCROLL_LINEUP line up events.
@event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}
Process @c wxEVT_SCROLL_LINEDOWN line down events.
@event{EVT_COMMAND_SCROLL_PAGEUP(id, func)}
Process @c wxEVT_SCROLL_PAGEUP page up events.
@event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}
Process @c wxEVT_SCROLL_PAGEDOWN page down events.
@event{EVT_COMMAND_SCROLL_THUMBTRACK(id, func)}
Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events
(frequent events sent as the user drags the thumbtrack).
@event{EVT_COMMAND_SCROLL_THUMBRELEASE(func)}
Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.
@event{EVT_COMMAND_SCROLL_CHANGED(func)}
Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
@event{EVT_SLIDER(id, func)}
Process @c wxEVT_SLIDER which is generated after any
change of wxSlider position in addition to one of the events above.
Notice that the handler of this event receives a wxCommandEvent as
argument and not wxScrollEvent, as all the other handlers.
@endEventTable
@section slider_diff 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.
@library{wxcore}
@category{ctrl}
@appearance{slider}
@see @ref overview_events, wxScrollBar
*/
class wxSlider : public wxControl
{
public:
/**
Default constructor
*/
wxSlider();
/**
Constructor, creating and showing a slider.
@param parent
Parent window. Must not be @NULL.
@param id
Window identifier. The value wxID_ANY indicates a default value.
@param value
Initial position for the slider.
@param minValue
Minimum slider position.
@param maxValue
Maximum slider position.
@param pos
Window position.
If ::wxDefaultPosition is specified then a default position is chosen.
@param size
Window size.
If ::wxDefaultSize is specified then a default size is chosen.
@param style
Window style. See wxSlider.
@param validator
Window validator.
@param name
Window name.
@see Create(), wxValidator
*/
wxSlider(wxWindow* parent, wxWindowID id, int value,
int minValue, int maxValue,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxSL_HORIZONTAL,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxSliderNameStr);
/**
Destructor, destroying the slider.
*/
virtual ~wxSlider();
/**
Clears the selection, for a slider with the @b wxSL_SELRANGE style.
@onlyfor{wxmsw}
*/
virtual void ClearSel();
/**
Clears the ticks.
@onlyfor{wxmsw}
*/
virtual void ClearTicks();
/**
Used for two-step slider construction.
See wxSlider() for further details.
*/
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 = wxSliderNameStr);
/**
Returns the line size.
@see SetLineSize()
*/
virtual int GetLineSize() const;
/**
Gets the maximum slider value.
@see GetMin(), SetRange()
*/
virtual int GetMax() const;
/**
Gets the minimum slider value.
@see GetMin(), SetRange()
*/
virtual int GetMin() const;
/**
Returns the page size.
@see SetPageSize()
*/
virtual int GetPageSize() const;
/**
Returns the selection end point.
@onlyfor{wxmsw}
@see GetSelStart(), SetSelection()
*/
virtual int GetSelEnd() const;
/**
Returns the selection start point.
@onlyfor{wxmsw}
@see GetSelEnd(), SetSelection()
*/
virtual int GetSelStart() const;
/**
Returns the thumb length.
@onlyfor{wxmsw}
@see SetThumbLength()
*/
virtual int GetThumbLength() const;
/**
Returns the tick frequency.
@onlyfor{wxmsw}
@see SetTickFreq()
*/
virtual int GetTickFreq() const;
/**
Gets the current slider value.
@see GetMin(), GetMax(), SetValue()
*/
virtual int GetValue() const;
/**
Sets the line size for the slider.
@param lineSize
The number of steps the slider moves when the user moves it up
or down a line.
@see GetLineSize()
*/
virtual void SetLineSize(int lineSize);
/**
Sets the minimum slider value.
@param minValue
The new bottom end of the slider range.
@see GetMin(), SetRange()
*/
void SetMin( int minValue );
/**
Sets the maximum slider value.
@param maxValue
The new top end of the slider range.
@see GetMax(), SetRange()
*/
void SetMax( int maxValue );
/**
Sets the page size for the slider.
@param pageSize
The number of steps the slider moves when the user pages up or down.
@see GetPageSize()
*/
virtual void SetPageSize(int pageSize);
/**
Sets the minimum and maximum slider values.
@see GetMin(), GetMax()
*/
virtual void SetRange(int minValue, int maxValue);
/**
Sets the selection.
@param startPos
The selection start position.
@param endPos
The selection end position.
@onlyfor{wxmsw}
@see GetSelStart(), GetSelEnd()
*/
virtual void SetSelection(int startPos, int endPos);
/**
Sets the slider thumb length.
@param len
The thumb length.
@onlyfor{wxmsw}
@see GetThumbLength()
*/
virtual void SetThumbLength(int len);
/**
Sets a tick position.
@param tickPos
The tick position.
@onlyfor{wxmsw}
@see SetTickFreq()
*/
virtual void SetTick(int tickPos);
/**
Sets the tick mark frequency and position.
@param n
Frequency. For example, if the frequency is set to two, a tick mark is
displayed for every other increment in the slider's range.
@onlyfor{wxmsw}
@see GetTickFreq()
*/
virtual void SetTickFreq(int n);
/**
Sets the slider position.
@param value
The slider position.
*/
virtual void SetValue(int value);
};
|