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

hiSwitchWindowType

hiSwitchWindowType(
w_windowId 
t_widgetType
t_appType
t_help
[ g_scroll ] 
) 
=> t / nil 

Description

Switches the widget type of a window between graphics, text, or hypertext. The window must be in a session window.

The application type, help string, and scroll bar option can also be changed.

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

Arguments

w_windowId

Window you want to change, which must be one of the following types: graphics, text, or hypertext. The window must be contained in a session window. w_windowId cannot be a dock window or a session window.

t_widgetType

One of the following strings: text, hypertext, or graphics.

t_appType

String representing the window application type or name.

t_help

String used as one of the key words that Help logic uses when it is constructing the names of the various help files and/or help symbols searched for in the help files. Refer to Online Help Mechanism for more information. If this argument is not specified, it defaults to the same value as t_applicationType.

g_scroll

Either t or nil to specify the use of scroll bars. If g_scroll is set to t, scroll bars appear on the right and bottom of the window. If g_scroll is not specified or nil, scroll bars are not displayed.

Value Returned

t

The window type is switched.

nil

Tthe window type is not switched. An error message is also issued.

Examples

Switches the window type of window (4).

hiSwitchWindowType( window ( 4 ) "text" "Layout" "layoutHelp" )
=> t

Related Topics

Window Functions


Return to top
 ⠀
X