aa2d159e8c
Use the same 100 DIPs as in wxMSW, to make the default behaviour more useful. Also update documentation to explain which size component should, and should not, be specified when creating the slider. Closes https://github.com/wxWidgets/wxWidgets/pull/2012
413 lines
13 KiB
Objective-C
413 lines
13 KiB
Objective-C
/////////////////////////////////////////////////////////////////////////////
|
|
// 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.
|
|
|
|
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 @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, GTK+ 2.16 and later).
|
|
@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 (Windows and GTK+ 3 only).
|
|
@style{wxSL_RIGHT}
|
|
Displays ticks on the right and forces the slider to be vertical.
|
|
@style{wxSL_TOP}
|
|
Displays ticks on the top (Windows and GTK+ 3 only).
|
|
@style{wxSL_BOTTOM}
|
|
Displays ticks on the bottom (this is the default).
|
|
@style{wxSL_BOTH}
|
|
Displays ticks on both sides of the slider. Windows only.
|
|
@style{wxSL_SELRANGE}
|
|
Displays a highlighted selection range. 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 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 @ref page_samples_widgets ("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,
|
|
which is typically appropriate in the transverse slider direction,
|
|
but is just fixed 100 (DPI-independent) pixels in the primary
|
|
direction (i.e. vertical for ::wxSL_VERTICAL sliders or horizontal
|
|
for ::wxSL_HORIZONTAL ones), so it may be preferable to specify it
|
|
explicitly. Conversely, when using non-default size, it's usually
|
|
best to use @c -1 for the transverse size component, meaning that
|
|
the default should be used, as the appropriate value depends on the
|
|
platform and theme.
|
|
@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,wxgtk}
|
|
*/
|
|
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,wxgtk}
|
|
|
|
@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,wxgtk}
|
|
|
|
@see SetTickFreq()
|
|
*/
|
|
virtual void SetTick(int tickPos);
|
|
|
|
/**
|
|
Sets the tick mark frequency and position.
|
|
|
|
@param freq
|
|
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,wxgtk}
|
|
|
|
@see GetTickFreq()
|
|
*/
|
|
virtual void SetTickFreq(int freq);
|
|
|
|
/**
|
|
Sets the slider position.
|
|
|
|
@param value
|
|
The slider position.
|
|
*/
|
|
virtual void SetValue(int value);
|
|
};
|
|
|