wxCheckListBox(3erl)

💅 wxCheckListBox 💅

okay so this is the Erlang Module Definition page for wxCheckListBox, from the 3erl manual set — yes, the one and only. bestie, it's giving "list box but make it checkable," and I'm obsessed. 🎀✨

🌸 NAME 🌸

wxCheckListBox — Functions for wxCheckListBox class.

🦋 DESCRIPTION 🦋

A wxCheckListBox is like a wxListBox, but it lets items be checked or unchecked. literally the checkbox glow-up. 💖

Windows bestie warning: when you use this class under Windows, wxWidgets must be compiled with wxUSE_OWNER_DRAWN set to 1. no cap, that's required.

See: wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent.

This class is derived (and can use functions) from: wxListBox wxControlWithItems wxControl wxWindow wxEvtHandler — the whole ancestry chain ate. 👑

wxWidgets docs: wxCheckListBox.

✨ EVENTS ✨

Event types emitted from this class: command_checklistbox_toggled — the toggle event, periodt. 🔥

🧚 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() — Constructor, creating and showing a list box. 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()}

• destroy(This :: wxCheckListBox()) -> ok — Destructor, destroying the list box. say bye, bestie. 🫶
• check(This, Item) -> ok — Types:

This = wxCheckListBox()
Item = integer()

• check(This, Item, Options :: [Option]) -> ok — Checks the given item. Types:

This = wxCheckListBox()
Item = integer()
Option = {check, boolean()}

Heads up: calling this method does not result in a wxEVT_CHECKLISTBOX event being emitted. that's the important caveat, okay? 😭

• isChecked(This, Item) -> boolean() — Types:

This = wxCheckListBox()
Item = integer()

Returns true if the given item is checked, false otherwise. simple as that. ✅

later, bestie — wxWidgets team, wx 2.2.2.1, wxCheckListBox(3erl) 💅🫶