wxToggleButton(3erl)

💅 wxToggleButton (3erl) — Erlang Module Definition

okay so bestie, welcome to wxToggleButton — the Erlang module page for the wxToggleButton class, and honestly? it's giving "checkbox but make it fashion." let's get into it 🎀

---

✨ DESCRIPTION ✨

wxToggleButton is a button that stays pressed when you click it. yes, that's the whole vibe. it's a button that commits. 💖

in other words, it is similar to wxCheckBox in functionality but looks like a wxButton. so it does the checkbox thing but serves button looks. icon behavior, honestly.

since wxWidgets version 2.9.0 this control emits an update UI event. periodt. ✨

you can see wxToggleButton in action in page_samples_widgets — go look, it's cute.

see: wxCheckBox, wxButton, wxBitmapToggleButton (not implemented in wx — sad, i know 😭)

this class is derived (and can use functions) from: wxControl wxWindow wxEvtHandler — so it inherited the whole family's powers, main character energy fr fr 👑

wxWidgets docs: wxToggleButton

---

🌸 EVENTS 🌸

event types emitted from this class: command_togglebutton_clicked

like yes, that's the one. that's the event. write it down. 💅

---

🦋 DATA TYPES 🦋

• wxToggleButton() = wx:wx_object() — it's a wx object bestie, that's it, that's the type.

---

✨ EXPORTS ✨ (the good stuff)

💜 new() -> wxToggleButton()

default constructor. no args, no thoughts, just vibes. 🫶

💜 new(Parent, Id, Label) -> wxToggleButton()

types:

Parent = wxWindow:wxWindow()
Id = integer()
Label = unicode:chardata()

💜 new(Parent, Id, Label, Options :: [Option]) -> wxToggleButton()

types:

Parent = wxWindow:wxWindow()
Id = integer()
Label = unicode:chardata()
Option =
    {pos, {X :: integer(), Y :: integer()}} |
    {size, {W :: integer(), H :: integer()}} |
    {style, integer()} |
    {validator, wx:wx_object()}

constructor, creating and showing a toggle button. this is the one where you get to customize — position, size, style, validator, the whole aesthetic ✨

see: create/5, wxValidator (not implemented in wx)

💜 destroy(This :: wxToggleButton()) -> ok

destructor, destroying the toggle button. it's over bestie, say bye 👋💀

💜 create(This, Parent, Id, Label) -> boolean()

types:

This = wxToggleButton()
Parent = wxWindow:wxWindow()
Id = integer()
Label = unicode:chardata()

💜 create(This, Parent, Id, Label, Options :: [Option]) -> boolean()

types:

This = wxToggleButton()
Parent = wxWindow:wxWindow()
Id = integer()
Label = unicode:chardata()
Option =
    {pos, {X :: integer(), Y :: integer()}} |
    {size, {W :: integer(), H :: integer()}} |
    {style, integer()} |
    {validator, wx:wx_object()}

creates the toggle button for two-step construction. the way that this is just the build-later route 😌

see new/4 for details — same options, same energy.

💜 getValue(This) -> boolean()

types:

This = wxToggleButton()

gets the state of the toggle button. a little vibe check, if you will 🔍

return: returns true if it is pressed, false otherwise. simple as that. 🍓

💜 setValue(This, State) -> ok

types:

This = wxToggleButton()
State = boolean()

sets the toggle button to the given state. you pick pressed or not-pressed, and it obeys. 👑

⚠️ heads up bestie — this does not cause a EVT_TOGGLEBUTTON event to be emitted. no event, no notification, nothing. it just... changes. silently. so don't sit there waiting for a callback that's never coming 😭

---

🎀 and that's the whole page!! every flag, every type, every signature — nothing skipped, no cap.

kisses from the wxWidgets team 💖 this was wx 2.2.2.1, mwah, bye bestie!! 🌈✨🦋