DOKK / manpages / debian 12 / erlang-manpages / wxListItem.3erl.en

Erlang Module Definition

NAME

wxListItem - Functions for wxListItem class

DESCRIPTION

This class stores information about a wxListCtrl item or column.

wxListItem is a class which contains information about:

The wxListItem object can also contain item-specific colour and font information: for this you need to call one of setTextColour/2, setBackgroundColour/2 or setFont/2 functions on it passing it the colour/font to use. If the colour/font is not specified, the default list control colour/font is used.

See: wxListCtrl

wxWidgets docs: wxListItem

DATA TYPES

wxListItem() = wx:wx_object()

EXPORTS


new() -> wxListItem()

Constructor.


new(Item) -> wxListItem()

Types:

Item = wxListItem()


clear(This) -> ok

Types:

This = wxListItem()

Resets the item state to the default.


getAlign(This) -> wx:wx_enum()

Types:

This = wxListItem()

Returns the alignment for this item.

Can be one of wxLIST_FORMAT_LEFT, wxLIST_FORMAT_RIGHT or wxLIST_FORMAT_CENTRE.


getBackgroundColour(This) -> wx:wx_colour4()

Types:

This = wxListItem()

Returns the background colour for this item.


getColumn(This) -> integer()

Types:

This = wxListItem()

Returns the zero-based column; meaningful only in report mode.


getFont(This) -> wxFont:wxFont()

Types:

This = wxListItem()

Returns the font used to display the item.


getId(This) -> integer()

Types:

This = wxListItem()

Returns the zero-based item position.


getImage(This) -> integer()

Types:

This = wxListItem()

Returns the zero-based index of the image associated with the item into the image list.


getMask(This) -> integer()

Types:

This = wxListItem()

Returns a bit mask indicating which fields of the structure are valid.

Can be any combination of the following values:


getState(This) -> integer()

Types:

This = wxListItem()

Returns a bit field representing the state of the item.

Can be any combination of:


getText(This) -> unicode:charlist()

Types:

This = wxListItem()

Returns the label/header text.


getTextColour(This) -> wx:wx_colour4()

Types:

This = wxListItem()

Returns the text colour.


getWidth(This) -> integer()

Types:

This = wxListItem()

Meaningful only for column headers in report mode.

Returns the column width.


setAlign(This, Align) -> ok

Types:

This = wxListItem()
Align = wx:wx_enum()

Sets the alignment for the item.

See also getAlign/1


setBackgroundColour(This, ColBack) -> ok

Types:

This = wxListItem()
ColBack = wx:wx_colour()

Sets the background colour for the item.


setColumn(This, Col) -> ok

Types:

This = wxListItem()
Col = integer()

Sets the zero-based column.

Meaningful only in report mode.


setFont(This, Font) -> ok

Types:

This = wxListItem()
Font = wxFont:wxFont()

Sets the font for the item.


setId(This, Id) -> ok

Types:

This = wxListItem()
Id = integer()

Sets the zero-based item position.


setImage(This, Image) -> ok

Types:

This = wxListItem()
Image = integer()

Sets the zero-based index of the image associated with the item into the image list.


setMask(This, Mask) -> ok

Types:

This = wxListItem()
Mask = integer()

Sets the mask of valid fields.

See getMask/1.


setState(This, State) -> ok

Types:

This = wxListItem()
State = integer()

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.


setStateMask(This, StateMask) -> ok

Types:

This = wxListItem()
StateMask = integer()

Sets the bitmask that is used to determine which of the state flags are to be set.