hiGetWindowDisplayState
hiGetWindowDisplayState(
w_windowId
)
=> l_state / nil
Description
Returns detailed information about the display state of a window.
Argument
|
w_windowID
|
The ID of the window, session window, or dockable window.
|
Value Returned
|
l_state
|
A list of keywords that describe the display state of the window. Valid values for the first element of the list are:
-
mapped -
unmapped -
iconified
Valid values for the second element of the list are:
-
session: a session window -
topTab: a window in a session window that is currently displayed -
hiddenTab: a window in a session window that is hidden behind other tabs -
docked: a docked dockable window -
floated: a floating dockable window -
main: a window that is either not within a session window or is the only window within a session window.
|
|
nil
|
The window, or the session window that contains it, has not been displayed yet with hiDisplayWindow. If w_windowID is a session window, the session window, or any window it contains, has not been displayed yet.
|
Examples
Returns detailed information of the display state of the win3 window.
hiGetWindowDisplayState( win3 )
=> (unmapped hiddenTab)
Returns detailed information of the display state of the win6 window.
hiGetWindowDisplayState( win6 )
=> (mapped topTab)
Returns detailed information of the display state of the sessionWin window.
hiGetWindowDisplayState( sesssionWin )
=> (mapped session)
Related Topics
Window Functions
hiGetWindowState
Return to top
