X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..3201a1046ba71ba8e5ef2ed694fde34d12f743f3:/interface/spinctrl.h diff --git a/interface/spinctrl.h b/interface/spinctrl.h index e4b068516d..06d29a3647 100644 --- a/interface/spinctrl.h +++ b/interface/spinctrl.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: spinctrl.h -// Purpose: documentation for wxSpinCtrl class +// Purpose: interface of wxSpinCtrl // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -14,64 +14,54 @@ wxSpinButton in one control. @beginStyleTable - @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{spinctrl.png} + - @seealso - @ref overview_eventhandlingoverview "Event handling overview", wxSpinButton, - wxControl + @see wxSpinButton, wxControl */ class wxSpinCtrl : public wxControl { public: - //@{ /** - ) - + Default constructor. + */ + wxSpinCtrl(); + + /** Constructor, creating and showing a spin control. - + @param parent - Parent window. Must not be @NULL. - + Parent window. Must not be @NULL. @param value - Default value. - + Default value (as text). @param id - Window identifier. The value wxID_ANY indicates a default value. - + Window identifier. The value wxID_ANY indicates a default value. @param pos - Window position. If wxDefaultPosition is specified then a default position - is chosen. - + 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. - + Window size. If wxDefaultSize is specified then a default size + is chosen. @param style - Window style. See wxSpinButton. - + Window style. See wxSpinButton. @param min - Minimal value. - + Minimal value. @param max - Maximal value. - + Maximal value. @param initial - Initial value. - + Initial value. @param name - Window name. - - @sa Create() + Window name. + + @see Create() */ - wxSpinCtrl(); wxSpinCtrl(wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, @@ -79,13 +69,9 @@ public: long style = wxSP_ARROW_KEYS, int min = 0, int max = 100, int initial = 0); - //@} /** - ) - Creation function called by the spin control constructor. - See wxSpinCtrl() for details. */ bool Create(wxWindow* parent, wxWindowID id = -1, @@ -99,17 +85,17 @@ public: /** Gets maximal allowable value. */ - int GetMax(); + int GetMax() const; /** Gets minimal allowable value. */ - int GetMin(); + int GetMin() const; /** Gets the value of the spin control. */ - int GetValue(); + int GetValue() const; /** Sets range of allowable values. @@ -118,19 +104,21 @@ public: /** Select the text in the text part of the control between positions - @e from (inclusive) and @e to (exclusive). This is similar to + @a from (inclusive) and @a to (exclusive). This is similar to wxTextCtrl::SetSelection. - - @b NB: this is currently only implemented for Windows and generic versions + @note this is currently only implemented for Windows and generic versions of the control. */ void SetSelection(long from, long to); - //@{ /** - Sets the value of the spin control. + Sets the value of the spin control. Use the variant using int instead. */ void SetValue(const wxString& text); + + /** + Sets the value of the spin control. + */ void SetValue(int value); - //@} }; +