gui.setCheckBoxState

Ticks, unticks, or sets a checkbox to an intermediate state.

Prototype

  1. bOk = gui.setCheckBoxState ( hComponent, kCheckState )

Description

Check the checkbox state constants for more info.


Parameters

hComponent - valid GUI checkbox handle
kCheckState - predefined checkbox state constant


Return values

bOk - true on success


Sample

  1. if ( hComponentSourceFilesGenerate ) then
  2. gui.setCheckBoxState ( hComponentSourceFilesGenerate, bSourceFilesGenerate and gui.kCheckStateOn or gui.kCheckStateOff )
  3. end

Available since ShiVa 2.0