usr/src/man/man3curses/curs_util.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH CURS_UTIL 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 curs_util, unctrl, keyname, filter, use_env, putwin, getwin, delay_output,
  10 flushinp \- curses miscellaneous utility routines
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lcurses\fR [ \fIlibrary\fR ... ]
  15 #include <curses.h>
  16
  17 \fBchar *\fR\fBunctrl\fR(\fBchtype\fR \fIc\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBchar *\fR\fBkeyname\fR(\fBint\fR \fIc\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBfilter\fR(\fBvoid\fR);
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fBvoid\fR \fBuse_env\fR(\fBchar\fR \fIbool\fR);
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fBint\fR \fBputwin\fR(\fBWINDOW *\fR\fIwin\fR, \fBFILE *\fR\fIfilep\fR);
  38 .fi
  39
  40 .LP
  41 .nf
  42 \fBWINDOW *\fR\fBgetwin\fR(\fBFILE *\fR\fIfilep\fR);
  43 .fi
  44
  45 .LP
  46 .nf
  47 \fBint\fR \fBdelay_output\fR(\fBint\fR \fIms\fR);
  48 .fi
  49
  50 .LP
  51 .nf
  52 \fBint\fR \fBflushinp\fR(\fBvoid\fR);
  53 .fi
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The \fBunctrl()\fR macro expands to a character string which is a printable
  59 representation of the character \fIc\fR. Control characters are displayed in
  60 the \fB^\fR\fIX\fR notation. Printing characters are displayed as is.
  61 .sp
  62 .LP
  63 With the \fBkeyname()\fR routine, a character string corresponding to the key
  64 \fIc\fR is returned.
  65 .sp
  66 .LP
  67 The \fBfilter()\fR routine, if used, is called before \fBinitscr()\fR or
  68 \fBnewterm()\fR are called. It makes \fBcurses\fR think that there is a
  69 one-line screen. \fBcurses\fR does not use any terminal capabilities that
  70 assume that they know on what line of the screen the cursor is positioned.
  71 .sp
  72 .LP
  73 The \fBuse_env()\fR routine, if used, is called before \fBinitscr()\fR or
  74 \fBnewterm()\fR are called. When called with \fBFALSE\fR as an argument, the
  75 values of \fBlines\fR and \fBcolumns\fR specified in the \fIterminfo\fR
  76 database will be used, even if environment variables \fBLINES\fR and
  77 \fBCOLUMNS\fR (used by default) are set, or if \fBcurses\fR is running in a
  78 window (in which case default behavior would be to use the window size if
  79 \fBLINES\fR and \fBCOLUMNS\fR are not set).
  80 .sp
  81 .LP
  82 With the \fBputwin()\fR routine, all data associated with window \fIwin\fR is
  83 written into the file to which \fIfilep\fR points. This information can be
  84 later retrieved using  the \fBgetwin()\fR function.
  85 .sp
  86 .LP
  87 The \fBgetwin()\fR routine reads window related data stored in the file by
  88 \fBputwin()\fR. The routine then creates and initializes a new window using
  89 that data. It returns a pointer to the new window.
  90 .sp
  91 .LP
  92 The \fBdelay_output()\fR routine inserts an \fIms\fR millisecond pause in
  93 output. This routine should not be used extensively because padding characters
  94 are used rather than a \fBCPU\fR pause.
  95 .sp
  96 .LP
  97 The \fBflushinp()\fR routine throws away any typeahead that has been typed by
  98 the user and has not yet been read by the program.
  99 .SH RETURN VALUES
 100 .sp
 101 .LP
 102 Except for \fBflushinp()\fR, routines that return an integer return \fBERR\fR
 103 upon failure and an integer value other than \fBERR\fR upon successful
 104 completion.
 105 .sp
 106 .LP
 107 \fBflushinp()\fR always returns \fBOK\fR.
 108 .sp
 109 .LP
 110 Routines that return pointers return \fINULL\fR on error.
 111 .SH ATTRIBUTES
 112 .sp
 113 .LP
 114 See \fBattributes\fR(5) for descriptions of the following attributes:
 115 .sp
 116
 117 .sp
 118 .TS
 119 box;
 120 c | c
 121 l | l .
 122 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 123 _
 124 MT-Level        Unsafe
 125 .TE
 126
 127 .SH SEE ALSO
 128 .sp
 129 .LP
 130 \fBcurs_initscr\fR(3CURSES), \fBcurs_scr_dump\fR(3CURSES),
 131 \fBcurses\fR(3CURSES), \fBattributes\fR(5)
 132 .SH NOTES
 133 .sp
 134 .LP
 135 The header <\fBcurses.h\fR> automatically includes the headers  <\fBstdio.h\fR>
 136 and <\fBunctrl.h\fR>.
 137 .sp
 138 .LP
 139 Note that \fBunctrl()\fR is a macro, which is defined in <\fBunctrl.h\fR>.