gui.enableListSort

Enable/disable sorting on a list component.

Prototype

bOk = gui.enableListSort ( hComponent, bEnable )

Description

Before doing time-consuming work on a list, it is recommended that you disable this feature before the operation and then turn it back on at the end.

Parameters

hComponent - valid GUI component handle
bEnable - true to enable, false to disable

Return values

bOk - true on success

Sample

function buildMainViewFileListThumbnails ( _hList, kFileType )
 
    local hList = _hList or gui.getComponent ( "MainView.list.thumbnails" )
    if ( hList ) then
 
        -- disable
        gui.enableListFilter             ( hList, false )   
        gui.enableListSort               ( hList, false ) 
        gui.setComponentUpdatesEnabled   ( hList, false ) 
 
        -- do stuff [...]
 
        -- now re-enable
        gui.enableListFilter             ( hList, true )  
        gui.enableListSort               ( hList, true )  
        gui.setComponentUpdatesEnabled   ( hList, true ) 
    end
end 

Available since ShiVa 2.0