hiCreateDockWindow

hiCreateDockWindow(
?appType t_appType
?widgetType t_widgetType
[ ?handle s_handle ]
[ ?dockSizeHint l_dockSizeHint ]
[ ?minimumSizeHint l_minimumSizeHint ]
[ ?floatSizeHint l_floatSizeHint ]
[ ?form g_form ]
[ ?help t_help ]
[ ?scrollBar g_scrollBar ]
[ ?title t_title ]
[ ?visibilityProc s_visibilityProc ]
)
=> w_dwindowID / nil

Description

Creates a dockable window, which can be docked in a session window with the hiDockWindow function. Dockable windows can be of the following types: form, hypertext, html, or text. Dockable windows cannot be of type graphics.

A dockable window can be associated with only one session window.

You can create dockable form windows by specifying the form handle as the ?form argument and the string "form" as the ?widgetType argument.

You can add menus to dockable windows with the functions listed in Menu Functions

This function returns a dwindowID. The SKILL output format is:

dwindow:#

If you specify the ?handle argument, the dockable window is logged, in log files, as:

dwindow(’handle)

A dockable window can never become the current window.

Arguments

`?appType` t_appType
	String specifying the dockable window application type or name. This string is also used as the window’s bindkey prefix.
`?widgetType` t_widgetType
	String specifying the type of window widget to be created. One of the following: `text`, `html`, `hypertext`, or `form`. For information about how to create hypertext, see Hypertext Viewfile Window.
`?handle` s_handle	Symbol specifying a handle for the dockable window. You can reference it with dwindowID`->hiHandle`
`?dockSizeHint` l_dockSizeHint
	List specifying the initial size of the window when it is docked: `list(x_width x_height)` The default dock size is `list(150 150)`. This value is used the first time that the window is docked. Subsequently, the size that was last set is used. Here the size refers to the size of the dock window only and does not include the window frame.
`?minimumSizeHint` l_minimumSizeHint
	List specifying the minimum size of the window: `list(x_width x_height)` The default minimum size is `list(0 0)`. This specifies the minimum required size of the dock window under normal circumstances.
`?floatSizeHint` l_floatSizeHint
	List specifying the initial size of the window when it is floating: `list(x_width x_height)` If this argument is not specified, the Qt default is used. This value is used the first time that the window is floated. Subsequently, the last size and location are used. Here the size refers to the size of the dock window only and does not include the window frame.
`?form` g_form	SKILL representation of a form returned by `hiCreateAppForm`. Use this argument if you want to display a form in the dockable window. This argument is valid only for dock windows whose t_widgetType is `"form"`. When the dock window containing the form is closed, the form is not destroyed; it can be redisplayed in another window.
`?help` t_help	Help string for the dock window, which is used to reference a `.tgf` help file. If you do not specify this argument or specify `""` (an empty string), the help argument is set to the `appName` (which is the value of the `?appType` argument). The help string for a window can also be set at any time using the `hiSetWindowsAtts` functions and can be retrieved with the `hiGetHelp` function. Cadence applications may modify their window help strings at any time. When a user clicks Help in a window, the help string is used for the help symbol that is looked for in the `.tgf` file. The `appName` is used to determine the `.tgf` file to search. The help string can also be used to modify the `appName` by assigning an `hiHelpAppName` property to the symbol representation of the string. For example, `putprop( concat(` help_string `)` app_name_string `’hiHelpAppName)` set the `appID` used for Help to app_name_string whenever help_string is used as the help string for any window. For more information about the online help mechanism, see Online Help Mechanism. For windows help to work correctly, either the t_help or t_appType argument or both must be set when you create the dock window.
`?scrollBar` g_scrollbars
	`t` or `nil`. If set to `t`, scroll bars appear on the right and bottom of the dock window. If not specified, the value of the property `useScrollbars` is used. The property can be set from the CIW’s User Preferences form.
`?title` t_title	String specifying the window title that is displayed in the window frame and in the context popup menu.
`?visibilityProc` s_visibilityProc
	This argument can be used to monitor the visibility of a docked window. Set the argument, at creation, with a function name in either symbol or string format. The function then be called whenever there is a visibility change in the docked window and pass two arguments, the `dockwindow id` and `t/nil` to represent visible or invisible.

The docked window should not be closed from within the visibility procedure (that is, do not call hiCloseWindow).

Values Returned

w_dwindowID	The window ID of the dock window.
`nil`	There was an error.

Examples

hiCreateDockWindow( ?appType "text" ?widgetType "text" ?handle ’dw ?title "My Window" )

Additional Information

Dockable windows are windows that occupy dock areas within a session window. They typically provide helper functionality for the application. These windows can be docked in a session window or left free. A dockable window can be associated with only one session window.

They are created with hiCreateDockWindow and can be of the following types: browser, text, html, hypertext, or form. You can create dockable form windows by calling hiCreateDockWindow and specifying a ?widgetType of form.

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