/**
@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)}:
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
*/
/**
Constructor, creating and showing a list box.
- @param parent
+ @param parent
Parent window. Must not be @NULL.
- @param id
+ @param id
Window identifier. The value wxID_ANY indicates a default value.
- @param pos
+ @param pos
Window position.
- @param size
+ @param size
Window size. If wxDefaultSize is specified then the window is sized
appropriately.
- @param n
+ @param n
Number of strings with which to initialise the control.
- @param choices
+ @param choices
An array of strings with which to initialise the control.
- @param style
+ @param style
Window style. See wxCheckListBox.
- @param validator
+ @param validator
Window validator.
- @param name
+ @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");
//@}
/**
Checks the given item. Note that calling this method doesn't result in
wxEVT_COMMAND_CHECKLISTBOX_TOGGLE being emitted.
- @param item
+ @param item
Index of item to check.
- @param check
+ @param check
@true if the item is to be checked, @false otherwise.
*/
void Check(int item, bool check = @true);