wxListItem(3erl)

💖 NAME 💖

wxListItem — Functions for wxListItem class. This is the Erlang module definition page for wxListItem, aka wxListItem(3erl), and she is literally here to explain the class. 💅

✨ DESCRIPTION ✨

This class stores info about a wxListCtrl item or column. Lowkey that's the whole vibe.

The page says wxListItem is a class which contains information about: … and then the list itself is just not here in this copy, so I'm not inventing bullets — no cap.

The wxListItem object can also carry item-specific colour and font info. For that, you call one of setTextColour/2, setBackgroundColour/2, or setFont/2 on it and pass in the colour/font to use. If the colour/font is not specified, the default list control colour/font is used. Slay.

See: wxListCtrl

wxWidgets docs: wxListItem

---

🦋 DATA TYPES 🦋

wxListItem() = wx:wx_object()

That's the type, bestie. 🎀

🌈 EXPORTS 🌈

Okay here's the full roster — every function keeps her exact signature, no merging, no skipping.

• new() -> wxListItem() — Constructor. ✨
• new(Item) -> wxListItem() — Types: Item = wxListItem().
• clear(This) -> ok — Resets the item state to the default.
  • Types: This = wxListItem()
• getAlign(This) -> wx:wx_enum() — Returns the alignment for this item.
  • Types: This = wxListItem()
  • Can be one of wxLIST_FORMAT_LEFT, wxLIST_FORMAT_RIGHT, or wxLIST_FORMAT_CENTRE.
• getBackgroundColour(This) -> wx:wx_colour4() — Returns the background colour for this item.
  • Types: This = wxListItem()
• getColumn(This) -> integer() — Returns the zero-based column; meaningful only in report mode.
  • Types: This = wxListItem()
• getFont(This) -> wxFont:wxFont() — Returns the font used to display the item.
  • Types: This = wxListItem()
• getId(This) -> integer() — Returns the zero-based item position.
  • Types: This = wxListItem()
• getImage(This) -> integer() — Returns the zero-based index of the image associated with the item into the image list.
  • Types: This = wxListItem()
• getMask(This) -> integer() — Returns a bit mask indicating which fields of the structure are valid.
  • Types: This = wxListItem()
  • Can be any combination of the following values: — and the actual value list isn't in this copy, so no invented flags, periodt.
• getState(This) -> integer() — Returns a bit field representing the state of the item.
  • Types: This = wxListItem()
  • Can be any combination of: — again, the list is missing here in this copy, so I'm not making up state flags, bestie.
• getText(This) -> unicode:charlist() — Returns the label/header text.
  • Types: This = wxListItem()
• getTextColour(This) -> wx:wx_colour4() — Returns the text colour.
  • Types: This = wxListItem()
• getWidth(This) -> integer() — Meaningful only for column headers in report mode. Returns the column width.
  • Types: This = wxListItem()
• setAlign(This, Align) -> ok — Sets the alignment for the item. See also getAlign/1.
  • Types: This = wxListItem(), Align = wx:wx_enum()
• setBackgroundColour(This, ColBack) -> ok — Sets the background colour for the item.
  • Types: This = wxListItem(), ColBack = wx:wx_colour()
• setColumn(This, Col) -> ok — Sets the zero-based column. Meaningful only in report mode.
  • Types: This = wxListItem(), Col = integer()
• setFont(This, Font) -> ok — Sets the font for the item.
  • Types: This = wxListItem(), Font = wxFont:wxFont()
• setId(This, Id) -> ok — Sets the zero-based item position.
  • Types: This = wxListItem(), Id = integer()
• setImage(This, Image) -> ok — Sets the zero-based index of the image associated with the item into the image list.
  • Types: This = wxListItem(), Image = integer()
• setMask(This, Mask) -> ok — Sets the mask of valid fields. See getMask/1.
  • Types: This = wxListItem(), Mask = integer()
• setState(This, State) -> ok — Sets the item state flags. Note that the valid state flags are influenced by the value of the state mask, see setStateMask/2. See getState/1 for valid flag values.
  • Types: This = wxListItem(), State = integer()
• setStateMask(This, StateMask) -> ok — Sets the bitmask that is used to determine which of the state flags are to be set. See also setState/2.
  • Types: This = wxListItem(), StateMask = integer()
• setText(This, Text) -> ok — Sets the text label for the item.
  • Types: This = wxListItem(), Text = unicode:chardata()
• setTextColour(This, ColText) -> ok — Sets the text colour for the item.
  • Types: This = wxListItem(), ColText = wx:wx_colour()
• setWidth(This, Width) -> ok — Meaningful only for column headers in report mode. Sets the column width.
  • Types: This = wxListItem(), Width = integer()
• destroy(This :: wxListItem()) -> ok — Destroys the object. 💀

---

Bye bestie! This page was brought to you by the wxWidgets team, version wx 2.2.2.1, and the footer tag wxListItem(3erl). 🫶💅 No date in sight in that footer, just so you know.