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

hiSetSessionFocus

hiSetSessionFocus(
w_dockWindowOrTabWindow
)
=> t / nil

Description

Sets the keyboard focus to a session window’s active tab window or docked window when the session window becomes active. The active tab window or docked window that you specify must be part of a session window and must contain a sub-widget that is enabled, visible, and that can get focus through the Tab key. The focus is set to a sub-widget.

Keyboard focus will be active only when the session window has the window manager focus; this function does not take focus away from other applications or top-level windows.

Argument

w_dockWindowOrTabWindow

A session window active tab window or docked window.

Value Returned

t

Session focus was set to a sub-widget of the specified window.

nil

The specified window is invalid or a sub-widget could not be found.

Examples

hiSetSessionFocus(hiGetActiveTabWindow( swindow ( 1 ) ) )

Related Topics

Window Functions


Return to top
 ⠀
X