hiDockWindow
hiDockWindow(
?window w_dwindowID
[ ?session g_sessionWindowID ]
[ ?side s_side ]
[ ?index x_index ]
[ ?unmapped g_unmapped ]
[ ?tabOnto w_dwindowID ]
)
=> t / nil
Description
Docks a dockable window in a session window. You must specify the g_sessionWindowID argument the first time that you display a dock window with this function.
The initial size of the docked window depends on the dock size hint specified when the window was created. Subsequently, the size that was last set interactively is used.
Arguments
|
?window w_dwindowID
|
|
|
The ID of the dockable window, returned by hiCreateDockWindow.
|
|
?session g_sessionWindowID
|
|
|
The ID of the session window in which you want to dock the window, returned by hiCreateWindow or obtained by swindow.
You must specify this argument the first time that you display the dockable window so that it is associated with the session window. This argument is optional in subsequent calls to the function. A dockable window can only be associated with one session window.
|
|
?side s_side
|
One of the following symbols: ’left, ’right, ’top, or ’bottom, specifying the dock area in which to dock the window.
Default value: ’left
|
|
?index x_index
|
The position before which to insert the dockable window. This is based on a 0-based index of all the dockable windows in a dock area.
The default value is -1, which places the window at the end of the dock area.
|
|
?unmapped g_unmapped
|
|
|
Unmaps the dockable window to be docked.
Default value: nil
|
|
?tabOnto w_dwindowID
|
|
|
The ID of the docked window (as returned by hiCreateDockWindow) that the window is to be tabbed onto, or nil.
If set to nil (the default), current behavior remains unchanged. However, if a window ID is specified, then the current setting for ?side gets ignored,. Additionally, if ?session has been specified, then it must be the session window that ?tabOnto is to be docked to.
It is therefore not recommended that ?session be specified when ?tabOnto is being used.
|
Values Returned
|
t
|
The dockable window was docked in the session window it is associated with.
|
|
nil
|
There was an error.
|
Examples
hiDockWindow( ?window myDockAsst ?session mainSession ?side ’right )
Related Topics
Window Functions
hiUndockWindow
hiCreateDockWindow
hiIsWindowSpecifier
Return to top
