]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/checkbox.h
adding more infos, links
[wxWidgets.git] / interface / wx / checkbox.h
index e0f584b3b6a06e397a06471d588ef22746f1173d..c4f7543b90d4f673467dba6e964597499c8fb15c 100644 (file)
@@ -19,7 +19,6 @@ enum wxCheckBoxState
 
 /**
     @class wxCheckBox
-    @wxheader{checkbox.h}
 
     A checkbox is a labelled box which by default is either on (checkmark is
     visible) or off (no checkmark). Optionally (when the wxCHK_3STATE style
@@ -40,7 +39,7 @@ enum wxCheckBoxState
            Makes the text appear on the left of the checkbox.
     @endStyleTable
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_CHECKBOX(id, func)}
            Process a wxEVT_COMMAND_CHECKBOX_CLICKED event, when the checkbox
            is clicked.
@@ -48,7 +47,7 @@ enum wxCheckBoxState
 
     @library{wxcore}
     @category{ctrl}
-    <!-- @appearance{checkbox.png} -->
+    @appearance{checkbox.png}
 
     @see wxRadioButton, wxCommandEvent
 */
@@ -72,11 +71,11 @@ public:
         @param label
             Text to be displayed next to the checkbox.
         @param pos
-            Checkbox position. If wxDefaultPosition is specified then a default
-            position is chosen.
+            Checkbox position. 
+            If ::wxDefaultPosition is specified then a default position is chosen.
         @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
             Window style. See wxCheckBox.
         @param validator
@@ -91,32 +90,30 @@ public:
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = 0,
-               const wxValidator& val = wxDefaultValidator,
-               const wxString& name = "checkBox");
+               const wxValidator& validator = wxDefaultValidator,
+               const wxString& name = wxCheckBoxNameStr);
 
     /**
         Destructor, destroying the checkbox.
     */
-    ~wxCheckBox();
+    virtual ~wxCheckBox();
 
     /**
         Creates the checkbox for two-step construction. See wxCheckBox()
         for details.
     */
-    bool Create(wxWindow* parent, wxWindowID id,
-                const wxString& label,
+    bool Create(wxWindow* parent, wxWindowID id, const wxString& label,
                 const wxPoint& pos = wxDefaultPosition,
-                const wxSize& size = wxDefaultSize,
-                long style = 0,
-                const wxValidator& val = wxDefaultValidator,
-                const wxString& name = "checkBox");
+                const wxSize& size = wxDefaultSize, long style = 0,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& = wxCheckBoxNameStr);
 
     /**
         Gets the state of a 2-state checkbox.
 
         @return Returns @true if it is checked, @false otherwise.
     */
-    bool GetValue() const;
+    virtual bool GetValue() const;
 
     /**
         Gets the state of a 3-state checkbox. Asserts when the function is used
@@ -156,7 +153,7 @@ public:
         @param state
             If @true, the check is on, otherwise it is off.
     */
-    void SetValue(bool state);
+    virtual void SetValue(bool state);
 
     /**
         Sets the checkbox to the given state. This does not cause a
@@ -165,6 +162,6 @@ public:
         Asserts when the checkbox is a 2-state checkbox and setting the state
         to wxCHK_UNDETERMINED.
     */
-    void Set3StateValue(const wxCheckBoxState state);
+    void Set3StateValue(wxCheckBoxState state);
 };