compilation fix for PCH-less build

[wxWidgets.git] / interface / checklst.h

diff --git a/interface/checklst.h b/interface/checklst.h
index 880ab4378c7f5118b02834c5a86d9cb0600455ad..c8a6ee6073c75d8ffe394fa1a987a59c20035a93 100644 (file)
--- a/interface/checklst.h
+++ b/interface/checklst.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        checklst.h
-// Purpose:     documentation for wxCheckListBox class
+// Purpose:     interface of wxCheckListBox
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -10,70 +10,66 @@
     @class wxCheckListBox
     @wxheader{checklst.h}
 
-    A checklistbox is like a listbox, but allows items to be checked or unchecked.
+    A wxCheckListBox is like a wxListBox, but allows items to be checked or
+    unchecked.
 
     When using this class under Windows wxWidgets must be compiled with
-    USE_OWNER_DRAWN set to 1.
+    wxUSE_OWNER_DRAWN set to 1.
 
     Only the new functions for this class are documented; see also wxListBox.
 
     Please note that wxCheckListBox uses client data in its implementation,
     and therefore this is not available to the application.
 
-    @beginEventTable
-    @event{EVT_CHECKLISTBOX(id\, func)}:
+    @beginEventTable{wxCommandEvent}
+    @event{EVT_CHECKLISTBOX(id, func)}
            Process a wxEVT_COMMAND_CHECKLISTBOX_TOGGLED event, when an item in
            the check list box is checked or unchecked.
     @endEventTable
 
     @library{wxcore}
     @category{ctrl}
-    @appearance{checklistbox.png}
+    <!-- @appearance{checklistbox.png} -->
 
-    @seealso
-    wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent
+    @see wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent
 */
 class wxCheckListBox : public wxListBox
 {
 public:
+    /**
+        Default constructor.
+    */
+    wxCheckListBox();
+
     //@{
     /**
         Constructor, creating and showing a list box.
-        
+
         @param parent
-        Parent window. Must not be @NULL.
-        
+            Parent window. Must not be @NULL.
         @param id
-        Window identifier. The value wxID_ANY indicates a default value.
-        
+            Window identifier. The value wxID_ANY indicates a default value.
         @param pos
-        Window position.
-        
+            Window position.
         @param size
-        Window size. If wxDefaultSize is specified then the window is sized
-        appropriately.
-        
+            Window size. If wxDefaultSize is specified then the window is sized
+            appropriately.
         @param n
-        Number of strings with which to initialise the control.
-        
+            Number of strings with which to initialise the control.
         @param choices
-        An array of strings with which to initialise the control.
-        
+            An array of strings with which to initialise the control.
         @param style
-        Window style. See wxCheckListBox.
-        
+            Window style. See wxCheckListBox.
         @param validator
-        Window validator.
-        
+            Window validator.
         @param name
-        Window name.
+            Window name.
     */
-    wxCheckListBox();
     wxCheckListBox(wxWindow* parent, wxWindowID id,
                    const wxPoint& pos = wxDefaultPosition,
                    const wxSize& size = wxDefaultSize,
                    int n,
-                   const wxString choices[] = @NULL,
+                   const wxString choices[] = NULL,
                    long style = 0,
                    const wxValidator& validator = wxDefaultValidator,
                    const wxString& name = "listBox");
@@ -92,14 +88,22 @@ public:
     ~wxCheckListBox();
 
     /**
-        Checks the given item. Note that calling this method doesn't result in
-        wxEVT_COMMAND_CHECKLISTBOX_TOGGLE being emitted.
-        
+        Checks the given item. Note that calling this method does not result in
+        a wxEVT_COMMAND_CHECKLISTBOX_TOGGLE event being emitted.
+
         @param item
-        Index of item to check.
-        
+            Index of item to check.
         @param check
-        @true if the item is to be checked, @false otherwise.
+            @true if the item is to be checked, @false otherwise.
     */
-    void Check(int item, bool check = @true);
+    void Check(int item, bool check = true);
+
+    /**
+        Returns @true if the given item is checked, @false otherwise.
+
+        @param item
+            Index of item whose check status is to be returned.
+    */
+    bool IsChecked(unsigned int item) const;
 };
+