Fix wrong return value in the changes of r73365.

[wxWidgets.git] / interface / wx / radiobut.h

diff --git a/interface/wx/radiobut.h b/interface/wx/radiobut.h
index 26366ecdc3954345ca3f5b7fa7515203d93bea1c..1c8b839b18bf3435219d6340b1c7616464f857cd 100644 (file)
--- a/interface/wx/radiobut.h
+++ b/interface/wx/radiobut.h
@@ -25,9 +25,6 @@
            siblings trigger a hang bug in Windows (only). If this happens, add
            this style to mark the button as not belonging to a group, and
            implement the mutually-exclusive group behaviour yourself.
-    @style{wxRB_USE_CHECKBOX}
-           Use a checkbox button instead of radio button (currently supported
-           only on PalmOS).
     @endStyleTable
 
     @beginEventEmissionTable{wxCommandEvent}
@@ -38,7 +35,7 @@
 
     @library{wxcore}
     @category{ctrl}
-    @appearance{radiobutton.png}
+    @appearance{radiobutton}
 
     @see @ref overview_events, wxRadioBox, wxCheckBox
 */
@@ -100,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);
 };