X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e54c96f187f46c06bd36be8cd52b35c19884aa2b..3201a1046ba71ba8e5ef2ed694fde34d12f743f3:/interface/spinbutt.h diff --git a/interface/spinbutt.h b/interface/spinbutt.h index 0e9ff39674..054bce9150 100644 --- a/interface/spinbutt.h +++ b/interface/spinbutt.h @@ -49,36 +49,40 @@ public: as wxSpinButton is not implemented for all platforms but wxSpinCtrl is as it degenerates to a simple wxTextCtrl on such platforms. - @b NB: the range supported by this control (and wxSpinCtrl) depends on the + @note the range supported by this control (and wxSpinCtrl) depends on the platform but is at least @c -0x8000 to @c 0x7fff. Under GTK and Win32 with sufficiently new version of @c comctrl32.dll (at least 4.71 is required, 5.80 is recommended) the full 32 bit range is supported. @beginStyleTable - @style{wxSP_HORIZONTAL}: + @style{wxSP_HORIZONTAL} Specifies a horizontal spin button (note that this style is not supported in wxGTK). - @style{wxSP_VERTICAL}: + @style{wxSP_VERTICAL} Specifies a vertical spin button. - @style{wxSP_ARROW_KEYS}: + @style{wxSP_ARROW_KEYS} The user can use arrow keys to change the value. - @style{wxSP_WRAP}: + @style{wxSP_WRAP} The value wraps at the minimum and maximum. @endStyleTable @library{wxcore} @category{ctrl} - @appearance{spinbutton.png} + @see wxSpinCtrl */ class wxSpinButton : public wxControl { public: - //@{ + /** + Default constructor. + */ + wxSpinButton(); + /** Constructor, creating and showing a spin button. - + @param parent Parent window. Must not be @NULL. @param id @@ -93,16 +97,14 @@ public: Window style. See wxSpinButton. @param name Window name. - + @see Create() */ - wxSpinButton(); wxSpinButton(wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxSP_HORIZONTAL, const wxString& name = "spinButton"); - //@} /** Destructor, destroys the spin button control. @@ -121,40 +123,40 @@ public: /** Returns the maximum permissible value. - + @see SetRange() */ int GetMax() const; /** Returns the minimum permissible value. - + @see SetRange() */ int GetMin() const; /** Returns the current spin button value. - + @see SetValue() */ int GetValue() const; /** Sets the range of the spin button. - + @param min The minimum value for the spin button. @param max The maximum value for the spin button. - + @see GetMin(), GetMax() */ void SetRange(int min, int max); /** Sets the value of the spin button. - + @param value The value for the spin button. */