wxListEvent(3)

💖 wxListEvent 💖

okay bestie, welcome to wxListEvent — the Erlang module definition, brought to you by the fine folks at Ericsson AB on wx 2.6. let's get into it 🦋

✨ NAME ✨

wxListEvent — a list event holds information about events associated with wxListCtrl objects. that's it, that's the vibe. 🎀

---

🌸 DESCRIPTION 🌸

see also: wxListCtrl 👑

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

• wxNotifyEvent
• wxCommandEvent
• wxEvent

wxWidgets docs: wxListEvent 📚

🫶 Events

use wxEvtHandler:connect/3 with wxListEventType to subscribe to events of this type. fr fr, that's how you get on the list. 💅

---

⭐ DATA TYPES ⭐

• wxList() :: #wxList{}.
• wxListEvent() :: wx:wx_object().
• wxListEventType() :: with all these iconic little atoms:

command_list_begin_drag | command_list_begin_rdrag |
command_list_begin_label_edit | command_list_end_label_edit |
command_list_delete_item | command_list_delete_all_items |
command_list_key_down | command_list_insert_item |
command_list_col_click | command_list_col_right_click |
command_list_col_begin_drag | command_list_col_dragging |
command_list_col_end_drag | command_list_item_selected |
command_list_item_deselected | command_list_item_right_click |
command_list_item_middle_click | command_list_item_activated |
command_list_item_focused | command_list_cache_hint.

---

🔥 FUNCTIONS 🔥

• getCacheFrom(This) -> integer() when This :: wxListEvent().

for EVT_LIST_CACHE_HINT event only: return the first item which the list control advises us to cache. lowkey a lil hint from the list control, take it bestie ✨

• getCacheTo(This) -> integer() when This :: wxListEvent().

for EVT_LIST_CACHE_HINT event only: return the last item (inclusive, no that's not a typo, it's inclusive) which the list control advises us to cache. 🍓

• getColumn(This) -> integer() when This :: wxListEvent().

the column position: it is only used with COL events. 💅

for the column dragging events, it is the column to the left of the divider being dragged. for the column click events it may be -1 if the user clicked in the list control header outside any column. yes, -1, the void, the nothing-column. 😭

• getData(This) -> integer() when This :: wxListEvent().

the data. short and sweet, periodt. 💖

• getImage(This) -> integer() when This :: wxListEvent().

the image. 🎀

• getIndex(This) -> integer() when This :: wxListEvent().

the item index. go off. ✨

• getItem(This) -> wxListItem:wxListItem() when This :: wxListEvent().

an item object, used by some events. 🙈

see also wxListCtrl:setItem/5.

• getKeyCode(This) -> integer() when This :: wxListEvent().

key code if the event is a keypress event. keyboard moment. ⌨️

• getLabel(This) -> unicode:charlist() when This :: wxListEvent().

the (new) item label for EVT_LIST_END_LABEL_EDIT event. 🏷️

• getMask(This) -> integer() when This :: wxListEvent().

the mask. slay. 🎭

• getPoint(This) -> {X :: integer(), Y :: integer()} when This :: wxListEvent().

the position of the mouse pointer if the event is a drag event. where the cursor at, bestie 🖱️

• getText(This) -> unicode:charlist() when This :: wxListEvent().

the text. 💬

• isEditCancelled(This) -> boolean() when This :: wxListEvent().

this method only makes sense for EVT_LIST_END_LABEL_EDIT message and returns true if it the label editing has been cancelled by the user (getLabel/1 returns an empty string in this case but it doesn't allow the application to distinguish between really cancelling the edit and the admittedly rare case when the user wants to rename it to an empty string). 😭 the empty-string ambiguity is real and the manpage said what it said.

not me giving you the exact same caveat the original gave you, because the facts stay facts even when the vibe is immaculate. 💀

---

and that's the whole page, bestie — every flag, every return type, every atom, all of it, no cap. this was Ericsson AB, wx 2.6, wxListEvent(3), and you officially know it now. go be the main character of your own list control. 💅👑🦋