gui.getListSelectedItem

Returns a handle to a selected list item.

Prototype

  1. hListItem = gui.getListSelectedItem ( hComponent, [nIndex] )

Description

nIndex differentiates the items in case of multiple selections.


Parameters

hComponent - valid GUI component handle
nIndex - optional index number 1..nCount for multiple selections


Return values

hListItem - handle to the selected item


Sample

  1. for i = 1, gui.getListSelectedItemCount ( hList ) do
  2. local hItem = gui.getListSelectedItem ( hList, i )
  3. if ( hItem ) then
  4. -- do stuff

Available since ShiVa 2.0