Add a link to Microsoft guidelines from wxICON_QUESTION documentation.

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

diff --git a/interface/wx/checklst.h b/interface/wx/checklst.h
index c8a6ee6073c75d8ffe394fa1a987a59c20035a93..79f82582fdaab3d82d955557e37fc1c211ad0b66 100644 (file)
--- a/interface/wx/checklst.h
+++ b/interface/wx/checklst.h
@@ -3,12 +3,11 @@
 // 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

 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxCheckListBox
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxCheckListBox

-    @wxheader{checklst.h}

 
     A wxCheckListBox is like a wxListBox, but allows items to be checked or
     unchecked.
 
     A wxCheckListBox is like a wxListBox, but allows items to be checked or
     unchecked.


@@ -16,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
 */


@@ -51,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


@@ -64,15 +62,44 @@ 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,
                    const wxSize& size = wxDefaultSize,
     */
     wxCheckListBox(wxWindow* parent, wxWindowID id,
                    const wxPoint& pos = wxDefaultPosition,
                    const wxSize& size = wxDefaultSize,

-                   int n,
+                   int n = 0,

                    const wxString choices[] = NULL,
                    long style = 0,
                    const wxValidator& validator = wxDefaultValidator,
                    const wxString& name = "listBox");
                    const wxString choices[] = NULL,
                    long style = 0,
                    const wxValidator& validator = wxDefaultValidator,
                    const wxString& name = "listBox");

+    /**
+        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 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.
+
+        @beginWxPerlOnly
+        Use an array reference for the @a choices parameter.
+        @endWxPerlOnly
+    */

     wxCheckListBox(wxWindow* parent, wxWindowID id,
                    const wxPoint& pos,
                    const wxSize& size,
     wxCheckListBox(wxWindow* parent, wxWindowID id,
                    const wxPoint& pos,
                    const wxSize& size,


@@ -85,7 +112,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


@@ -96,7 +123,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.