usr/src/man/man3xcurses/redrawwin.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 REDRAWWIN 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 redrawwin, wredrawln \- redraw screen or portion of screen
   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 \fBredrawwin\fR(\fBWINDOW *\fR\fIwin\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBwredrawln\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIbeg_line\fR, \fBint\fR \fInum_lines\fR);
  25 .fi
  26
  27 .SH PARAMETERS
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fIwin\fR\fR
  32 .ad
  33 .RS 13n
  34 Is a pointer to the window in which to redraw.
  35 .RE
  36
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fIbeg_line\fR\fR
  41 .ad
  42 .RS 13n
  43 Is the first line to redraw.
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fInum_lines\fR\fR
  50 .ad
  51 .RS 13n
  52 Is the number of lines to redraw.
  53 .RE
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The \fBredrawwin()\fR and \fBwredrawln()\fR functions force portions of a
  59 window to be redrawn to the terminal when the next refresh operation is
  60 performed.
  61 .sp
  62 .LP
  63 The \fBredrawwin()\fR function forces the entire window \fIwin\fR to be
  64 redrawn, while the \fBwredrawln()\fR function forces only \fInum_lines\fR lines
  65 starting with \fIbeg_line\fR to be redrawn. Normally, refresh operations use
  66 optimization methods to reduce the actual amount of the screen to redraw based
  67 on the current screen contents.   These functions tell the refresh operations
  68 not to attempt any optimization  when redrawing the indicated areas.
  69 .sp
  70 .LP
  71 These functions are useful when the data that exists on the screen is believed
  72 to be corrupt and for applications such as screen editors that redraw portions
  73 of the screen.
  74 .SH RETURN VALUES
  75 .sp
  76 .LP
  77 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
  78 .SH ERRORS
  79 .sp
  80 .LP
  81 None.
  82 .SH ATTRIBUTES
  83 .sp
  84 .LP
  85 See \fBattributes\fR(5) for descriptions of the following attributes:
  86 .sp
  87
  88 .sp
  89 .TS
  90 box;
  91 c | c
  92 l | l .
  93 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  94 _
  95 Interface Stability     Standard
  96 _
  97 MT-Level        Unsafe
  98 .TE
  99
 100 .SH SEE ALSO
 101 .sp
 102 .LP
 103 \fBdoupdate\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5),
 104 \fBstandards\fR(5)