]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/radiobut.h
Move code removing "-psn_xxx" command line arguments to common code.
[wxWidgets.git] / interface / wx / radiobut.h
index 76a63a9b1a82c3400917867e7ca0bad8cc7f0a52..706f05c29386a7d6ef2ddd580a13c14c9676096b 100644 (file)
@@ -2,7 +2,6 @@
 // Name:        radiobut.h
 // Purpose:     interface of wxRadioButton
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
            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}
     @event{EVT_RADIOBUTTON(id, func)}
-           Process a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED event, when the
+           Process a @c wxEVT_RADIOBUTTON event, when the
            radiobutton is clicked.
     @endEventTable
 
     @library{wxcore}
     @category{ctrl}
-    @appearance{radiobutton.png}
+    @appearance{radiobutton}
 
     @see @ref overview_events, wxRadioBox, wxCheckBox
 */
@@ -100,16 +96,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
-        @c wxEVT_COMMAND_RADIOBUTTON_SELECTED event to get emitted.
+        Sets the radio button to checked or unchecked status. This does not cause a
+        @c wxEVT_RADIOBUTTON event to get emitted.
+
+        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);
 };