hiDisplayWindow

hiDisplayWindow(
w_windowId | w_sessionWindowID
[ w_sessionWindowId ]
[ g_tabTitle ]
[ g_tabIcon ]
[ g_tabTip ]
) 
=> t / nil 

Description

Displays any window created by hiCreateWindow, including session windows; does not display dockable windows or empty session windows. This function always displays graphics windows in a session window—if you do not specify a session window, this function creates a new one and displays the graphics window in it.

Use the second argument to specify the session window in which to place the window. If the session window already contains windows, a new tab is created for the new window, and the new tab and new window are raised to the top. If the session window is not yet displayed, it is displayed.

If a session window is the first argument, no other arguments are accepted. You cannot display an empty session window; it must contain a window.

This function does not display dockable windows. To display dockable windows, use hiDockWindow.

This function is not available in Concept SKILL. For more information, see Design Entry HDL–SKILL Routines.

Arguments

w_windowId | w_sessionWindowID
	The window or session window that you want to display. You cannot display an empty session window—it must contain a window.
w_sessionWindow	The session window in which you want to place w_windowID. w_windowID must not be associated with another session window. This argument is used only if the first argument is not a session window.
g_tabTitle	The tab title for the new window. If the session window already contains windows, a tab is created for the new window. After the window is created, you can use the hiSetTabWindowTitle function to change the tab title.
g_tabIcon	The icon to be displayed on the tab for the new window. After the window is created, you can use the hiSetTabWindowIcon function to change the tab icon.
g_tabTip	String specifying the tooltip that gets displayed whenever the cursor hovers over the tab. After the window is created, you can use the hiSetTabWindowTip function to change the tab tooltip.

Values Returned

t	The window is displayed.
nil	There was an error. An error message is also issued.

Examples

Associates a window with a session window and displays it:

hiDisplayWindow( myWin mySessionWin )

Displays a graphics window in a new session window:

hiDisplayWindow( myGraphicsWin )

Displays a non-empty session window:

hiDisplayWindow( mySessionWindow )

Related Topics

Window Functions

Return to top