Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-09 12:33:59 +00:00
parent 0aaf0255e4
commit 4cc4bfafe5
256 changed files with 8880 additions and 10701 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
interface/spinbutt.h
View File

@@ -25,7 +25,7 @@ public:
/**
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.
@@ -81,26 +81,21 @@ public:
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.
Window name.
@sa Create()
@see Create()
*/
wxSpinButton();
wxSpinButton(wxWindow* parent, wxWindowID id,
@@ -128,21 +123,21 @@ public:
/**
Returns the maximum permissible value.
@sa SetRange()
@see SetRange()
*/
int GetMax();
/**
Returns the minimum permissible value.
@sa SetRange()
@see SetRange()
*/
int GetMin();
/**
Returns the current spin button value.
@sa SetValue()
@see SetValue()
*/
int GetValue();
@@ -150,12 +145,11 @@ public:
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.
The maximum value for the spin button.
@sa GetMin(), GetMax()
@see GetMin(), GetMax()
*/
void SetRange(int min, int max);
@@ -163,7 +157,7 @@ public:
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);
};