X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e54c96f187f46c06bd36be8cd52b35c19884aa2b..3201a1046ba71ba8e5ef2ed694fde34d12f743f3:/interface/slider.h?ds=sidebyside diff --git a/interface/slider.h b/interface/slider.h index c85d98be3d..5d20acb9fc 100644 --- a/interface/slider.h +++ b/interface/slider.h @@ -18,42 +18,46 @@ Slider events are handled in the same way as a scrollbar. @beginStyleTable - @style{wxSL_HORIZONTAL}: + @style{wxSL_HORIZONTAL} Displays the slider horizontally (this is the default). - @style{wxSL_VERTICAL}: + @style{wxSL_VERTICAL} Displays the slider vertically. - @style{wxSL_AUTOTICKS}: + @style{wxSL_AUTOTICKS} Displays tick marks. - @style{wxSL_LABELS}: + @style{wxSL_LABELS} Displays minimum, maximum and value labels. - @style{wxSL_LEFT}: + @style{wxSL_LEFT} Displays ticks on the left and forces the slider to be vertical. - @style{wxSL_RIGHT}: + @style{wxSL_RIGHT} Displays ticks on the right and forces the slider to be vertical. - @style{wxSL_TOP}: + @style{wxSL_TOP} Displays ticks on the top. - @style{wxSL_BOTTOM}: + @style{wxSL_BOTTOM} Displays ticks on the bottom (this is the default). - @style{wxSL_SELRANGE}: + @style{wxSL_SELRANGE} Allows the user to select a range on the slider. Windows only. - @style{wxSL_INVERSE}: + @style{wxSL_INVERSE} Inverses the mininum and maximum endpoints on the slider. Not compatible with wxSL_SELRANGE. @endStyleTable @library{wxcore} @category{ctrl} - @appearance{slider.png} + @see @ref overview_eventhandlingoverview, 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 @@ -73,10 +77,9 @@ public: Window validator. @param name Window name. - + @see Create(), wxValidator */ - wxSlider(); wxSlider(wxWindow* parent, wxWindowID id, int value, int minValue, int maxValue, const wxPoint& point = wxDefaultPosition, @@ -84,7 +87,6 @@ public: long style = wxSL_HORIZONTAL, const wxValidator& validator = wxDefaultValidator, const wxString& name = "slider"); - //@} /** Destructor, destroying the slider. @@ -93,14 +95,14 @@ public: /** Clears the selection, for a slider with the @b wxSL_SELRANGE style. - + @remarks Windows 95 only. */ void ClearSel(); /** Clears the ticks. - + @remarks Windows 95 only. */ void ClearTicks(); @@ -119,160 +121,160 @@ public: /** Returns the line size. - + @see SetLineSize() */ int GetLineSize() const; /** Gets the maximum slider value. - + @see GetMin(), SetRange() */ int GetMax() const; /** Gets the minimum slider value. - + @see GetMin(), SetRange() */ int GetMin() const; /** Returns the page size. - + @see SetPageSize() */ int GetPageSize() const; /** Returns the selection end point. - + @remarks Windows 95 only. - + @see GetSelStart(), SetSelection() */ int GetSelEnd() const; /** Returns the selection start point. - + @remarks Windows 95 only. - + @see GetSelEnd(), SetSelection() */ int GetSelStart() const; /** Returns the thumb length. - + @remarks Windows 95 only. - + @see SetThumbLength() */ int GetThumbLength() const; /** Returns the tick frequency. - + @remarks Windows 95 only. - + @see SetTickFreq() */ int GetTickFreq() const; /** Gets the current slider value. - + @see GetMin(), GetMax(), SetValue() */ 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() */ void SetLineSize(int lineSize); /** 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() */ void SetPageSize(int pageSize); /** Sets the minimum and maximum slider values. - + @see GetMin(), GetMax() */ void SetRange(int minValue, int maxValue); /** Sets the selection. - + @param startPos The selection start position. @param endPos The selection end position. - + @remarks Windows 95 only. - + @see GetSelStart(), GetSelEnd() */ void SetSelection(int startPos, int endPos); /** Sets the slider thumb length. - + @param len The thumb length. - + @remarks Windows 95 only. - + @see GetThumbLength() */ void SetThumbLength(int len); /** Sets a tick position. - + @param tickPos The tick position. - + @remarks Windows 95 only. - + @see SetTickFreq() */ 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. @param pos Position. Must be greater than zero. TODO: what is this for? - + @remarks Windows 95 only. - + @see GetTickFreq() */ void SetTickFreq(int n, int pos); /** Sets the slider position. - + @param value The slider position. */