wxFocusEvent(3erl)

💅 wxFocusEvent (like, the Erlang module definition bestie)

okay so welcome to wxFocusEvent, the Erlang module that's literally all about the wxFocusEvent class ✨ — and it's giving "glow up for your windows" energy, because it's all about focus. 🎀

---

🌸 DESCRIPTION 🌸

A focus event gets sent when a window's focus changes, periodt. The window that's losing focus receives a "kill focus" event, while the window gaining it gets a "set focus" one. 💀➡️👑

Notice — and this is lowkey important — the set focus event happens both when the user gives focus to the window (whether that's with the mouse or the keyboard) and when it's done from the program itself using wxWindow:setFocus/1. So like, no cap, both paths fire it. 🫶

The focus event handlers should almost invariably call wxEvent:skip/2 on their event argument to allow the default handling to take place. Not doing this may result in incorrect behaviour of the native controls, and we do NOT want that vibe. 😭 Also note that a wxEVT_KILL_FOCUS handler must not call wxWindow:setFocus/1 — again, because it's not supported by all native controls. If you need to do this, consider using the Delayed Action Mechanism (not implemented in wx) described in the wxIdleEvent documentation.

fr fr, read that warning twice. The native controls are dramatic and will act out. 💅

See: Overview events

This class is derived (and can use functions) from: wxEvent

wxWidgets docs: wxFocusEvent

---

⭐ EVENTS ⭐

Use wxEvtHandler:connect/3 with wxFocusEventType to subscribe to events of this type. Slay, that's it, that's the whole vibe check. 🦋

---

🧚 DATA TYPES 🧚

wxFocusEvent() = wx:wx_object()

wxFocus() =
    #wxFocus{type = wxFocusEvent:wxFocusEventType(),
             win = wxWindow:wxWindow()}

wxFocusEventType() = set_focus | kill_focus

Two types, both iconic, set_focus and kill_focus. 🌈

---

👑 EXPORTS 👑

getWindow(This) -> wxWindow:wxWindow()

Types:

This = wxFocusEvent()

Returns the window associated with this event — that is, the window which had the focus before for the wxEVT_SET_FOCUS event, and the window which is going to receive focus for the wxEVT_KILL_FOCUS one. 🎯

Warning: the window pointer may be NULL! 🙈 Check it, bestie, please check it.

---

and that's the whole page, main character energy complete. 🍓

written by the wxWidgets team · wx 2.2.2.1 · wxFocusEvent(3erl) — mwah, go forth and handle your focus events responsibly 💖✨