wxSetCursorEvent(3erl)

🎀 wxSetCursorEvent(3erl) — Erlang Module Definition 🎀

okay bestie, welcome to wxSetCursorEvent from the Erlang Module Definition manual — yes, the manual name is literally right there, folded in like a cute little label. This page is all about the wxSetCursorEvent class and its functions. Footer vibes at the very bottom: wxWidgets team, wx 2.2.2.1, and the page tag wxSetCursorEvent(3erl). 💖

---

🌸 NAME 🌸

wxSetCursorEvent — Functions for wxSetCursorEvent class. periodt.

✨ DESCRIPTION ✨

A wxSetCursorEvent gets generated from wxWindow when the mouse cursor is about to be set as a result of mouse motion. it's giving "cursor about to change" energy, lowkey.

This event gives the application the chance to do specific mouse cursor processing based on where the mouse currently is inside the window. Use setCursor/2 to specify the cursor you want displayed, no cap.

See: wx_misc:setCursor/1, wxWindow:setCursor/2 — those are the related besties.

This class is derived (and can use functions) from: wxEvent — so it's got that inherited main character energy.

wxWidgets docs: wxSetCursorEvent — the docs page is literally right there, iykyk.

🦋 EVENTS 🦋

Use wxEvtHandler:connect/3 with wxSetCursorEventType to subscribe to events of this type. that's the whole vibe check.

🌈 DATA TYPES 🌈

here are the types, bestie — copy them exactly:

wxSetCursorEvent() = wx:wx_object()

wxSetCursor() =
    #wxSetCursor{type = wxSetCursorEvent:wxSetCursorEventType(),
                 x = integer(),
                 y = integer(),
                 cursor = wxCursor:wxCursor()}

wxSetCursorEventType() = set_cursor

👑 EXPORTS 👑

💖 getCursor(This) -> wxCursor:wxCursor()

Types:

This = wxSetCursorEvent()

Returns a reference to the cursor specified by this event. a reference, not a whole new cursor, okay? obsessed.

🦋 getX(This) -> integer()

Types:

This = wxSetCursorEvent()

Returns the X coordinate of the mouse in client coordinates. X marks the spot, fr fr.

🌸 getY(This) -> integer()

Types:

This = wxSetCursorEvent()

Returns the Y coordinate of the mouse in client coordinates. vertical bestie, slay.

🎀 hasCursor(This) -> boolean()

Types:

This = wxSetCursorEvent()

Returns true if the cursor specified by this event is a valid cursor. boolean moment.

⚠️ Remark: You cannot specify wxNullCursor with this event, as it is not considered a valid cursor. so don't try it, bestie — wxNullCursor is not invited to this party. 💀

✨ setCursor(This, Cursor) -> ok

Types:

This = wxSetCursorEvent()
Cursor = wxCursor:wxCursor()

Sets the cursor associated with this event. that's it. that's the function. iconic.

---

and that's the page, bestie! footer source/version: wxWidgets team, wx 2.2.2.1, page tag wxSetCursorEvent(3erl) — no date printed in the footer, so we're not inventing one, periodt. 💅✨