gui.addCurrentModuleTrayComponent

Adds a component to the ShiVa tray.

Prototype

  1. bOk = gui.addCurrentModuleTrayComponent ( hTrayComponent, hTooltipComponent, hClickedComponent )

Description

The tray is the small info bar the very bottom of the editor window.

Parameters

hTrayComponent - handle to component you want to set into the tray
hTooltipComponent - handle to tooltip component you want to set into the tray
hClickedComponent - handle to component you want to set into the tray that handles your clicked events

Return values

bOk - true on success

Sample

  1. --create Tray Icons
  2. local hTrayButton = gui.instantiate ( "com.shiva.editor.log.lib", "TrayButton", "TrayButtonMessage" ) 
  3. local hItem       = gui.instantiate ( "com.shiva.editor.log.lib", "CategoryTemplate", "TrayMessage" )
  4.  
  5. gui.setPushButtonIcon               ( hTrayButton, hLogMessageIcon )     
  6. gui.setPushButtonText               ( hTrayButton, "0" )     
  7. gui.addCurrentModuleTrayComponent   ( hTrayButton, hItem, hItem )  
  8. gui.setComponentVisible             ( hTrayButton, true )

Available since ShiVa 2.0