ListWidget::UnselectListItem

Defined in: C4Widgets.h

Unselects an item in a list.

Prototype

void UnselectListItem(int32 index, bool post = false);

Parameters

`index`	The index of the item to unselect.
`post`	Indicates whether to post a `kEventWidgetChange` event.

Description

The UnselectListItem function unselects the list item whose zero-based index is specified by the index parameter. If the index parameter is not in the range [0, n − 1], where n is the number of items in the list, then no change to the current selection is made.

If the post parameter is true and a change was actually made to the selection, then the list widget posts a kEventWidgetChange event that can be handled by its observers.