Add OS/2 to buildbot (patch #1929212).

[wxWidgets.git] / interface / checkbox.h

diff --git a/interface/checkbox.h b/interface/checkbox.h
index 81757d0f8e79f43d64b864437d25f565b6685afa..8fe098e3b8c6907508ea92b627d0553e5375d77e 100644 (file)
--- a/interface/checkbox.h
+++ b/interface/checkbox.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        checkbox.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        checkbox.h

-// Purpose:     documentation for wxCheckBox class
+// Purpose:     interface of wxCheckBox

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -29,7 +29,7 @@
            Makes the text appear on the left of the checkbox.
     @endStyleTable
 
            Makes the text appear on the left of the checkbox.
     @endStyleTable
 

-    @beginEventTable
+    @beginEventTable{wxCommandEvent}

     @event{EVT_CHECKBOX(id, func)}:
            Process a wxEVT_COMMAND_CHECKBOX_CLICKED event, when the checkbox
            is clicked.
     @event{EVT_CHECKBOX(id, func)}:
            Process a wxEVT_COMMAND_CHECKBOX_CLICKED event, when the checkbox
            is clicked.


@@ -39,8 +39,7 @@
     @category{ctrl}
     @appearance{checkbox.png}
 
     @category{ctrl}
     @appearance{checkbox.png}
 

-    @seealso
-    wxRadioButton, wxCommandEvent
+    @see wxRadioButton, wxCommandEvent

 */
 class wxCheckBox : public wxControl
 {
 */
 class wxCheckBox : public wxControl
 {


@@ -48,7 +47,7 @@ public:
     //@{
     /**
         Constructor, creating and showing a checkbox.
     //@{
     /**
         Constructor, creating and showing a checkbox.

-        
+

         @param parent
             Parent window. Must not be @NULL.
         @param id
         @param parent
             Parent window. Must not be @NULL.
         @param id


@@ -67,7 +66,7 @@ public:
             Window validator.
         @param name
             Window name.
             Window validator.
         @param name
             Window name.

-        
+

         @see Create(), wxValidator
     */
     wxCheckBox();
         @see Create(), wxValidator
     */
     wxCheckBox();


@@ -76,7 +75,7 @@ public:
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = 0,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = 0,

-               const wxValidator& val,
+               const wxValidator& val = wxDefaultValidator,

                const wxString& name = "checkBox");
     //@}
 
                const wxString& name = "checkBox");
     //@}
 


@@ -94,12 +93,12 @@ public:
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,

-                const wxValidator& val,
+                const wxValidator& val = wxDefaultValidator,

                 const wxString& name = "checkBox");
 
     /**
         Gets the state of a 3-state checkbox.
                 const wxString& name = "checkBox");
 
     /**
         Gets the state of a 3-state checkbox.

-        
+

         @returns Returns wxCHK_UNCHECKED when the checkbox is unchecked,
                  wxCHK_CHECKED  when it is checked and
                  wxCHK_UNDETERMINED when it's in the undetermined state.
         @returns Returns wxCHK_UNCHECKED when the checkbox is unchecked,
                  wxCHK_CHECKED  when it is checked and
                  wxCHK_UNDETERMINED when it's in the undetermined state.


@@ -110,14 +109,14 @@ public:
 
     /**
         Gets the state of a 2-state checkbox.
 
     /**
         Gets the state of a 2-state checkbox.

-        
+

         @returns Returns @true if it is checked, @false otherwise.
     */
     bool GetValue() const;
 
     /**
         Returns whether or not the checkbox is a 3-state checkbox.
         @returns Returns @true if it is checked, @false otherwise.
     */
     bool GetValue() const;
 
     /**
         Returns whether or not the checkbox is a 3-state checkbox.

-        
+

         @returns Returns @true if this checkbox is a 3-state checkbox, @false if
                  it's a 2-state checkbox.
     */
         @returns Returns @true if this checkbox is a 3-state checkbox, @false if
                  it's a 2-state checkbox.
     */


@@ -125,7 +124,7 @@ public:
 
     /**
         Returns whether or not the user can set the checkbox to the third state.
 
     /**
         Returns whether or not the user can set the checkbox to the third state.

-        
+

         @returns Returns @true if the user can set the third state of this
                  checkbox, @false if it can only be set programmatically
                  or if it's a 2-state checkbox.
         @returns Returns @true if the user can set the third state of this
                  checkbox, @false if it can only be set programmatically
                  or if it's a 2-state checkbox.


@@ -142,9 +141,10 @@ public:
     /**
         Sets the checkbox to the given state. This does not cause a
         wxEVT_COMMAND_CHECKBOX_CLICKED event to get emitted.
     /**
         Sets the checkbox to the given state. This does not cause a
         wxEVT_COMMAND_CHECKBOX_CLICKED event to get emitted.

-        
+

         @param state
             If @true, the check is on, otherwise it is off.
     */
     void SetValue(bool state);
 };
         @param state
             If @true, the check is on, otherwise it is off.
     */
     void SetValue(bool state);
 };

+