hiDisplayFixedMenu
hiDisplayFixedMenu(
r_hiMenu
g_menuLocation
[ x_width ]
[ x_height ]
[ g_staysOnTop }
)
=> t / nil
Description
Displays the specified fixed menu in the default root window (screen). The menu appears on a side of the screen, to be shared among Cadence application windows contained within the screen. The x_width and y_height arguments are ignored and currently exist only for compatability reasons. x_width and y_height of the menu are automatically determined by the size of the menu items and the number of columns and rows.
Arguments
|
r_hiMenu
|
The menu returned from hiCreateHorizontalFixedMenu or hiCreateVerticalFixedMenu or an Edge-styled fixed menu created with the menutrans program.
|
|
g_menuLocation
|
This argument must be one of the following, which aligns the fixed menu along the edge of the screen:
"top"
"bottom"
"left"
"right"
"topLeft"
"topRight"
"bottomLeft"
"bottomRight"
The "top" and "bottom" are allowed only for horizontal fixed menus and "left" and "right" for vertical fixed menus.
The options "topLeft", "topRight", "bottomLeft" and "bottomRight" place the menus in the corners. For the corner options, either horizontal or vertical menus are allowed.
|
|
x_width
|
Specifies the width of the menu. However, even if specified this value is ignored and currently exists only for compatability reasons.
|
|
x_height
|
Specifies the height of the menu. However, even if specified this value is ignored and currently exists only for compatability reasons.
|
|
g_staysOnTop
|
When set to t, the vertical or horizontal fixed menus stay on top of other windows.
|
Values Returned
|
t
|
The menu is displayed.
|
|
nil
|
The menu is not displayed. An error message is also issued.
|
Examples
The following example displays trExampleHorizontalFixedMenu. Before using this example, see the hiCreateHorizontalFixedMenu example to find out how to create trExampleHorizontalFixedMenu.
hiDisplayFixedMenu(
trExampleHorizontalFixedMenu
"top"
)
Related Topics
Menu Functions
hiCreateHorizontalFixedMenu
Return to top
