diff options
| author | Andrew M. Kuchling <amk@amk.ca> | 2000-12-21 16:25:44 +0000 |
|---|---|---|
| committer | Andrew M. Kuchling <amk@amk.ca> | 2000-12-21 16:25:44 +0000 |
| commit | e4301549d44d54c46b493d04f10c4225421bb6f5 (patch) | |
| tree | f055cfb6bc448af02de85bd6b22aa0fbcb6b4255 | |
| parent | 6c62c9d14ccbf86e5cb650efb863bba8279b8f32 (diff) | |
| download | cpython-e4301549d44d54c46b493d04f10c4225421bb6f5.tar.gz | |
Document the window.overlay() and .overwrite() methods
| -rw-r--r-- | Doc/lib/libcurses.tex | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/Doc/lib/libcurses.tex b/Doc/lib/libcurses.tex index d8708ce11f..3968fca665 100644 --- a/Doc/lib/libcurses.tex +++ b/Doc/lib/libcurses.tex @@ -860,6 +860,32 @@ representing the desired state of the window, but does not force an update of the physical screen. \end{methoddesc} +\begin{methoddesc}{overlay}{destwin\optional{, sminrow, smincol, + dminrow, dmincol, dmaxrow, dmaxcol}} +Overlay the window on top of \var{destwin}. The windows need not be +the same size, only the overlapping region is copied. This copy is +non-destructive, which means that the current background character +does not overwrite the old contents of \var{destwin}. + +To get fine-grained control over the copied region, the second form +of \method{overlay} can be used. \var{sminrow} and \var{smincol} are +the upper-left coordinates of the source window, and the other variables +mark a rectangle in the destination window. +\end{methoddesc} + +\begin{methoddesc}{overwrite}{destwin\optional{, sminrow, smincol, + dminrow, dmincol, dmaxrow, dmaxcol}} +Overwrite the window on top of \var{destwin}. The windows need not be +the same size, in which case only the overlapping region is copied. This copy is +destructive, which means that the current background character +overwrites the old contents of \var{destwin}. + +To get fine-grained control over the copied region, the second form +of \method{overwrite} can be used. \var{sminrow} and \var{smincol} are +the upper-left coordinates of the source window, the other variables +mark a rectangle in the destination window. +\end{methoddesc} + \begin{methoddesc}{putwin}{file} Writes all data associated with the window into the provided file object. This information can be later retrieved using the |
