Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 68a6f5a

Browse files
committed
Document the window.overlay() and .overwrite() methods
1 parent 9de6ffa commit 68a6f5a

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

Doc/lib/libcurses.tex

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -860,6 +860,32 @@ \subsection{Window Objects \label{curses-window-objects}}
860860
an update of the physical screen.
861861
\end{methoddesc}
862862

863+
\begin{methoddesc}{overlay}{destwin\optional{, sminrow, smincol,
864+
dminrow, dmincol, dmaxrow, dmaxcol}}
865+
Overlay the window on top of \var{destwin}. The windows need not be
866+
the same size, only the overlapping region is copied. This copy is
867+
non-destructive, which means that the current background character
868+
does not overwrite the old contents of \var{destwin}.
869+
870+
To get fine-grained control over the copied region, the second form
871+
of \method{overlay} can be used. \var{sminrow} and \var{smincol} are
872+
the upper-left coordinates of the source window, and the other variables
873+
mark a rectangle in the destination window.
874+
\end{methoddesc}
875+
876+
\begin{methoddesc}{overwrite}{destwin\optional{, sminrow, smincol,
877+
dminrow, dmincol, dmaxrow, dmaxcol}}
878+
Overwrite the window on top of \var{destwin}. The windows need not be
879+
the same size, in which case only the overlapping region is copied. This copy is
880+
destructive, which means that the current background character
881+
overwrites the old contents of \var{destwin}.
882+
883+
To get fine-grained control over the copied region, the second form
884+
of \method{overwrite} can be used. \var{sminrow} and \var{smincol} are
885+
the upper-left coordinates of the source window, the other variables
886+
mark a rectangle in the destination window.
887+
\end{methoddesc}
888+
863889
\begin{methoddesc}{putwin}{file}
864890
Writes all data associated with the window into the provided file
865891
object. This information can be later retrieved using the

0 commit comments

Comments
 (0)