// Purpose: interface of wxCheckListBox
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@beginEventEmissionTable{wxCommandEvent}
@event{EVT_CHECKLISTBOX(id, func)}
- Process a wxEVT_COMMAND_CHECKLISTBOX_TOGGLED event, when an item in
+ Process a @c wxEVT_CHECKLISTBOX 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()
@library{wxcore}
@category{ctrl}
- @appearance{checklistbox.png}
+ @appearance{checklistbox}
@see wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent
*/
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.
*/
/**
Checks the given item. Note that calling this method does not result in
- a wxEVT_COMMAND_CHECKLISTBOX_TOGGLE event being emitted.
+ a @c wxEVT_CHECKLISTBOX event being emitted.
@param item
Index of item to check.
Index of item whose check status is to be returned.
*/
bool IsChecked(unsigned int item) const;
+
+ /**
+ Return the indices of the checked items.
+
+ @param checkedItems
+ A reference to the array that is filled with the indices of the
+ checked items.
+ @return The number of checked items.
+
+ @see Check(), IsChecked()
+
+ @since 2.9.5
+ */
+ unsigned int GetCheckedItems(wxArrayInt& checkedItems) const;
};