gui.setMenuItemText

Assigns a text label to a menu item.

Prototype

  1. bOk = gui.setMenuItemText ( hMenuItem, sText )

Parameters

hMenuItem - menu item handle
sText - text sting you want to assign

Return values

bOk - true on success

Sample

  1. function onPropertyViewSectionEnvironmentItemRightClicked ( hView, hComponent )
  2.  
  3.     local hMenu = gui.getComponent ( "EnvironmentContextMenu" )
  4.     if ( hMenu ) then
  5.         local hSelectedItem = gui.getTreeSelectedItem ( hComponent, 1 )
  6.         if ( hSelectedItem ) then
  7.             gui.setMenuItemText  ( gui.getMenuItem ( hMenu, "EnvironmentContextMenu.add" ), "Edit..." )
  8.             gui.setMenuItemIcon  ( gui.getMenuItem ( hMenu, "EnvironmentContextMenu.add" ), gui.getIcon ( "Edit" ) )
  9.             gui.setMenuItemState ( gui.getMenuItem ( hMenu, "EnvironmentContextMenu.remove" ), gui.kMenuItemStateDisabled, false )
  10.         else
  11.             gui.setMenuItemText  ( gui.getMenuItem ( hMenu, "EnvironmentContextMenu.add" ), "Add..." )
  12.             gui.setMenuItemIcon  ( gui.getMenuItem ( hMenu, "EnvironmentContextMenu.add" ), gui.getIcon ( "Add" ) )
  13.             gui.setMenuItemState ( gui.getMenuItem ( hMenu, "EnvironmentContextMenu.remove" ), gui.kMenuItemStateDisabled, true )
  14.         end
  15.         -- Pop menu
  16.         local x, y = gui.getMousePosition ( ) 
  17.         gui.popMenu ( hMenu, true, x , y ) 
  18.     end         
  19. end

Available since ShiVa 2.0