// Purpose: interface of wxCheckListBox
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
When using this class under Windows wxWidgets must be compiled with
wxUSE_OWNER_DRAWN set to 1.
- @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 @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}
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
Window validator.
@param name
Window name.
+
+ @beginWxPerlOnly
+ Not supported by wxPerl.
+ @endWxPerlOnly
*/
wxCheckListBox(wxWindow* parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
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,
/**
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.