Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

hiAddFixedMenu

hiAddFixedMenu( 
[ ?window w_window ] 
?fixedMenu g_fixedMenu 
[ ?menuSide s_menuSide ] 
[ ?append g_append ]
[ ?newLine g_newLine ]
) 
=> t / nil

Description

Fixed menus are no longer supported in windows. Use the new toolbar functions to create toolbars instead for windows. Existing fixed menus that have been added to windows are no longer displayed, although no warnings are being generated. Replace these menus with toolbars.

Adds or replaces a vertical fixed menu on a window.

You can have multiple fixed menus in a window. To add the new menu to any existing fixed menus, set the ?append argument to t; to replace all existing fixed menus with the new menu, set ?append to nil.

The menu can be placed on the left, right, or top edge of the window. When you create the menu, you can specify the location with the ?menuSide argument.

To place a fixed menu on the root window (screen), instead of attaching it to a graphics window, use the hiDisplayFixedMenu function.

Arguments

?window w_window

Window on which to add the fixed menu. This window must be of type graphics, browser, form, text, or encap. It cannot be a session window or a dockable window. If you do not specify w_window, the current window is used.

?fixedMenu g_fixedMenu

  

Vertical fixed menu created with hiCreateVerticalFixedMenu, specified as a symbol. This menu can be placed on the left, right, or top edge of the window.

?menuSide s_menuSide

  

Side of the window where the fixed menu is to be placed. This argument must be either ’left, ’right, ’top, or ’default. If you do not specify s_menuSide, the default is used. The default is determined by the settings in the CIW or the .cdsenv file.

?append g_append

t or nil. t appends the menu to any existing fixed menus on the window; nil replaces all existing fixed menus with the new menu.

The default is nil.

?newLine g_newLine

  

t or nil. t places the menus in a new row or column.

Values Returned

t

The fixed menu is added.

nil

The fixed menu is not added.

Examples

menu = hiCreateVerticalFixedMenu(...)
hiAddFixedMenu(?window window(5) ?fixedMenu menu 
?menuSide ’right)

Related Topics

Window Functions

hiDisplayFixedMenu

hiCreateVerticalFixedMenu


Return to top
 ⠀
X