wxCheckListBox.3erl - Man Page
Functions for wxCheckListBox class
Description
A wxCheckListBox is like a wxListBox, but allows items to be checked or unchecked.
When using this class under Windows wxWidgets must be compiled with wxUSE_OWNER_DRAWN set to 1.
See: wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent
This class is derived (and can use functions) from: wxListBox wxControlWithItems wxControl wxWindow wxEvtHandler
wxWidgets docs: wxCheckListBox
Events
Event types emitted from this class: command_checklistbox_toggled
Data Types
wxCheckListBox() = wx:wx_object()
Exports
new() -> wxCheckListBox()
Default constructor.
new(Parent, Id) -> wxCheckListBox()
- Types:
Parent = wxWindow:wxWindow()
Id = integer()
new(Parent, Id, Options :: [Option]) -> wxCheckListBox()
- Types:
Parent = wxWindow:wxWindow()
Id = integer()
Option =
{pos, {X :: integer(), Y :: integer()}} |
{size, {W :: integer(), H :: integer()}} |
{choices, [unicode:chardata()]} |
{style, integer()} |
{validator, wx:wx_object()}
Constructor, creating and showing a list box.
destroy(This :: wxCheckListBox()) -> ok
Destructor, destroying the list box.
check(This, Item) -> ok
- Types:
This = wxCheckListBox()
Item = integer()
check(This, Item, Options :: [Option]) -> ok
- Types:
This = wxCheckListBox()
Item = integer()
Option = {check, boolean()}
Checks the given item.
Note that calling this method does not result in a wxEVT_CHECKLISTBOX event being emitted.
isChecked(This, Item) -> boolean()
- Types:
This = wxCheckListBox()
Item = integer()
Returns true if the given item is checked, false otherwise.