Product Documentation
Virtuoso Layout Suite SKILL Reference
Product Version IC23.1, November 2023

mbSetContextData

mbSetContextData(
t_viewType
t_uniqueId
t_validObjs
t_validWidgets
t_grouping
[ ?parent t_parent ]
[ ?removeWhenDisabled g_removeWhenDisabled ]
)
=> t / nil

Description

Sets various attributes to determine the menus with which the registered action is to be associated.

Arguments

t_viewType

Name of the view type for which this action has been registered.

Valid Values:

Schematic: schematic, schematicXL, analogArtist-schematic, adexl-schematic, adegxl-schematic, hman-schematic, amsArtist-schematic, mixedSignalArtist-schematic, ncVlogSchematic, spectre-schematic, other-schematic, UltraSim-schematic, VHDLToolbox, verilog, schematicInteractive, mspsSchematicApplication

Layout: maskLayout, maskLayoutParamCell, maskLayoutXL, maskLayoutGXL, maskLayoutCE, analogArtist-maskLayout, adexl-maskLayout, adegxl-maskLayout, other-maskLayout, spectre-maskLayout, UltraSim-maskLayout, maskLayoutIQView, parasitics-MaskLayout, verilogMaskLayout, maskLayoutVSA

t_uniqueId

Unique ID to reference the action

t_validObjs

Space separated list of objects for which the action is valid

Valid Values: Instance, Net, Shape, Pin, Via, Group, Clone, Modgen, Ruler, Marker, FGuardRing, None, Pcell, Ungenerated, Boundary, Blockage, Row, Mosaic, ModInst, RowRegion, Any

Here you specify:

Any , if the menu item is needed for all objects.

Ungenerated, if an instance or pin is in the schematic, but not currently in the layout. These items are selectable only in the navigator and so it is the only place where you can access the menu for them.

Modgen, for the group of objects created with the Module Generator tool.

None, to display the item when nothing is selected.

t_validWidgets

Space separated list of widgets for which the action is valid

Valid Values: Canvas and Navigator

t_grouping

Name of the group of menu items in which the registered action is to appear.

Valid Values: Create, Edit, Hierarchy, Groups, ObjSpecific, Secondary, Common, Constraints, and Properties

?parent t_parent

Name of the parent menu if this action is to be part of a hierarchical menu. The parent menu should already be registered.

?removeWhenDisabled g_removeWhenDisabled

When t, this argument removes the action instead of graying it out when disabled.

Values Returned

t

Returned when the context data is successfully set.

nil

Returned when setting of the context data fails.

Example

Adds a new function to the via shortcut menu:

mbRegisterAction("maskLayout"     "uniqueName"  "Pop-up menu text" "CustomerFunction()" "t")
mbSetContextData("maskLayout"     "uniqueName"  "Via"  "Navigator Canvas" "ObjSpecific")

If the menu item is valid for all objects replace Via in mbSetContextData with Any.


Return to top
 ⠀
X