]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/checkbox.h
speedup a little the parser by converting gccXML ID attributes to numbers, instead...
[wxWidgets.git] / interface / checkbox.h
index 09c30ce4fb5b6764a3989c1ea28dc77a11a96138..26bf103fd16205c8c57287821f53dd1d27a5487d 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        checkbox.h
-// Purpose:     documentation for wxCheckBox class
+// Purpose:     interface of wxCheckBox
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -39,8 +39,7 @@
     @category{ctrl}
     @appearance{checkbox.png}
 
-    @seealso
-    wxRadioButton, wxCommandEvent
+    @see wxRadioButton, wxCommandEvent
 */
 class wxCheckBox : public wxControl
 {
@@ -48,7 +47,7 @@ public:
     //@{
     /**
         Constructor, creating and showing a checkbox.
-        
+
         @param parent
             Parent window. Must not be @NULL.
         @param id
@@ -67,7 +66,7 @@ public:
             Window validator.
         @param name
             Window name.
-        
+
         @see Create(), wxValidator
     */
     wxCheckBox();
@@ -99,52 +98,53 @@ public:
 
     /**
         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.
                  Asserts when the function is used with a 2-state
                  checkbox.
     */
-    wxCheckBoxState Get3StateValue();
+    wxCheckBoxState Get3StateValue() const;
 
     /**
         Gets the state of a 2-state checkbox.
-        
+
         @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 Returns @true if this checkbox is a 3-state checkbox, @false if
                  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 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.
     */
-    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.
     */
-    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.
-        
+
         @param state
             If @true, the check is on, otherwise it is off.
     */
     void SetValue(bool state);
 };
+