* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_util.3x,v 1.42 2015/04/26 14:27:03 Sven.Joachim Exp @
+ * @Id: curs_util.3x,v 1.43 2015/06/06 23:36:27 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
</PRE>
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
+
+</PRE>
+<H3><a name="h3-unctrl">unctrl</a></H3><PRE>
The <STRONG>unctrl</STRONG> routine returns a character string which is a
printable representation of the character <EM>c</EM>, ignoring at-
tributes. Control characters are displayed in the <STRONG>^</STRONG><EM>X</EM> no-
corresponding <STRONG>wunctrl</STRONG> returns a printable representation
of a wide character.
+
+</PRE>
+<H3><a name="h3-keyname_key_name">keyname/key_name</a></H3><PRE>
The <STRONG>keyname</STRONG> routine returns a character string correspond-
ing to the key <EM>c</EM>:
returns null where the former would display a meta charac-
ter.
+
+</PRE>
+<H3><a name="h3-filter_nofilter">filter/nofilter</a></H3><PRE>
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>$TERM</STRONG>. The limitation arises because the <STRONG>filter</STRONG> routine
modifies the in-memory copy of the terminal information.
+
+</PRE>
+<H3><a name="h3-use_env">use_env</a></H3><PRE>
The <STRONG>use_env</STRONG> routine, if used, should be called before
<STRONG>initscr</STRONG> or <STRONG>newterm</STRONG> are called (because those compute the
screen size). It modifies the way <STRONG>ncurses</STRONG> treats environ-
SIGWINCH, unless overridden by the <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG>
environment variables,
+
+</PRE>
+<H3><a name="h3-use_tioctl">use_tioctl</a></H3><PRE>
The <STRONG>use_tioctl</STRONG> routine, if used, should be called before
<STRONG>initscr</STRONG> or <STRONG>newterm</STRONG> are called (because those compute the
screen size). After <STRONG>use_tioctl</STRONG> is called with <STRONG>TRUE</STRONG> as an
<EM>use</EM><STRONG>_</STRONG><EM>env</EM> <EM>use</EM><STRONG>_</STRONG><EM>tioctl</EM> <EM>Summary</EM>
----------------------------------------------------------------
+
+
+
TRUE FALSE This is the default behavior. ncurses
uses operating system calls unless over-
ridden by $LINES or $COLUMNS environment
variables.
TRUE TRUE ncurses updates $LINES and $COLUMNS
based on operating system calls.
-
-
FALSE TRUE ncurses ignores $LINES and $COLUMNS, us-
es operating system calls to obtain
size.
FALSE FALSE ncurses relies on the terminal database
to determine size.
+
+</PRE>
+<H3><a name="h3-putwin_getwin">putwin/getwin</a></H3><PRE>
The <STRONG>putwin</STRONG> routine writes all data associated with window
(or pad) <EM>win</EM> into the file to which <EM>filep</EM> points. This
information can be later retrieved using the <STRONG>getwin</STRONG> func-
been created in the application using <STRONG>init_pair</STRONG>, they
will not be colored when the window is refreshed.
+
+</PRE>
+<H3><a name="h3-delay_output">delay_output</a></H3><PRE>
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. If no padding character is specified, this uses
<STRONG>napms</STRONG> to perform the delay.
+
+</PRE>
+<H3><a name="h3-flushinp">flushinp</a></H3><PRE>
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.
<ul>
<li><a href="#h2-NAME">NAME</a></li>
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
-<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
+<ul>
+<li><a href="#h3-unctrl">unctrl</a></li>
+<li><a href="#h3-keyname_key_name">keyname/key_name</a></li>
+<li><a href="#h3-filter_nofilter">filter/nofilter</a></li>
+<li><a href="#h3-use_env">use_env</a></li>
+<li><a href="#h3-use_tioctl">use_tioctl</a></li>
+<li><a href="#h3-putwin_getwin">putwin/getwin</a></li>
+<li><a href="#h3-delay_output">delay_output</a></li>
+<li><a href="#h3-flushinp">flushinp</a></li>
+</ul>
+</li>
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
<li><a href="#h2-PORTABILITY">PORTABILITY</a>
<ul>
projects / ncurses.git / blobdiff