/////////////////////////////////////////////////////////////////////////////
// Name: spinbutt.h
-// Purpose: documentation for wxSpinEvent class
+// Purpose: interface of wxSpinEvent
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxcore}
@category{events}
- @seealso
- wxSpinButton and wxSpinCtrl
+ @see wxSpinButton and wxSpinCtrl
*/
class wxSpinEvent : public wxNotifyEvent
{
/**
The constructor is not normally used by the user code.
*/
- wxSpinEvent(wxEventType commandType = wxEVT_@NULL, int id = 0);
+ wxSpinEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
/**
Retrieve the current spin button or control value.
*/
- int GetPosition();
+ int GetPosition() const;
/**
Set the value associated with the event.
};
+
/**
@class wxSpinButton
@wxheader{spinbutt.h}
@category{ctrl}
@appearance{spinbutton.png}
- @seealso
- wxSpinCtrl
+ @see wxSpinCtrl
*/
class wxSpinButton : public wxControl
{
//@{
/**
Constructor, creating and showing a spin button.
-
+
@param parent
- Parent window. Must not be @NULL.
-
+ Parent window. Must not be @NULL.
@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 name
- Window name.
-
- @sa Create()
+ Window name.
+
+ @see Create()
*/
wxSpinButton();
wxSpinButton(wxWindow* parent, wxWindowID id,
/**
Returns the maximum permissible value.
-
- @sa SetRange()
+
+ @see SetRange()
*/
- int GetMax();
+ int GetMax() const;
/**
Returns the minimum permissible value.
-
- @sa SetRange()
+
+ @see SetRange()
*/
- int GetMin();
+ int GetMin() const;
/**
Returns the current spin button value.
-
- @sa SetValue()
+
+ @see SetValue()
*/
- int GetValue();
+ int GetValue() const;
/**
Sets the range of the spin button.
-
+
@param min
- The minimum value for the spin button.
-
+ The minimum value for the spin button.
@param max
- The maximum value for the spin button.
-
- @sa GetMin(), GetMax()
+ 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.
+ The value for the spin button.
*/
void SetValue(int value);
};
+