<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> <!-- **************************************************************************** * Copyright (c) 1998,2001 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * * copy of this software and associated documentation files (the * * "Software"), to deal in the Software without restriction, including * * without limitation the rights to use, copy, modify, merge, publish, * * distribute, distribute with modifications, sublicense, and/or sell * * copies of the Software, and to permit persons to whom the Software is * * furnished to do so, subject to the following conditions: * * * * The above copyright notice and this permission notice shall be included * * in all copies or substantial portions of the Software. * * * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * * * * Except as contained in this notice, the name(s) of the above copyright * * holders shall not be used in advertising or otherwise to promote the * * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** * @Id: curs_util.3x,v 1.7 2001/08/04 20:36:14 William.Setzer Exp @ --> <HTML> <HEAD> <TITLE>curs_util 3x</TITLE><link rev=made href="mailto:bug-ncurses@gnu.org"> </HEAD> <BODY> <H1>curs_util 3x</H1> <HR> <PRE> <!-- Manpage converted by man2html 3.0.1 --> </PRE> <H2>NAME</H2><PRE> <STRONG>unctrl</STRONG>, <STRONG>keyname</STRONG>, <STRONG>filter</STRONG>, <STRONG>use_env</STRONG>, <STRONG>putwin</STRONG>, <STRONG>getwin</STRONG>, <STRONG>delay_output</STRONG>, <STRONG>flushinp</STRONG> - miscellaneous <STRONG>curses</STRONG> utility rou- tines </PRE> <H2>SYNOPSIS</H2><PRE> <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> <STRONG>char</STRONG> <STRONG>*unctrl(chtype</STRONG> <STRONG>c);</STRONG> <STRONG>char</STRONG> <STRONG>*keyname(int</STRONG> <STRONG>c);</STRONG> <STRONG>void</STRONG> <STRONG>filter(void);</STRONG> <STRONG>void</STRONG> <STRONG>use_env(bool</STRONG> <STRONG>f);</STRONG> <STRONG>int</STRONG> <STRONG>putwin(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>FILE</STRONG> <STRONG>*filep);</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*getwin(FILE</STRONG> <STRONG>*filep);</STRONG> <STRONG>int</STRONG> <STRONG>delay_output(int</STRONG> <STRONG>ms);</STRONG> <STRONG>int</STRONG> <STRONG>flushinp(void);</STRONG> </PRE> <H2>DESCRIPTION</H2><PRE> The <STRONG>unctrl</STRONG> macro expands to a character string which is a printable representation of the character <EM>c</EM>. Control characters are displayed in the <STRONG>^</STRONG><EM>X</EM> notation. Printing characters are displayed as is. The <STRONG>keyname</STRONG> routine returns a character string correspond- ing to the key <EM>c</EM>. The <STRONG>filter</STRONG> routine, if used, must be called before <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG> are called. The effect is that, during those calls, <STRONG>LINES</STRONG> is set to 1; the capabilities <STRONG>clear</STRONG>, <STRONG>cup</STRONG>, <STRONG>cud</STRONG>, <STRONG>cud1</STRONG>, <STRONG>cuu1</STRONG>, <STRONG>cuu</STRONG>, <STRONG>vpa</STRONG> are disabled; and the <STRONG>home</STRONG> string is set to the value of <STRONG>cr</STRONG>. The <STRONG>use_env</STRONG> routine, if used, is called before <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG> are called. When called with <STRONG>FALSE</STRONG> as an argu- ment, the values of <STRONG>lines</STRONG> and <STRONG>columns</STRONG> specified in the <EM>terminfo</EM> database will be used, even if environment vari- ables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> (used by default) are set, or if <STRONG>curses</STRONG> is running in a window (in which case default behavior would be to use the window size if <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> are not set). The <STRONG>putwin</STRONG> routine writes all data associated with window <EM>win</EM> into the file to which <EM>filep</EM> points. This information can be later retrieved using the <STRONG>getwin</STRONG> function. The <STRONG>getwin</STRONG> routine reads window related data stored in the file by <STRONG>putwin</STRONG>. The routine then creates and initializes a new window using that data. It returns a pointer to the new window. The <STRONG>delay_output</STRONG> routine inserts an <EM>ms</EM> millisecond pause in output. This routine should not be used extensively because padding characters are used rather than a CPU pause. The <STRONG>flushinp</STRONG> routine throws away any typeahead that has been typed by the user and has not yet been read by the program. </PRE> <H2>RETURN VALUE</H2><PRE> Except for <STRONG>flushinp</STRONG>, routines that return an integer return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 specifies only "an integer value other than <STRONG>ERR</STRONG>") upon successful completion. <STRONG>flushinp</STRONG> always returns <STRONG>OK</STRONG>. Routines that return pointers return <STRONG>NULL</STRONG> on error. </PRE> <H2>PORTABILITY</H2><PRE> The XSI Curses standard, Issue 4 describes these func- tions. The SVr4 documentation describes the action of <STRONG>filter</STRONG> only in the vaguest terms. The description here is adapted from the XSI Curses standard (which erroneously fails to describe the disabling of <STRONG>cuu</STRONG>). </PRE> <H2>NOTES</H2><PRE> Note that <STRONG>unctrl</STRONG> is a macro, which is defined in <<STRONG>unc-</STRONG> <STRONG>trl.h</STRONG>>. </PRE> <H2>SEE ALSO</H2><PRE> <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>. </PRE> <HR> <ADDRESS> Man(1) output converted with <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> </ADDRESS> </BODY> </HTML>