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

Document wxSpinCtrl::SetValue("") behaviour

Browse Source 
Mention that this is explicitly allowed now that it works.

Co-Authored-By: Dummy <dummy@trac.wxwidgets.org>
This commit is contained in:
Vadim Zeitlin
2021-04-20 01:17:42 +02:00
parent ca0cf3ea59
commit 496aefbf88
1 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
interface/wx/spinctrl.h
View File

@@ -197,6 +197,10 @@ public:
Sets the value of the spin control. Sets the value of the spin control.
It is recommended to use the overload taking an integer value instead. It is recommended to use the overload taking an integer value instead.
The behaviour of this function when @a text doesn't represent a valid
number currently differs between the platforms, however passing an
empty string does clear the text part contents, without affecting the
value returned by GetValue(), under all of them.
Notice that, unlike wxTextCtrl::SetValue(), but like most of the other Notice that, unlike wxTextCtrl::SetValue(), but like most of the other
setter methods in wxWidgets, calling this method does not generate any setter methods in wxWidgets, calling this method does not generate any
@@ -250,6 +254,14 @@ public:
/** /**
Constructor, creating and showing a spin control. Constructor, creating and showing a spin control.
If @a value is non-empty, it will be shown in the text entry part of
the control and if it has numeric value, the initial numeric value of
the control, as returned by GetValue() will also be determined by it
instead of by @a initial. Hence, it only makes sense to specify @a
initial if @a value is an empty string or is not convertible to a
number, otherwise @a initial is simply ignored and the number specified
by @a value is used.
@param parent @param parent
Parent window. Must not be @NULL. Parent window. Must not be @NULL.
@param value @param value
@@ -356,6 +368,10 @@ public:
Sets the value of the spin control. Sets the value of the spin control.
It is recommended to use the overload taking a double value instead. It is recommended to use the overload taking a double value instead.
The behaviour of this function when @a text doesn't represent a valid
number currently differs between the platforms, however
passing an empty string does clear the text part contents, without
affecting the value returned by GetValue(), under all of them.
Notice that, unlike wxTextCtrl::SetValue(), but like most of the other Notice that, unlike wxTextCtrl::SetValue(), but like most of the other
setter methods in wxWidgets, calling this method does not generate any setter methods in wxWidgets, calling this method does not generate any