Consistently use "checked" in wxRadioButton documentation.

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

diff --git a/interface/wx/radiobut.h b/interface/wx/radiobut.h
index f24790b117ac977d4089808ef820157940f23533..4b845c53098b9836980ddd6fae975f9629c73563 100644 (file)
--- a/interface/wx/radiobut.h
+++ b/interface/wx/radiobut.h
@@ -97,20 +97,21 @@ public:
                 const wxString& name = wxRadioButtonNameStr);
 
     /**
                 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;
 
     /**
     */
     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.
         @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
 
         @param value

-            @true to select, @false to deselect.
+            @true to check, @false to uncheck.

     */
     virtual void SetValue(bool value);
 };
     */
     virtual void SetValue(bool value);
 };