usr/src/man/man3xcurses/clear.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 CLEAR 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 clear, erase, wclear, werase \- clear a window
   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 \fBclear\fR(\fBvoid\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBerase\fR(\fBvoid\fR);
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBint\fR \fBwclear\fR(\fBWINDOW *\fR\fIwin\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBint\fR \fBwerase\fR(\fBWINDOW *\fR\fIwin\fR);
  35 .fi
  36
  37 .SH DESCRIPTION
  38 .sp
  39 .LP
  40 The \fBclear()\fR and \fBerase()\fR functions clear \fBstdscr\fR,  destroying
  41 its previous contents. The \fBwclear()\fR and \fBwerase()\fR functions perform
  42 the same action,  but clear the window specified by \fIwin\fR instead of
  43 \fBstdscr\fR.
  44 .sp
  45 .LP
  46 The \fBclear()\fR and \fBwclear()\fR functions also call the \fBclearok()\fR
  47 function. This function clears and redraws the entire screen on the next call
  48 to \fBrefresh\fR(3XCURSES) or \fBwrefresh\fR(3XCURSES) for the window.
  49 .sp
  50 .LP
  51 The current background character (and attributes) is used to clear the screen.
  52 .SH PARAMETERS
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fIwin\fR\fR
  57 .ad
  58 .RS 7n
  59 Is a pointer to the window that is to be cleared.
  60 .RE
  61
  62 .SH ERRORS
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBOK\fR\fR
  67 .ad
  68 .RS 7n
  69 Successful completion.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBERR\fR\fR
  76 .ad
  77 .RS 7n
  78 An error occurred.
  79 .RE
  80
  81 .SH ATTRIBUTES
  82 .sp
  83 .LP
  84 See \fBattributes\fR(5) for descriptions of the following attributes:
  85 .sp
  86
  87 .sp
  88 .TS
  89 box;
  90 c | c
  91 l | l .
  92 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  93 _
  94 Interface Stability     Standard
  95 _
  96 MT-Level        Unsafe
  97 .TE
  98
  99 .SH SEE ALSO
 100 .sp
 101 .LP
 102 \fBbkgdset\fR(3XCURSES), \fBclearok\fR(3XCURSES), \fBclrtobot\fR(3XCURSES),
 103 \fBclrtoeol\fR(3XCURSES), \fBdoupdate\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
 104 \fBrefresh\fR(3XCURSES), \fBwrefresh\fR(3XCURSES), \fBattributes\fR(5),
 105 \fBstandards\fR(5)