usr/src/man/man3xcurses/mvderwin.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH MVDERWIN 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 mvderwin \- map area of parent window to subwindow
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBint\fR \fBmvderwin\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIpar_y\fR, \fBint\fR \fIpar_x\fR);
  20 .fi
  21
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIwin\fR\fR
  27 .ad
  28 .RS 9n
  29 Is a pointer to the window to be mapped.
  30 .RE
  31
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIpar_y\fR\fR
  36 .ad
  37 .RS 9n
  38 Is the y (row) coordinate of the placement of the upper left corner of window
  39 relative to the parent window.
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fIpar_x\fR\fR
  46 .ad
  47 .RS 9n
  48 Is the x (column) coordinate of the placement of the upper left corner of  the
  49 window relative to the parent window.
  50 .RE
  51
  52 .SH DESCRIPTION
  53 .sp
  54 .LP
  55 The \fBmvderwin()\fR function defines a mapped area of \fIwin\fR's parent
  56 window that is the same size as \fIwin\fR and has its upper left corner at
  57 position \fIpar_y\fR, \fIpar_x\fR of the parent window.
  58 .sp
  59 .LP
  60 Whenever \fIwin\fR is refreshed, its contents are updated to match those of the
  61 mapped area and any reference to characters in \fIwin\fR is treated as a
  62 reference to corresponding characters in the mapped area.
  63 .SH RETURN VALUES
  64 .sp
  65 .LP
  66 On success, the \fBmvderwin()\fR function returns \fBOK\fR. Otherwise, it
  67 returns \fBERR\fR.
  68 .SH ERRORS
  69 .sp
  70 .LP
  71 None.
  72 .SH ATTRIBUTES
  73 .sp
  74 .LP
  75 See \fBattributes\fR(5) for descriptions of the following attributes:
  76 .sp
  77
  78 .sp
  79 .TS
  80 box;
  81 c | c
  82 l | l .
  83 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  84 _
  85 Interface Stability     Standard
  86 _
  87 MT-Level        Unsafe
  88 .TE
  89
  90 .SH SEE ALSO
  91 .sp
  92 .LP
  93 \fBdelwin\fR(3XCURSES), \fBderwin\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
  94 \fBattributes\fR(5), \fBstandards\fR(5)