Current File : //usr/man/man3xcurses/mvderwin.3xcurses

'\" te
.\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
.TH mvderwin 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions"
.SH NAME
mvderwin \- map area of parent window to subwindow
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]

\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]

#include <curses.h>

\fBint\fR \fBmvderwin\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIpar_y\fR, \fBint\fR \fIpar_x\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIwin\fR\fR
.ad
.RS 9n
.rt  
Is a pointer to the window to be mapped.
.RE

.sp
.ne 2
.mk
.na
\fB\fIpar_y\fR\fR
.ad
.RS 9n
.rt  
Is the y (row) coordinate of the placement of the upper left corner of window  relative to the parent window.
.RE

.sp
.ne 2
.mk
.na
\fB\fIpar_x\fR\fR
.ad
.RS 9n
.rt  
Is the x (column) coordinate of the placement of the upper left corner of  the window relative to the parent window.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBmvderwin()\fR function defines a mapped area of \fIwin\fR's parent  window that is the same size as \fIwin\fR and has its upper left corner at  position \fIpar_y\fR, \fIpar_x\fR of the parent window.
.sp
.LP
Whenever \fIwin\fR is refreshed, its contents are updated to match those of the mapped area and any reference to characters in \fIwin\fR is treated as a reference to corresponding characters in the mapped area.
.SH RETURN VALUES
.sp
.LP
On success, the \fBmvderwin()\fR function returns \fBOK\fR. Otherwise, it returns \fBERR\fR.
.SH ERRORS
.sp
.LP
None.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelUnsafe
_
StandardSee \fBstandards\fR(5).
.TE

.SH SEE ALSO
.sp
.LP
\fBdelwin\fR(3XCURSES), \fBderwin\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)