no real changes, just simplify LoadPage() to make it more readable and less redundant

[wxWidgets.git] / interface / radiobut.h

diff --git a/interface/radiobut.h b/interface/radiobut.h
index ef08ea723b4a19c365f9df6ed4e7f3aa03af99e5..dfce977c5067eea1d67c371097d4c6190081f599 100644 (file)
--- 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,86 +9,82 @@
 /**
     @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.
-    
+
+    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}:
+    @style{wxRB_GROUP}
            Marks the beginning of a new group of radio buttons.
-    @style{wxRB_SINGLE}:
+    @style{wxRB_SINGLE}
            In some circumstances, radio buttons that are not consecutive
            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}:
+    @style{wxRB_USE_CHECKBOX}
            Use a checkbox button instead of radio button (currently supported
            only on PalmOS).
     @endStyleTable
-    
-    @beginEventTable
-    @event{EVT_RADIOBUTTON(id\, func)}:
-           Process a wxEVT_COMMAND_RADIOBUTTON_SELECTED event, when the
+
+    @beginEventTable{wxCommandEvent}
+    @event{EVT_RADIOBUTTON(id, func)}
+           Process a @c 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
+    <!-- @appearance{radiobutton.png} -->
+
+    @see @ref overview_eventhandling, wxRadioBox, wxCheckBox
 */
 class wxRadioButton : public wxControl
 {
 public:
-    //@{
+
+    /**
+        Default constructor.
+
+        @see Create(), wxValidator
+    */
+    wxRadioButton();
+
     /**
         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 @c wxID_ANY indicates a default value.
+        @param label
+            Label for the radio button.
+        @param pos
+            Window position. If @c wxDefaultPosition is specified then a default
+        position is chosen.
+        @param size
+            Window size. If @c 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");
 
     /**
         Destructor, destroying the radio button item.
@@ -110,14 +106,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.
+        @c wxEVT_COMMAND_RADIOBUTTON_SELECTED event to get emitted.
+
+        @param value
+            @true to select, @false to deselect.
     */
     void SetValue(const bool value);
 };
+