wxListView(3erl)

💖 NAME 💖

wxListView — functions for the wxListView class, and welcome to the wxListView(3erl) page (Erlang Module Definition energy, bestie ✨).

---

🦋 DESCRIPTION 🦋

Okay so this class currently simply presents a simpler to use interface for wxListCtrl — literally think of it as a façade for that complicated class. 🎀

Using it is preferable to using wxListCtrl directly whenever possible because in the future some ports might implement wxListView but not the full set of wxListCtrl features. Future-proofing vibes, no cap.

Other than different interface, this class is identical to wxListCtrl. In particular, it uses the same events, same window styles and so on. Same energy, different wrapper, iykyk. 💅

See: setColumnImage/3

This class is derived (and can use functions) from: wxControl wxWindow wxEvtHandler

wxWidgets docs: wxListView

---

🌈 DATA TYPES 🌈

wxListView() = wx:wx_object()

That's the whole type, bestie — no extra shape, no cap. 💜

---

👑 EXPORTS 👑

✨ clearColumnImage(This, Col) -> ok ✨

Types:

This = wxListView()
Col = integer()

Resets the column image — after calling this function, no image will be shown, periodt. 🫶

See: setColumnImage/3

🌸 focus(This, Index) -> ok 🌸

Types:

This = wxListView()
Index = integer()

Sets focus to the item with the given index. Main character item energy. 👑

🎀 getFirstSelected(This) -> integer() 🎀

Types:

This = wxListView()

Returns the first selected item in a (presumably) multiple selection control.

Together with getNextSelected/2 it can be used to iterate over all selected items in the control.

Return: the first selected item, if any, -1 otherwise.

🦋 getFocusedItem(This) -> integer() 🦋

Types:

This = wxListView()

Returns the currently focused item or -1 if none.

See: isSelected/2, focus/2

🍓 getNextSelected(This, Item) -> integer() 🍓

Types:

This = wxListView()
Item = integer()

Used together with getFirstSelected/1 to iterate over all selected items in the control.

Return: returns the next selected item or -1 if there are no more of them.

🧚 isSelected(This, Index) -> boolean() 🧚

Types:

This = wxListView()
Index = integer()

Returns true if the item with the given index is selected, false otherwise.

See: getFirstSelected/1, getNextSelected/2

💀 select(This, N) -> ok 💀

Types:

This = wxListView()
N = integer()

🔥 select(This, N, Options :: [Option]) -> ok 🔥

Types:

This = wxListView()
N = integer()
Option = {on, boolean()}

Selects or unselects the given item.

Notice that this method inherits the unusual behaviour of wxListCtrl:setItemState/4 which sends a wxEVT_LIST_ITEM_SELECTED event when it is used to select an item, contrary to the usual rule that only the user actions result in selection.

💅 setColumnImage(This, Col, Image) -> ok 💅

Types:

This = wxListView()
Col = Image = integer()

Sets the column image for the specified column.

To use the column images, the control must have a valid image list with at least one image. Iconic, but valid image list required, bestie. 🌟

---

Biggest hugs to the wxWidgets team 💖 — source/version: wx 2.2.2.1, with the wxListView(3erl) footer tag. No separate date is listed in the footer, so I'm not inventing one, no cap. Periodt. 🫶✨