Fix spelling in the comments in wxPropertyGrid code.

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

diff --git a/interface/wx/radiobut.h b/interface/wx/radiobut.h
index 439fc32bfd66b2638c20548de1f36711a524e7a5..4b845c53098b9836980ddd6fae975f9629c73563 100644 (file)
--- a/interface/wx/radiobut.h
+++ b/interface/wx/radiobut.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxRadioButton
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxRadioButton
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -25,12 +25,9 @@
            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.
            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
 
     @endStyleTable
 

-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}

     @event{EVT_RADIOBUTTON(id, func)}
            Process a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED event, when the
            radiobutton is clicked.
     @event{EVT_RADIOBUTTON(id, func)}
            Process a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED event, when the
            radiobutton is clicked.


@@ -40,12 +37,11 @@
     @category{ctrl}
     @appearance{radiobutton.png}
 
     @category{ctrl}
     @appearance{radiobutton.png}
 

-    @see @ref overview_eventhandling, wxRadioBox, wxCheckBox
+    @see @ref overview_events, wxRadioBox, wxCheckBox

 */
 class wxRadioButton : public wxControl
 {
 public:
 */
 class wxRadioButton : public wxControl
 {
 public:

-

     /**
         Default constructor.
 
     /**
         Default constructor.
 


@@ -63,11 +59,11 @@ public:
         @param label
             Label for the radio button.
         @param pos
         @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
         @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
         @param style
             Window style. See wxRadioButton.
         @param validator


@@ -101,16 +97,21 @@ public:
                 const wxString& name = wxRadioButtonNameStr);
 
     /**
                 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;
 
     /**
     */
     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.
 
         @c wxEVT_COMMAND_RADIOBUTTON_SELECTED 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
         @param value

-            @true to select, @false to deselect.
+            @true to check, @false to uncheck.

     */
     virtual void SetValue(bool value);
 };
     */
     virtual void SetValue(bool value);
 };