undo the last change as it results in buildbot configuration error

[wxWidgets.git] / interface / wx / checklst.h

diff --git a/interface/wx/checklst.h b/interface/wx/checklst.h
index bb1421167f4e6120e40e31d6a0547d2c61e06f9d..2ed407f03191d8f572bbea7b85f009b549f1c4e4 100644 (file)
--- a/interface/wx/checklst.h
+++ b/interface/wx/checklst.h
@@ -15,20 +15,18 @@
     When using this class under Windows wxWidgets must be compiled with
     wxUSE_OWNER_DRAWN set to 1.
 
     When using this class under Windows wxWidgets must be compiled with
     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{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}

     @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.
+        Process a wxEVT_COMMAND_CHECKLISTBOX_TOGGLED event, when an item in
+        the check list box is checked or unchecked. wxCommandEvent::GetInt()
+        will contain the index of the item that was checked or unchecked.
+        wxCommandEvent::IsChecked() is not valid! Use wxCheckListBox::IsChecked()
+        instead.

     @endEventTable
 
     @library{wxcore}
     @category{ctrl}
     @endEventTable
 
     @library{wxcore}
     @category{ctrl}

-    <!-- @appearance{checklistbox.png} -->
+    @appearance{checklistbox.png}

 
     @see wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent
 */
 
     @see wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent
 */


@@ -50,9 +48,10 @@ public:
             Window identifier. The value wxID_ANY indicates a default value.
         @param pos
             Window position.
             Window identifier. The value wxID_ANY indicates a default value.
         @param pos
             Window position.

+            If ::wxDefaultPosition is specified then a default position is chosen.

         @param size
         @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.
         @param choices
         @param n
             Number of strings with which to initialise the control.
         @param choices


@@ -105,7 +104,7 @@ public:
     /**
         Destructor, destroying the list box.
     */
     /**
         Destructor, destroying the list box.
     */

-    ~wxCheckListBox();
+    virtual ~wxCheckListBox();

 
     /**
         Checks the given item. Note that calling this method does not result in
 
     /**
         Checks the given item. Note that calling this method does not result in


@@ -116,7 +115,7 @@ public:
         @param check
             @true if the item is to be checked, @false otherwise.
     */
         @param check
             @true if the item is to be checked, @false otherwise.
     */

-    void Check(int item, bool check = true);
+    void Check(unsigned int item, bool check = true);

 
     /**
         Returns @true if the given item is checked, @false otherwise.
 
     /**
         Returns @true if the given item is checked, @false otherwise.