deCopy

deCopy( 
[ w_window [ g_winSpec ] ] 
) 
=> w_windowCopy / nil

Description

Makes a complete copy of the given window, including its stack and the context data stored on it.

w_windowCopy is identical to, but distinct from, w_window. During the copy process, the data trigger will be called as if you had executed the corresponding sequence of deOpen/dePush/deEditInPlace operations. The application trigger will be called with the ’copy operation and is responsible for initializing the destination context with the data from the source context.

If g_winSpec is an existing window, its contents are removed before the copy begins. If this operation fails, the copy does not take place. If g_winSpec is a session window then the new window, which is a copy, is made inside the session window.

In the following example, deCopy copies the current window in a new tab in the same session window:

(let ((cw (hiGetCurrentWindow))) (deCopy cw (hiGetSessionWindow cw)))

The current edit level of the destination window is set to be the same as that of the source window; if this is not the maximum edit level in the source window, it will not be in the destination window.

Arguments

w_window	Window which is to be copied. Defaults to the current window.
g_winSpec	Window specification for the copy. See deOpen for a detailed description of this argument.

Values Returned

w_windowCopy	Copy of w_window which is created.
nil	The copy is not made.

Examples

The following example returns a window containing the same cellview as n.

deCopy( window(3) )

Return to top