Index Click this button to go to the index for this section.


curs_overlay(3)

NAME

curs_overlay, copywin, overlay, overwrite - Overlap and manipulate overlapped Curses windows

LIBRARY

Curses Library (libcurses.a, libcurses.so)

SYNOPSIS

#include <curses.h> int overlay(const WINDOW *srcwin, WINDOW *dstwin); int overwrite(const WINDOW *srcwin, WINDOW *dstwin); int copywin(const WINDOW *srcwin, WINDOW *dstwin, int sminrow, int smincol, int dminrow, int dmincol, int dmaxrow, int dmaxcol, int overlay);

STANDARDS

Interfaces documented on this reference page conform to industry standards as follows: overlay, overwrite: XPG4, XPG4-UNIX copywin: XPG4-UNIX Refer to the standards(5) reference page for more information about industry standards and associated tags.

DESCRIPTION

The overlay and overwrite routines overlay srcwin on top of dstwin. The scrwin and dstwin parameters do not have to be the same size; Curses copies only the text in the region where the two windows overlap. The difference between the routines is that overlay is nondestructive (blanks are not copied), whereas overwrite is destructive. The copywin routine provides a finer granularity of control over the same operation performed by overlay and overwrite. Like the prefresh routine, copywin specifies a rectangle in the destination window, (dminrow, dmincol) and (dmaxrow, dmaxcol), and the upper-left-corner coordinates of the source window, (sminrow, smincol). If the argument overlay is true, then copying is nondestructive, as is the case for the overlay function.

NOTES

The header file curses.h automatically includes the header file stdio.h.

RETURN VALUES

These routines return ERR upon failure and OK upon successful completion.

RELATED INFORMATION

Functions: curses(3), curs_pad(3), curs_refresh(3) Others: standards(5)