TableWidget::SelectTableItem

Defined in: C4Widgets.h

Selects an item in a table.

Prototype

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

Parameters

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

Description

The SelectTableItem function selects the table 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 table, then no new selection is made.

If the kTableMultipleSelection is not set for the table widget, then all table items having an index other than that specified by the index parameter are unselected. In the case that the index is out of range, this means that all of the table items are unselected.

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