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

mbUnregisterAction

mbUnregisterAction(
t_name
[ ?objTypes t_objTypes ]
[ ?viewType t_viewType ]
[ ?silent g_silent ]
)
=> t / nil

Description

Removes the provided menu item from the RMB menu. The optional arguments can be used to limit the removal of a menu item to specific object types or view types for which it is registered.

Arguments

t_name

Name of the action which is to be removed. The name is the text that appears in the context menu.

?objTypes t_objTypes

Name of the object. Can be provided to limit the removal to a specific type of object, For example, "Instance". Default is "All"

?viewType t_viewType

Name of the view type. Can be provided to specify which viewType the action was registered with. For example. "maskLayout". The default is nil, in which case all viewTypes will be looked at for a matching action.

?silent g_silent

This is a boolean argument. Can be provided to suppress the information messages which are output stating the actions that have been removed. The default is nil.

Values Returned

t

Returned when the menu item has been succesfully removed.

nil

Returned when the menu item has not been succesfully removed.

Example

Removes the Rotate Left command from all shortcut menus:

\i mbUnregisterAction("Rotate Left")
\o INFO (MB-1002): The 'Rotate Left' menu item has been removed from the 'maskLayout' 'Blockage' context menu.
\o INFO (MB-1002): The 'Rotate Left' menu item has been removed from the 'maskLayout' 'Boundary' context menu.
\o INFO (MB-1002): The 'Rotate Left' menu item has been removed from the 'maskLayout' 'Clone' context menu.
\o INFO (MB-1002): The 'Rotate Left' menu item has been removed from the 'maskLayout' 'Group' context menu.
\o INFO (MB-1002): The 'Rotate Left' menu item has been removed from the 'maskLayout' 'Instance' context menu.
\o INFO (MB-1002): The 'Rotate Left' menu item has been removed from the 'maskLayout' 'Modgen' context menu.
\o INFO (MB-1002): The 'Rotate Left' menu item has been removed from the 'maskLayout' 'Mosaic' context menu.
\o INFO (MB-1002): The 'Rotate Left' menu item has been removed from the 'maskLayout' 'None' context menu.
\o INFO (MB-1002): The 'Rotate Left' menu item has been removed from the 'maskLayout' 'Pin' context menu.
\o INFO (MB-1002): The 'Rotate Left' menu item has been removed from the 'maskLayout' 'Row' context menu.
\o INFO (MB-1002): The 'Rotate Left' menu item has been removed from the 'maskLayout' 'Ruler' context menu.
\o INFO (MB-1002): The 'Rotate Left' menu item has been removed from the 'maskLayout' 'Shape' context menu.
\o INFO (MB-1002): The 'Rotate Left' menu item has been removed from the 'maskLayout' 'Via' context menu.
\t t
\p > 

Removes the Rotate Left action and limit by object type:

\i mbUnregisterAction("Rotate Left" ?objTypes "Instance Mosaic Group")
\o INFO (MB-1002): The 'Rotate Left' menu item has been removed from the 'maskLayout' 'Group' context menu.
\o INFO (MB-1002): The 'Rotate Left' menu item has been removed from the 'maskLayout' 'Instance' context menu.
\o INFO (MB-1002): The 'Rotate Left' menu item has been removed from the 'maskLayout' 'Mosaic' context menu.
\t t
\p > 

Return to top
 ⠀
X