X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..d9faa1fede04455b98de64001bcad46fa2061231:/interface/radiobut.h

diff --git a/interface/radiobut.h b/interface/radiobut.h
index ef08ea723b..1dc741718f 100644
--- a/interface/radiobut.h
+++ b/interface/radiobut.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        radiobut.h
-// Purpose:     documentation for wxRadioButton class
+// Purpose:     interface of wxRadioButton
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,15 +9,15 @@
 /**
     @class wxRadioButton
     @wxheader{radiobut.h}
-    
+
     A radio button item is a button which usually denotes one of several mutually
     exclusive options. It has a text label next to a (usually) round button.
-    
+
     You can create a group of mutually-exclusive radio buttons by specifying @c
     wxRB_GROUP for
     the first in the group. The group ends when another radio button group is
     created, or there are no more radio buttons.
-    
+
     @beginStyleTable
     @style{wxRB_GROUP}:
            Marks the beginning of a new group of radio buttons.
@@ -30,20 +30,18 @@
            Use a checkbox button instead of radio button (currently supported
            only on PalmOS).
     @endStyleTable
-    
+
     @beginEventTable
-    @event{EVT_RADIOBUTTON(id\, func)}:
+    @event{EVT_RADIOBUTTON(id, func)}:
            Process a wxEVT_COMMAND_RADIOBUTTON_SELECTED event, when the
            radiobutton is clicked.
     @endEventTable
-    
+
     @library{wxcore}
     @category{ctrl}
     @appearance{radiobutton.png}
-    
-    @seealso
-    @ref overview_eventhandlingoverview "Event handling overview", wxRadioBox,
-    wxCheckBox
+
+    @see @ref overview_eventhandlingoverview, wxRadioBox, wxCheckBox
 */
 class wxRadioButton : public wxControl
 {
@@ -51,43 +49,36 @@ public:
     //@{
     /**
         Constructor, creating and showing a radio button.
-        
-        @param parent 
-        Parent window. Must not be @NULL.
-        
-        @param id 
-        Window identifier. The value wxID_ANY indicates a default value.
-        
-        @param label 
-        Label for the radio button.
-        
-        @param pos 
-        Window position. If wxDefaultPosition is specified then a default position
+
+        @param parent
+            Parent window. Must not be @NULL.
+        @param id
+            Window identifier. The value wxID_ANY indicates a default value.
+        @param label
+            Label for the radio button.
+        @param pos
+            Window position. If wxDefaultPosition is specified then a default
+        position is chosen.
+        @param size
+            Window size. If wxDefaultSize is specified then a default size
         is chosen.
-        
-        @param size 
-        Window size. If wxDefaultSize is specified then a default size is
-        chosen.
-        
-        @param style 
-        Window style. See wxRadioButton.
-        
-        @param validator 
-        Window validator.
-        
-        @param name 
-        Window name.
-        
-        @sa Create(), wxValidator
+        @param style
+            Window style. See wxRadioButton.
+        @param validator
+            Window validator.
+        @param name
+            Window name.
+
+        @see Create(), wxValidator
     */
     wxRadioButton();
-        wxRadioButton(wxWindow* parent, wxWindowID id,
-                      const wxString& label,
-                      const wxPoint& pos = wxDefaultPosition,
-                      const wxSize& size = wxDefaultSize,
-                      long style = 0,
-                      const wxValidator& validator = wxDefaultValidator,
-                      const wxString& name = "radioButton");
+    wxRadioButton(wxWindow* parent, wxWindowID id,
+                  const wxString& label,
+                  const wxPoint& pos = wxDefaultPosition,
+                  const wxSize& size = wxDefaultSize,
+                  long style = 0,
+                  const wxValidator& validator = wxDefaultValidator,
+                  const wxString& name = "radioButton");
     //@}
 
     /**
@@ -110,14 +101,15 @@ public:
     /**
         Returns @true if the radio button is depressed, @false otherwise.
     */
-    bool GetValue();
+    bool GetValue() const;
 
     /**
         Sets the radio button to selected or deselected status. This does not cause a
         wxEVT_COMMAND_RADIOBUTTON_SELECTED event to get emitted.
-        
-        @param value 
-        @true to select, @false to deselect.
+
+        @param value
+            @true to select, @false to deselect.
     */
     void SetValue(const bool value);
 };
+