diff --git a/docs/user/interface/ListView.dox b/docs/user/interface/ListView.dox index 1cce11c786..bf1c35ab9b 100644 --- a/docs/user/interface/ListView.dox +++ b/docs/user/interface/ListView.dox @@ -911,16 +911,45 @@ /*! \fn int32 BListView::CurrentSelection(int32 index) const - \brief Returns the index of a currently selected item relative to the passed - in \a index. + \brief Returns the index in the list of the \a index'th selected item. - If the index of the selected item is lower than \a index the value returned - is negative, if the index of the selected item is greater than \a index the - value returned is positive. If the index of the selected item is equal to - \a index then 0 is returned. + A negative value is returned when there are not enough selected items. - \param index The \a index of the item to get relative to the selected item's - index. + For example, a list containing the sorted letters of the English alphabet + with the vowels selected would return the following values: + +
| \a index | +value | +
|---|---|
| 0 | +0 (the list index of 'A') | +
| 1 | +4 (the list index of 'E') | +
| 2 | +8 (the list index of 'I') | +
| 3 | +14 (the list index of 'O') | +
| 4 | +20 (the list index of 'U') | +
| 5 | +-1 (no more items are selected) | +