wxAuiManagerEvent(3)

💖 wxAuiManagerEvent 💖

okay so bestie, welcome to wxAuiManagerEvent — it's an Erlang module, and it's literally the event that shows up to tell you about all the cute little things happening with your wxAuiManager. think of it as the group chat notifications of your GUI panel drama. 🌸

---

✨ NAME ✨

wxAuiManagerEvent — the event used to indicate the various actions taken with wxAuiManager. periodt. 💅

---

🦋 DESCRIPTION 🦋

if you wanna know which event types you can vibe with, go look at wxAuiManager. that's where the tea is. ☕

also go peek at:

• wxAuiManager
• wxAuiPaneInfo

this class is derived from its ancestors, and can use functions from:

• wxEvent

and if you want the full lore, the wxWidgets docs live at: wxAuiManagerEvent 📚

🌈 Events

to subscribe to events of this type, you call wxEvtHandler:connect/3 and pass in a wxAuiManagerEventType. that's the whole vibe check. ✨

---

🎀 DATA TYPES 🎀

• wxAuiManager() :: #wxAuiManager{}.
• wxAuiManagerEvent() :: wx:wx_object().
• wxAuiManagerEventType() ::

aui_pane_button | aui_pane_close | aui_pane_maximize |
aui_pane_restore | aui_pane_activated | aui_render |
aui_find_manager.

---

👑 FUNCTIONS 👑

• canVeto(This) -> boolean() when This :: wxAuiManagerEvent()

returns true if this event can be vetoed. like, is it even allowed to get cancelled? 🤔

See: veto/2

• getButton(This) -> integer() when This :: wxAuiManagerEvent()

returns the ID of the button that got clicked. which one was it bestie 👀

• getDC(This) -> wxDC:wxDC() when This :: wxAuiManagerEvent()

hands you the DC. no notes. 🖌️

• getManager(This) -> wxAuiManager:wxAuiManager() when This :: wxAuiManagerEvent()

returns the wxAuiManager this event is associated with. it's giving "who's your manager" energy. 💼

• getPane(This) -> wxAuiPaneInfo:wxAuiPaneInfo() when This :: wxAuiManagerEvent()

returns the pane this event is associated with. the pane is the main character here fr fr. 🪟

• getVeto(This) -> boolean() when This :: wxAuiManagerEvent()

returns true if this event was vetoed. so it did get cancelled, okay. 😭

See: veto/2

• setButton(This, Button) -> ok when This :: wxAuiManagerEvent(), Button :: integer()

sets the ID of the button clicked that triggered this event. assigning the blame, basically. 🫶

• setCanVeto(This, Can_veto) -> ok when This :: wxAuiManagerEvent(), Can_veto :: boolean()

sets whether or not this event can be vetoed. so you're deciding in advance if the veto button is even unlocked. 🔓

• setDC(This, Pdc) -> ok when This :: wxAuiManagerEvent(), Pdc :: wxDC:wxDC()

sets the DC. slay. 🎨

• setManager(This, Manager) -> ok when This :: wxAuiManagerEvent(), Manager :: wxAuiManager:wxAuiManager()

sets the wxAuiManager this event is associated with. ✨

• setPane(This, Pane) -> ok when This :: wxAuiManagerEvent(), Pane :: wxAuiPaneInfo:wxAuiPaneInfo()

sets the pane this event is associated with. 🪟💖

• veto(This, [Option]) -> ok when This :: wxAuiManagerEvent(), Option :: {veto, boolean()}

cancels the action indicated by this event — but ONLY if canVeto/1 is true. no cap, if you can't veto it, this does nothing for you. 💀

⚠️ heads up bestie: veto/2 is gated behind canVeto/1. check it first or you're just yelling into the void. 🌸

---

and that's the whole page, gorgeous. this was brought to you by Ericsson AB, wx 2.6, dated wxAuiManagerEvent(3). mwah, go build something iconic 💅✨🎀