]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/checklst.h
implement * and / operators for wxPoint, not only wxSize.
[wxWidgets.git] / interface / wx / checklst.h
index 14d726d9c74f4e142481c64f6e4705a2e4f71f2d..62ee9e8a9f5b2e653e2c7bb0f3d4dd7a448f5fe5 100644 (file)
     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)}
-           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}
@@ -50,9 +48,10 @@ public:
             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
-            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
@@ -63,6 +62,10 @@ public:
             Window validator.
         @param name
             Window name.
+
+        @beginWxPerlOnly
+        Not supported by wxPerl.
+        @endWxPerlOnly
     */
     wxCheckListBox(wxWindow* parent, wxWindowID id,
                    const wxPoint& pos = wxDefaultPosition,
@@ -92,6 +95,10 @@ public:
             Window validator.
         @param name
             Window name.
+
+        @beginWxPerlOnly
+        Use an array reference for the @a choices parameter.
+        @endWxPerlOnly
     */
     wxCheckListBox(wxWindow* parent, wxWindowID id,
                    const wxPoint& pos,