wxGridCellBoolEditor(3)

🌸 wxGridCellBoolEditor 💖

okay bestie, welcome to the wxGridCellBoolEditor page — this is the Erlang module definition for it, and yes we are doing this together, hand in hand, because you deserve to understand booleans in grid cells 💅

---

✨ NAME ✨

wxGridCellBoolEditor — the grid cell editor for boolean data. that's it. that's the whole vibe. true/false, on/off, checked/unchecked, iconic behavior only 🎀

---

🌈 DESCRIPTION 🌈

so like, this one's a little social butterfly — it doesn't stand alone, it hangs out with a whole friend group. go look at these too:

• wxGridCellEditor
• wxGridCellChoiceEditor
• wxGridCellFloatEditor
• wxGridCellNumberEditor
• wxGridCellTextEditor

and the family tree moment: this class is derived from, and can use functions from:

• wxGridCellEditor

(so anything wxGridCellEditor can do, this one's lowkey inheriting that energy 🫶)

also, for the full picture, the wxWidgets docs are sitting right here: wxGridCellBoolEditor

---

🦋 DATA TYPES 🦋

okay type girlies, gather round:

wxGridCellBoolEditor() :: wx:wx_object().

that's the type. she's a wx_object() at heart. periodt 💜

---

👑 FUNCTIONS 👑

🌟 destroy/1

destroy(This :: wxGridCellBoolEditor()) -> ok.

literally destroys the object. bye bestie, you served, we're cleaning up 🧹✨ returns ok.

🌟 isTrueValue/1

isTrueValue(Value) -> boolean() when Value :: unicode:chardata().

this one's the vibe check 🔥 it returns true if the value you pass in is equal to the string representation of the truth value we currently use — and "currently use" is doing a lot of work there, so peep useStringValues/1 below if you wanna know what that string actually is 👀

🌟 new/1

new() -> wxGridCellBoolEditor().

the default constructor. no arguments, no drama, just a fresh new editor for you to love and cherish. main character entrance 💖

🌟 useStringValues/1

useStringValues([Option]) -> ok
                            when
                                Option ::
                                    {valueTrue, unicode:chardata()} |
                                    {valueFalse, unicode:chardata()}.

bestie this is the customization station 🎀 it lets you customize the values returned by wxGridCellNumberEditor:getValue/1 for the cell that's using this editor. so like — you get to pick what "true" and "false" actually look like as strings. your grid, your rules.

the options are:

• {valueTrue, unicode:chardata()} — the string you want to stand in for truth
• {valueFalse, unicode:chardata()} — the string you want to stand in for falsehood

by default, the default values of the arguments are used, i.e. "1" is returned if the cell is checked and an empty string otherwise. so yeah, no config = "1" when checked, "" when not. that's the factory setting, no cap 💯

returns ok. slay.

---

that's the whole page bestie, every flag, every type, every function, nothing skipped, nothing invented 🌸 now go forth and edit some boolean cells with confidence, you absolute legend 🦋⭐

mwah 💋 this was written by Ericsson AB, part of the wx 2.6 release, dated in the docs as the wx library docs go — so shoutout to them, and shoutout to you for reading the whole thing. no notes, only love 💜✨