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

Consistently use "checked" in wxRadioButton documentation.

Browse Source 
We used "depressed" or "selected"; replace both of them with hopefully more
clear "checked".

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70380 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin 2012-01-17 23:48:01 +00:00
parent a39815bd30
commit 24a03ec521
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
interface/wx/radiobut.h
View File

@ -97,20 +97,21 @@ public:
const wxString& name = wxRadioButtonNameStr);
/**
Returns @true if the radio button is depressed, @false otherwise.
Returns @true if the radio button is checked, @false otherwise.
*/
virtual bool GetValue() const;
/**
Sets the radio button to selected or deselected status. This does not cause a
Sets the radio button to checked or unchecked status. This does not cause a
@c wxEVT_COMMAND_RADIOBUTTON_SELECTED event to get emitted.
If the radio button belongs to a group you can only select a radio button
(which will deselect the previously selected button) and you therefore
must not call this method with value set to @false in that case.
If the radio button belongs to a radio group exactly one button in the
group may be checked and so this method can be only called with @a
value set to @true. To uncheck a radio button in a group you must check
another button in the same group.
@param value
@true to select, @false to deselect.
@true to check, @false to uncheck.
*/
virtual void SetValue(bool value);
};