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

hiSetWindowAtts

hiSetWindowAtts(
[ ?window w_windowId ] 
[ ?appType t_applicationType ] 
[ ?help t_help ] 
[ ?scroll g_scrollbars ]
) 
=> t / nil

Description

Changes the application type, help string, or scroll bar attributes of a window. You must register the new application type before setting it with this function.

Only the help string can be set for session windows.

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

Arguments

?window w_windowId

  

The ID of the window, dockable window, or session window whose attributes you want to change. Only the help string can be set for session windows. If w_windowID is not specified, the current window is used.

?appType t_applicationType

  

String representing the window application type or name.

You must register the new application type before using this function. For example, if you are setting an application type to "chpr", you must have registered it using the command:

hiRegisterBindKeyPrefix( "chpr" "encap" )

?help t_help

String used as one of the keywords that Help logic uses when it constructs the names of help files and help symbols. See Online Help Mechanism for more information. If this argument is not specified, it defaults to the value of t_applicationType.

?scroll g_scrollbars

  

Either t or nil to specify the use of scroll bars. If set to t, scroll bars appear on the right and bottom of the window. If not specified, the property useScrollbars from the CIW is used.

Value Returned

t

The application type or help string, or both, are set. This function returns t whether g_scrollbars is set or not.

nil

Neither the application type nor the help string are set. If you are setting both the application type and the help string at the same time, then nil gets return even if only one of these attributes is not set.

Related Topics

hiRegisterBindKeyPrefix


Return to top
 ⠀
X