wxNavigationKeyEvent(3)

💖 wxNavigationKeyEvent 💖

okay bestie, welcome to wxNavigationKeyEvent(3) — an Erlang Module Definition from the wx manual, and yes it's giving "I'm the plumbing that makes your Tab key actually do something" energy. Sit down, grab a strawberry 🍓, we're doing this.

---

✨ NAME ✨

wxNavigationKeyEvent — this event class contains information about navigation events, generated by navigation keys such as tab and page down. 👑

---

🦋 DESCRIPTION 🦋

This event is mainly used by wxWidgets implementations, fr fr. A wxNavigationKeyEvent handler is automatically provided by wxWidgets when you enable keyboard navigation inside a window by inheriting it from wxNavigationEnabled<>. Like, it shows up already dressed and ready, you don't gotta do anything. ✨

See: wxWindow:navigate/2

This class is derived, and can use functions, from:

• wxEvent

wxWidgets docs: wxNavigationKeyEvent

🌈 Events 🌈

Use wxEvtHandler:connect/3 with wxNavigationKeyEventType to subscribe to events of this type. That's your group chat invite right there, no cap. 💌

---

🎀 DATA TYPES 🎀

• wxNavigationKey() :: #wxNavigationKey{}.
• wxNavigationKeyEvent() :: wx:wx_object().
• wxNavigationKeyEventType() :: navigation_key.

---

💅 FUNCTIONS 💅

• getCurrentFocus(This) -> wxWindow:wxWindow() when This :: wxNavigationKeyEvent().

Returns the child that has the focus, or NULL. Or NULL — not me getting nothing back and having a whole breakdown about it 😭

• getDirection(This) -> boolean() when This :: wxNavigationKeyEvent().

Returns true if the navigation was in the forward direction. Forward = slay. Backward = also fine, we don't judge. 🫶

• isFromTab(This) -> boolean() when This :: wxNavigationKeyEvent().

Returns true if the navigation event was from a tab key.

This is required for proper navigation over radio buttons. (Radio buttons are lowkey the drama queens of UI widgets, they need this info to behave.) 🎀

• isWindowChange(This) -> boolean() when This :: wxNavigationKeyEvent().

Returns true if the navigation event represents a window change (for example, from Ctrl-Page Down in a notebook). Different window, different vibe, we gotta know. 🌸

• setCurrentFocus(This, CurrentFocus) -> ok when This :: wxNavigationKeyEvent(), CurrentFocus :: wxWindow:wxWindow().

Sets the current focus window member. Boom, focus assigned, main character crowned. 👑

• setDirection(This, Direction) -> ok when This :: wxNavigationKeyEvent(), Direction :: boolean().

Sets the direction to forward if direction is true, or backward if false. Two options, pick your fighter. 🔥

• setFromTab(This, FromTab) -> ok when This :: wxNavigationKeyEvent(), FromTab :: boolean().

Marks the navigation event as from a tab key. Tag it, bestie. 🏷️

• setWindowChange(This, WindowChange) -> ok when This :: wxNavigationKeyEvent(), WindowChange :: boolean().

Marks the event as a window change event. Announce it to the whole server, periodt. 📢

---

And that's the whole page, no crumbs left over. 🧚 This lil masterpiece is brought to you by Ericsson AB, straight out of wx 2.6, dated wxNavigationKeyEvent(3) — so like, iconic source, iconic version, and honestly? The date is giving "been here, still slaying." Byeee, go build something cute with it 💜