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

hiInsertBannerMenu

hiInsertBannerMenu(
w_windowId 
g_menu 
x_menuPosition 
) 
=> t / nil 

Description

Inserts a menu into the menu bar of a window. If the menu symbol that you specify already exists on the window, a warning message is issued and the menu is not placed on the window.

There is a maximum number of 40 window banner menus that can be added.

Arguments

w_windowId

Specifies the window to add a menu.

g_menu

Menu that you want to insert. The menu must be the value returned from hiCreatePulldownMenu, or a symbol representing that value. The title of this menu is displayed as text on the menu bar.

x_menuPosition

Location in the banner where the menu is to be positioned. The menu positions are numbered from 0, starting with the leftmost user-defined menu contained in the menu bar.

This function does not overwrite an existing menu. If a menu already exists at the position you specify, the function inserts the new menu into the specified position and moves the existing menus to the right. If x_menuPostion is greater than the current number of user-defined menus, the function adds the new menu to the right of all other menus (except the Help button or menu).

Values Returned

t

The menu is inserted in the menu bar.

nil

The menu is not inserted. An error message is also issued.

Examples

Inserts hiCreatePulldownMenu into the menu bar of the window.

menu=hiCreatePulldownMenu( ... )
hiInsertBannerMenu(window menu 0)
=> t
hiInsertBannerMenu(window hiCreatePulldownMenu( ... ) 0)
=> t

The following example inserts a pull-down menu in the leftmost position of the CIW.

hiInsertBannerMenu( window(1) trPulldownMenu 0 )

Related Topics

Window Banner Functions

hiCreatePulldownMenu


Return to top
 ⠀
X