schRegisterFixedMenu

schRegisterFixedMenu( 
t_category 
r_menuHandle 
[ s_disableTrigger ] 
[ s_enableTrigger ] 
)
=> t / nil

Description

Registers a vertical fixed-menu handle for specific cellview types to customize the schematic and symbol editor fixed menus. This function also registers triggers to enable and disable specific items in the fixed menu based on whether the editor window is in edit or read mode.

To reinstate the system default icon bar associated with the specified menu type, use the schUnregisterFixedMenu function.

A sample file containing the SKILL source code for the default fixed menus is located at your_install_dir/tools/dfII/samples/local/schFixMenu.il.

Arguments

t_category	Cellview type for which the menu is assigned; must be enclosed in quotation marks. Valid Values: schematic, sheetSchematic, indexSchematic, symbol
r_menuHandle	Menu to display. The hiCreateVerticalFixedMenu function creates r_menuHandle.
s_disableTrigger	SKILL function that is called when the cellview is opened in read mode or changed from edit to read mode. The trigger passes the r_menuHandle value of the fixed menu and the ID of the window containing the fixed menu. It calls hiDisableMenuItem for all menu entries to be disabled in read mode. Must be preceded by a tic mark ( ' ).
s_enableTrigger	SKILL function that is called when the cellview is opened in edit mode or changed from read to edit mode. The trigger passes the r_menuHandle value of the fixed menu and the ID of the window containing the fixed menu. It calls hiEnableMenuItem for all menu entries that might have been disabled by the disable trigger.

Value Returned

t	Registered a vertical fixed-menu handle for specific cellview types to customize the schematic and symbol editor fixed menus.
nil	Registering fixed-menu handle was unsuccessful.

Examples

Registers myFixedMenu as the fixed menu to display when the current cellview is a schematic.

schRegisterFixedMenu( "schematic" myFixedMenu )

Registers symFixMenu as the fixed menu to be displayed when the current cellview is a symbol. Also registers symDisableProc as the SKILL procedure to call when the cellview is in read mode and symEnableProc as the SKILL procedure to call when the cellview is in edit mode.

schRegisterFixedMenu( "symbol" symFixMenu 'symDisableProc 'symEnableProc )

Related Topics

Cadence SKILL Language Reference

Return to top