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

[wxWidgets.git] / interface / checkbox.h

diff --git a/interface/checkbox.h b/interface/checkbox.h
index 86f9ad34604cd13cc805b62d4ff9c2ab9c2426ec..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,8 +29,8 @@
            Makes the text appear on the left of the checkbox.
     @endStyleTable
 
            Makes the text appear on the left of the checkbox.
     @endStyleTable
 

-    @beginEventTable
-    @event{EVT_CHECKBOX(id\, func)}:
+    @beginEventTable{wxCommandEvent}
+    @event{EVT_CHECKBOX(id, func)}:

            Process a wxEVT_COMMAND_CHECKBOX_CLICKED event, when the checkbox
            is clicked.
     @endEventTable
            Process a wxEVT_COMMAND_CHECKBOX_CLICKED event, when the checkbox
            is clicked.
     @endEventTable


@@ -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,34 +47,27 @@ public:
     //@{
     /**
         Constructor, creating and showing a checkbox.
     //@{
     /**
         Constructor, creating and showing a checkbox.

-        
+

         @param parent
         @param parent

-        Parent window. Must not be @NULL.
-        
+            Parent window. Must not be @NULL.

         @param id
         @param id

-        Checkbox identifier. The value wxID_ANY indicates a default value.
-        
+            Checkbox identifier. The value wxID_ANY indicates a default value.

         @param label
         @param label

-        Text to be displayed next to the checkbox.
-        
+            Text to be displayed next to the checkbox.

         @param pos
         @param pos

-        Checkbox position. If wxDefaultPosition is specified then a default
+            Checkbox position. If wxDefaultPosition is specified then a default

         position is chosen.
         position is chosen.

-        

         @param size
         @param size

-        Checkbox size. If wxDefaultSize is specified then a default size is
-        chosen.
-        
+            Checkbox size. If wxDefaultSize is specified then a default
+        size is chosen.

         @param style
         @param style

-        Window style. See wxCheckBox.
-        
+            Window style. See wxCheckBox.

         @param validator
         @param validator

-        Window validator.
-        
+            Window validator.

         @param name
         @param name

-        Window name.
-        
-        @sa Create(), wxValidator
+            Window name.
+
+        @see Create(), wxValidator

     */
     wxCheckBox();
     wxCheckBox(wxWindow* parent, wxWindowID id,
     */
     wxCheckBox();
     wxCheckBox(wxWindow* parent, wxWindowID id,


@@ -83,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");
     //@}
 


@@ -101,57 +93,58 @@ 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,
         @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. Asserts when the function is used with a
-                   2-state checkbox.
+                 wxCHK_CHECKED  when it is checked and
+                 wxCHK_UNDETERMINED when it's in the undetermined state.
+                 Asserts when the function is used with a 2-state
+                 checkbox.

     */
     */

-    wxCheckBoxState Get3StateValue();
+    wxCheckBoxState Get3StateValue() const;

 
     /**
         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.
     */
         @returns Returns @true if it is checked, @false otherwise.
     */

-    bool GetValue();
+    bool GetValue() const;

 
     /**
         Returns whether or not the checkbox is a 3-state checkbox.
 
     /**
         Returns whether or not the checkbox is a 3-state checkbox.

-        
+

         @returns Returns @true if this checkbox is a 3-state checkbox, @false if
         @returns Returns @true if this checkbox is a 3-state checkbox, @false if

-                   it's a 2-state checkbox.
+                 it's a 2-state checkbox.

     */
     */

-    bool Is3State();
+    bool Is3State() const;

 
     /**
         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
         @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.
+                 checkbox, @false if it can only be set programmatically
+                 or if it's a 2-state checkbox.

     */
     */

-    bool Is3rdStateAllowedForUser();
+    bool Is3rdStateAllowedForUser() const;

 
     /**
         This is just a maybe more readable synonym for
         GetValue(): just as the latter, it returns
         @true if the checkbox is checked and @false otherwise.
     */
 
     /**
         This is just a maybe more readable synonym for
         GetValue(): just as the latter, it returns
         @true if the checkbox is checked and @false otherwise.
     */

-    bool IsChecked();
+    bool IsChecked() const;

 
     /**
         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
         @param state

-        If @true, the check is on, otherwise it is off.
+            If @true, the check is on, otherwise it is off.

     */
     void SetValue(bool state);
 };
     */
     void SetValue(bool state);
 };

+