wxNavigationKeyEvent(3erl)

🦋 wxNavigationKeyEvent(3erl) — Erlang Module Definition 🦋

---

✨ NAME ✨

wxNavigationKeyEvent — Functions for the wxNavigationKeyEvent class. okay bestie, this is the wxNavigationKeyEvent(3erl) manual page, and we're about to make navigation events make sense. periodt. 💅

🌸 DESCRIPTION 🌸

So this event class? It literally contains information about navigation events — the kind generated by navigation keys such as tab and page down. keyboard movement rights! ✨

This event is mainly used by wxWidgets implementations. A wxNavigationKeyEvent handler is automatically provided by wxWidgets when you enable keyboard navigation inside a window by inheriting it from wxNavigationEnabled<>. The way that just happens for you is iconic, ngl. 🎀

See: wxWindow:navigate/2, wxWindow::NavigateIn (not implemented in wx). 👀

This class is derived (and can use functions) from: wxEvent. family tree moment. 🌈

wxWidgets docs: wxNavigationKeyEvent. iykyk. 📚

🔥 EVENTS 🔥

Use wxEvtHandler:connect/3 with wxNavigationKeyEventType to subscribe to events of this type. That's your group-chat invite, bestie — accept it. 💌

🧚 DATA TYPES 🧚

wxNavigationKeyEvent()

wxNavigationKeyEvent() = wx:wx_object()

wxNavigationKey()

wxNavigationKey() =
    #wxNavigationKey{type =
                         wxNavigationKeyEvent:wxNavigationKeyEventType(),
                     dir = boolean(),
                     focus = wxWindow:wxWindow()}

wxNavigationKeyEventType()

wxNavigationKeyEventType() = navigation_key

👑 EXPORTS 👑

getDirection(This) -> boolean()

Types:

• This = wxNavigationKeyEvent()

Returns true if the navigation was in the forward direction. Forward means forward, bestie. ✨

setDirection(This, Direction) -> ok

Types:

• This = wxNavigationKeyEvent()
• Direction = boolean()

Sets the direction to forward if Direction is true, or backward if false. direction vibe check passed. ✅

isWindowChange(This) -> boolean()

Types:

• This = wxNavigationKeyEvent()

Returns true if the navigation event represents a window change (for example, from Ctrl-Page Down in a notebook). big notebook energy. 📓🔥

setWindowChange(This, WindowChange) -> ok

Types:

• This = wxNavigationKeyEvent()
• WindowChange = boolean()

Marks the event as a window change event. Slap that label on it. 🏷️

isFromTab(This) -> boolean()

Types:

• This = wxNavigationKeyEvent()

Returns true if the navigation event was from a tab key. This is required for proper navigation over radio buttons. not me knowing this is exactly why radio buttons behave. 💅

setFromTab(This, FromTab) -> ok

Types:

• This = wxNavigationKeyEvent()
• FromTab = boolean()

Marks the navigation event as from a tab key. Tell the truth, bestie. ✅

getCurrentFocus(This) -> wxWindow:wxWindow()

Types:

• This = wxNavigationKeyEvent()

Returns the child that has the focus, or NULL. Cue the spotlight. 🔦

setCurrentFocus(This, CurrentFocus) -> ok

Types:

• This = wxNavigationKeyEvent()
• CurrentFocus = wxWindow:wxWindow()

Sets the current focus window member. main character focus energy. 👑

---

Later, bestie! 💖 This one's from the wxWidgets team, version wx 2.2.2.1, and the footer stamp is wxNavigationKeyEvent(3erl) — that's the source/version/date info we got, no cap. 🫶