]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/radiobut.h
Update wxHtmlWindow documentation to refer to wxWebView.
[wxWidgets.git] / interface / wx / radiobut.h
index ef4dd21c7602256a853e9fe70a568a5395211472..26366ecdc3954345ca3f5b7fa7515203d93bea1c 100644 (file)
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxRadioButton
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -30,7 +30,7 @@
            only on PalmOS).
     @endStyleTable
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_RADIOBUTTON(id, func)}
            Process a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED event, when the
            radiobutton is clicked.
     @category{ctrl}
     @appearance{radiobutton.png}
 
-    @see @ref overview_eventhandling, wxRadioBox, wxCheckBox
+    @see @ref overview_events, wxRadioBox, wxCheckBox
 */
 class wxRadioButton : public wxControl
 {
 public:
-
     /**
         Default constructor.
 
@@ -63,11 +62,11 @@ public:
         @param label
             Label for the radio button.
         @param pos
-            Window position. If @c wxDefaultPosition is specified then a default
-        position is chosen.
+            Window position. If ::wxDefaultPosition is specified then a default
+            position is chosen.
         @param size
-            Window size. If @c wxDefaultSize is specified then a default size
-        is chosen.
+            Window size. If ::wxDefaultSize is specified then a default size
+            is chosen.
         @param style
             Window style. See wxRadioButton.
         @param validator
@@ -83,7 +82,7 @@ public:
                   const wxSize& size = wxDefaultSize,
                   long style = 0,
                   const wxValidator& validator = wxDefaultValidator,
-                  const wxString& name = "radioButton");
+                  const wxString& name = wxRadioButtonNameStr);
 
     /**
         Destructor, destroying the radio button item.
@@ -108,6 +107,10 @@ public:
     /**
         Sets the radio button to selected or deselected 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.
 
         @param value
             @true to select, @false to deselect.