hiSetCurrentWindow

hiSetCurrentWindow(
w_windowId 
) 
=> t / nil 

Description

Sets the window you specify as the current window.

Session windows and dockable windows can never become the current window. Only windows contained in the main canvas area of a session window can become the current window. If w_windowId is a session window, the last active window contained in the session window becomes the current window. Similarly, if w_windowId is a dockable window, the last active window in the session window that contains the dockable window becomes the current window.

The Command Interpreter Window can also never become the current window. Also, any window with the property neverCurrentWindow set to t (for example window->neverCurrentWindow = t) cannot become the current window.

Argument

w_windowId

Window you want to make current. The following windows can never be the current window: session windows; dockable windows; the Command Interpreter Window; any window with the property neverCurrentWindow set to t. If you have a command for a specific window, make it the current window before calling the enter function by using the windowId argument.

Value Returned

t	The window is made current.
nil	w_windowId is invalid, is the Command Interpreter Window, or has the property neverCurrentWindow set to t.

Related Topics

Window Functions

hiGetCurrentWindow

hiRegCurWindowTrigger

hiUnregCurWindowTrigger

Return to top