Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

copywin(3xcurses) [opensolaris man page]

copywin(3XCURSES)					  X/Open Curses Library Functions					 copywin(3XCURSES)

NAME

       copywin - overlay or overwrite any portion of window

SYNOPSIS

       cc [ flag... ] file... -I /usr/xpg4/include  -L	/usr/xpg4/lib 
	-R  /usr/xpg4/lib  -lcurses  [ library... ]

       c89 [ flag... ] file... -lcurses [ library... ]

       #include <curses.h>

       int copywin(const WINDOW *srcwin, WINDOW *dstwin, int sminrow, int smincol,
	    int dminrow, int dmincol, int dmaxrow, int dmaxcol, int overlay);

PARAMETERS

       srcwin	  Is a pointer to the source window to be copied.

       dstwin	  Is a pointer to the destination window to be overlayed or overwritten.

       sminrow	  Is the row coordinate of the upper left corner of the rectangular area  on the source window to be copied.

       smincol	  Is the column coordinate of the upper left corner of the rectangular area  on the source window to be copied.

       dminrow	  Is  the  row coordinate of the upper left corner of the rectangular area  on the destination window to be overlayed or overwrit-
		  ten.

       dmincol	  Is the column coordinate of the upper left corner of the rectangular area  on destination window to be overlayed or overwritten.

       dmaxrow	  Is the row coordinate of the lower right corner of the rectangular area  on the destination window to be overlayed or  overwrit-
		  ten.

       dmaxcol	  Is  the  column coordinate of the lower right corner of the rectangular area	on the destination window to be overlayed or over-
		  written.

       overlay	  Is a TRUE or FALSE value that determines whether the destination  window is overlayed or overwritten.

DESCRIPTION

       The copywin() function provides a finer granularity of control over the overlay(3XCURSES) and overwrite(3XCURSES) functions. As in the pre-
       fresh() function (see newpad(3XCURSES)), a rectangle is specified in the destination window, (dminrow, dmincol) and (dmaxrow, dmaxcol), and
       the upper-left-corner coordinates of the source window, (smincol, sminrow). If overlay is TRUE, then  copying  is  non-destructive,  as	in
       overlay(). If overlay is FALSE, then copying is destructive, as in overwrite().

RETURN VALUES

       Upon successful completion, the copywin() function returns OK. Otherwise, it returns ERR.

ERRORS

       No errors are defined.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       curses(3XCURSES), libcurses(3XCURSES), newpad(3XCURSES), overlay(3XCURSES), attributes(5), standards(5)

SunOS 5.11							    5 Jun 2002							 copywin(3XCURSES)

Check Out this Related Man Page

curs_overlay(3CURSES)					     Curses Library Functions					     curs_overlay(3CURSES)

NAME

       curs_overlay, overlay, overwrite, copywin - overlap and manipulate overlapped curses windows

SYNOPSIS

       cc [ flag ... ] file ... -lcurses [ library ... ]
       #include <curses.h>

       int overlay(WINDOW *srcwin, WINDOW *dstwin);

       int overwrite(WINDOW *srcwin, WINDOW *dstwin);

       int copywin(WINDOW *srcwin, WINDOW *dstwin, int sminrow, int smincol, int dminrow, int dmincol, int dmaxrow, int dmaxcol, int overlay);

DESCRIPTION

       The  overlay()  and overwrite() routines overlay srcwin on top of dstwin. scrwin and dstwin are not required to be the same size; only text
       where the two windows overlap is copied. The difference is that overlay() is non-destructive (blanks are not copied) whereas overwrite() is
       destructive.

       The  copywin() routine provides a finer granularity of control over the overlay() and overwrite() routines. Like in the prefresh() routine,
       a rectangle is specified 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 non-destructive, as in overlay().

RETURN VALUES

       Routines that return an integer return ERR upon failure and an integer value other than ERR upon successful completion.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       curs_pad(3CURSES), curs_refresh(3CURSES), curses(3CURSES), attributes(5)

NOTES

       The header <curses.h> automatically includes the headers  <stdio.h> and <unctrl.h>.

       Note that overlay() and overwrite may be macros.

SunOS 5.10							    31 Dec 1996 					     curs_overlay(3CURSES)
Man Page