gui.setMenuItemData

Attaches various data to a menu item.

Prototype

  1. bOk = gui.setMenuItemData ( hMenuItem, vValue, kDataRole )

Description

Please check the predefined data role constants for more info.


Parameters

hMenuItem - menu item handle
vValue - data you want to attach (various)
kDataRole - predefined data role constant


Return values

bOk - true on success


Sample

  1. local hItem = gui.appendMenuItem ( hOpenWithMenu, gui.getComponentIdentifier ( hOpenWithMenu )..".openWith."..sViewControllerName )
  2. if ( hItem ) then
  3. gui.setMenuItemData ( hItem, gui.kDataRoleDisplay, sViewControllerName )
  4. gui.setMenuItemData ( hItem, gui.kDataRoleDecoration, gui.getViewControllerIcon ( hViewController ) )
  5. gui.setMenuItemData ( hItem, gui.kDataRoleUser, tOrderedDesktops[ nDesktop ] )
  6. gui.setMenuItemData ( hItem, gui.kDataRoleUser + 1, hFile )
  7. end
  8. -- etc.

Available since ShiVa 2.0