some more comments about wxSortedArrayString::Sort

[wxWidgets.git] / interface / checklst.h

diff --git a/interface/checklst.h b/interface/checklst.h
index 9652322fc30d550435010d2ac170be4d141bffb3..2e13c53661666824cac6ea8a44417e08e857428a 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
@@ -9,29 +9,28 @@
 /**
     @class wxCheckListBox
     @wxheader{checklst.h}
-    
+
     A checklistbox is like a listbox, 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.
-    
+
     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)}:
+    @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}
-    
-    @seealso
-    wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent
+
+    @see wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent
 */
 class wxCheckListBox : public wxListBox
 {
@@ -39,51 +38,44 @@ public:
     //@{
     /**
         Constructor, creating and showing a list box.
-        
-        @param parent 
-        Parent window. Must not be @NULL.
-        
-        @param id 
-        Window identifier. The value wxID_ANY indicates a default value.
-        
-        @param pos 
-        Window position.
-        
-        @param size 
-        Window size. If wxDefaultSize is specified then the window is sized
-        appropriately.
-        
-        @param n 
-        Number of strings with which to initialise the control.
-        
-        @param choices 
-        An array of strings with which to initialise the control.
-        
-        @param style 
-        Window style. See wxCheckListBox.
-        
-        @param validator 
-        Window validator.
-        
-        @param name 
-        Window name.
+
+        @param parent
+            Parent window. Must not be @NULL.
+        @param id
+            Window identifier. The value wxID_ANY indicates a default value.
+        @param pos
+            Window position.
+        @param size
+            Window size. If wxDefaultSize is specified then the window is
+        sized
+            appropriately.
+        @param n
+            Number of strings with which to initialise the control.
+        @param choices
+            An array of strings with which to initialise the control.
+        @param style
+            Window style. See wxCheckListBox.
+        @param validator
+            Window validator.
+        @param name
+            Window name.
     */
     wxCheckListBox();
-        wxCheckListBox(wxWindow* parent, wxWindowID id,
-                       const wxPoint& pos = wxDefaultPosition,
-                       const wxSize& size = wxDefaultSize,
-                       int n,
-                       const wxString choices[] = @NULL,
-                       long style = 0,
-                       const wxValidator& validator = wxDefaultValidator,
-                       const wxString& name = "listBox");
-        wxCheckListBox(wxWindow* parent, wxWindowID id,
-                       const wxPoint& pos,
-                       const wxSize& size,
-                       const wxArrayString& choices,
-                       long style = 0,
-                       const wxValidator& validator = wxDefaultValidator,
-                       const wxString& name = "listBox");
+    wxCheckListBox(wxWindow* parent, wxWindowID id,
+                   const wxPoint& pos = wxDefaultPosition,
+                   const wxSize& size = wxDefaultSize,
+                   int n,
+                   const wxString choices[] = NULL,
+                   long style = 0,
+                   const wxValidator& validator = wxDefaultValidator,
+                   const wxString& name = "listBox");
+    wxCheckListBox(wxWindow* parent, wxWindowID id,
+                   const wxPoint& pos,
+                   const wxSize& size,
+                   const wxArrayString& choices,
+                   long style = 0,
+                   const wxValidator& validator = wxDefaultValidator,
+                   const wxString& name = "listBox");
     //@}
 
     /**
@@ -94,12 +86,12 @@ public:
     /**
         Checks the given item. Note that calling this method doesn't result in
         wxEVT_COMMAND_CHECKLISTBOX_TOGGLE being emitted.
-        
-        @param item 
-        Index of item to check.
-        
-        @param check 
-        @true if the item is to be checked, @false otherwise.
+
+        @param item
+            Index of item to check.
+        @param check
+            @true if the item is to be checked, @false otherwise.
     */
-    void Check(int item, bool check = @true);
+    void Check(int item, bool check = true);
 };
+