---
name: "wxCheckListBox"
section: "3erl"
platform: "linux"
package: "erlang-manpages"
version: "1:25.2.3+dfsg-1+deb12u4"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/wxCheckListBox"
---

# wxCheckListBox(3erl)

Functions for wxCheckListBox class

## NAME

wxCheckListBox - 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.