wxAuiNotebookEvent(3)

💖 NAME 💖

okay so bestie, meet wxAuiNotebookEvent — it's the class that the events generated by wxAuiNotebook use. that's it, that's the whole vibe ✨

and fr fr, this whole page is the Erlang module definition for it, so if you're living in Erlang land and someone's notebook is being dramatic, this is your girl 🫶

---

🌸 DESCRIPTION 🌸

so, see:

• wxAuiNotebook
• wxBookCtrlEvent

and okay, plot twist, this class is derived, and can use functions, from:

• wxBookCtrlEvent
• wxNotifyEvent
• wxCommandEvent
• wxEvent

like it literally inherited all of their lore, it's giving main character energy 👑

wxWidgets docs: wxAuiNotebookEvent — that's where the C++ side of the family hangs out, iykyk.

🦋 Events 🦋

to subscribe to events of this type, use wxEvtHandler:connect/3 with wxAuiNotebookEventType. that's the move, no cap 💅

---

✨ DATA TYPES ✨

wxAuiNotebook() :: #wxAuiNotebook{}.

wxAuiNotebookEvent() :: wx:wx_object().

wxAuiNotebookEventType() ::
          command_auinotebook_page_close |
          command_auinotebook_page_changed |
          command_auinotebook_page_changing |
          command_auinotebook_button | command_auinotebook_begin_drag |
          command_auinotebook_end_drag |
          command_auinotebook_drag_motion |
          command_auinotebook_allow_dnd |
          command_auinotebook_tab_middle_down |
          command_auinotebook_tab_middle_up |
          command_auinotebook_tab_right_down |
          command_auinotebook_tab_right_up |
          command_auinotebook_page_closed |
          command_auinotebook_drag_done | command_auinotebook_bg_dclick.

look at that little list of atoms, she's long but she's ICONIC — every single one of them is a real event type, don't skip any 🍓

---

🎀 FUNCTIONS 🎀

• getDragSource(This) -> wxAuiNotebook:wxAuiNotebook() — hands you back the notebook that started the drag.

getDragSource(This) -> wxAuiNotebook:wxAuiNotebook()
                          when This :: wxAuiNotebookEvent().

• getOldSelection(This) -> integer() — returns the page that was selected before the change, or wxNOT_FOUND if none was selected.

getOldSelection(This) -> integer()
                          when This :: wxAuiNotebookEvent().

• getSelection(This) -> integer() — returns the currently selected page, or wxNOT_FOUND if none was selected.

getSelection(This) -> integer() when This :: wxAuiNotebookEvent().

⚠️ note bestie: under Windows, getSelection/1 will return the same value as getOldSelection/1 when it's called from the EVT_BOOKCTRL_PAGE_CHANGING handler — and not the page which is going to be selected. so like, don't be surprised, that's just how she behaves there 💀

• setDragSource(This, S) -> ok — sets the drag source.

setDragSource(This, S) -> ok
                        when
                            This :: wxAuiNotebookEvent(),
                            S :: wxAuiNotebook:wxAuiNotebook().

• setOldSelection(This, Page) -> ok — sets the id of the page selected before the change.

setOldSelection(This, Page) -> ok
                          when
                              This :: wxAuiNotebookEvent(),
                              Page :: integer().

• setSelection(This, Page) -> ok — sets the selection member variable.

setSelection(This, Page) -> ok
                       when
                           This :: wxAuiNotebookEvent(),
                           Page :: integer().

---

and that's the whole page, bestie, we ate and left absolutely no crumbs 🌈✨

kisses, this manual page came to you courtesy of Ericsson AB, version wx 2.6 — same wxAuiNotebookEvent(3) energy, just with way better vibes 💅💖🎀