usr/src/man/man3xcurses/immedok.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 IMMEDOK 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 immedok \- call refresh on changes to 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 \fBimmedok\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 If \fIbf\fR is \fBTRUE\fR, \fBimmedok()\fR calls \fBrefresh\fR(3XCURSES) if any
  26 change to the window image is made (for example, through functions such as
  27 \fBaddch\fR(3XCURSES), \fBclrtobot\fR(3XCURSES), and \fBscrl\fR(3XCURSES)).
  28 Repeated calls to \fBrefresh()\fR may affect performance negatively.  The
  29 \fBimmedok ()\fR function is disabled by default.
  30 .SH PARAMETERS
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fIwin\fR\fR
  35 .ad
  36 .RS 7n
  37 Is a pointer to the window that is to be refreshed.
  38 .RE
  39
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fIbf\fR\fR
  44 .ad
  45 .RS 7n
  46 Is a Boolean expression.
  47 .RE
  48
  49 .SH RETURN VALUES
  50 .sp
  51 .LP
  52 The \fBimmedok()\fR function does not return a value.
  53 .SH ERRORS
  54 .sp
  55 .LP
  56 None.
  57 .SH ATTRIBUTES
  58 .sp
  59 .LP
  60 See \fBattributes\fR(5) for descriptions of the following attributes:
  61 .sp
  62
  63 .sp
  64 .TS
  65 box;
  66 c | c
  67 l | l .
  68 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  69 _
  70 Interface Stability     Standard
  71 _
  72 MT-Level        Unsafe
  73 .TE
  74
  75 .SH SEE ALSO
  76 .sp
  77 .LP
  78 \fBaddch\fR(3XCURSES), \fBclearok\fR(3XCURSES), \fBclrtobot\fR(3XCURSES),
  79 \fBdoupdate\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBscrl\fR(3XCURSES),
  80 \fBattributes\fR(5), \fBstandards\fR(5)