synchronize GTK2 minimum version in docs

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

diff --git a/interface/wx/checklst.h b/interface/wx/checklst.h
index 8287d5acdf43b578a43cddf5ff28806dd8a5ac56..4e17472566996ca42eae501043c20e5103590410 100644 (file)
--- a/interface/wx/checklst.h
+++ b/interface/wx/checklst.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxCheckListBox
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxCheckListBox
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -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 @c 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


@@ -63,6 +62,10 @@ public:
             Window validator.
         @param name
             Window name.
             Window validator.
         @param name
             Window name.

+
+        @beginWxPerlOnly
+        Not supported by wxPerl.
+        @endWxPerlOnly

     */
     wxCheckListBox(wxWindow* parent, wxWindowID id,
                    const wxPoint& pos = wxDefaultPosition,
     */
     wxCheckListBox(wxWindow* parent, wxWindowID id,
                    const wxPoint& pos = wxDefaultPosition,


@@ -92,6 +95,10 @@ public:
             Window validator.
         @param name
             Window name.
             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,
     */
     wxCheckListBox(wxWindow* parent, wxWindowID id,
                    const wxPoint& pos,


@@ -102,6 +109,25 @@ public:
                    const wxString& name = "listBox");
     //@}
 
                    const wxString& name = "listBox");
     //@}
 

+    bool Create(wxWindow *parent,
+                wxWindowID id,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                int nStrings = 0,
+                const wxString choices[] = NULL,
+                long style = 0,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& name = wxListBoxNameStr);
+
+    bool Create(wxWindow *parent,
+                wxWindowID id,
+                const wxPoint& pos,
+                const wxSize& size,
+                const wxArrayString& choices,
+                long style = 0,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& name = wxListBoxNameStr);
+

     /**
         Destructor, destroying the list box.
     */
     /**
         Destructor, destroying the list box.
     */


@@ -109,7 +135,7 @@ public:
 
     /**
         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

-        a wxEVT_COMMAND_CHECKLISTBOX_TOGGLE event being emitted.
+        a @c wxEVT_COMMAND_CHECKLISTBOX_TOGGLE event being emitted.

 
         @param item
             Index of item to check.
 
         @param item
             Index of item to check.


@@ -125,5 +151,6 @@ public:
             Index of item whose check status is to be returned.
     */
     bool IsChecked(unsigned int item) const;
             Index of item whose check status is to be returned.
     */
     bool IsChecked(unsigned int item) const;

+    

 };
 
 };