deReturn

deReturn( 
w_window [ x_level ] 
) 
=> x_level_new / nil

Description

Pops the window stack one or more levels.

If x_level is defaulted, the stack is popped one level. Otherwise, the stack is popped as many times as necessary to leave the stack with x_level elements on it. This routine returns nil if the current level could not be popped. Otherwise it returns the resulting edit level, which can be greater than that passed in if one or more levels could not be popped. If x_level is -1, everything is automatically popped and the window is closed.

Arguments

w_window	Window in which a stack element is to be popped.
x_level	Stack level to return to. If not specified, the stack is popped one level, which also means that if you are already at the top level, calling deReturn without specifying x_level will close the window.

Values Returned

x_level_new	Stack level after the return completes.
nil	The current level could not be popped.

Examples

Pops one level off the stack of window(3). Assuming that previously, the window is left in the same state as it was before the call to deEditInPlace.

deReturn( window(3) )

Equivalent to hiCloseWindow( window(3) ).

deReturn( window(3) -1 )

Return to top