mirror of
https://github.com/ThomasDickey/ncurses-snapshots.git
synced 2026-01-26 19:09:16 +00:00
snapshot of project "ncurses", label v6_0_20160130
This commit is contained in:
Thomas E. Dickey
parent
451863f384
commit
fea235bcdd
7
NEWS
7
NEWS
@ -25,7 +25,7 @@
|
||||
-- sale, use or other dealings in this Software without prior written --
|
||||
-- authorization. --
|
||||
-------------------------------------------------------------------------------
|
||||
-- $Id: NEWS,v 1.2564 2016/01/24 01:17:56 tom Exp $
|
||||
-- $Id: NEWS,v 1.2566 2016/01/30 19:38:41 tom Exp $
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
This is a log of changes that ncurses has gone through since Zeyd started
|
||||
@ -45,6 +45,11 @@ See the AUTHORS file for the corresponding full names.
|
||||
Changes through 1.9.9e did not credit all contributions;
|
||||
it is not possible to add this information.
|
||||
|
||||
20160130
|
||||
+ improve formatting of man/curs_refresh.3x and man/tset.1 manpages
|
||||
+ regenerate HTML manpages using newer man2html to eliminate some
|
||||
unwanted blank lines.
|
||||
|
||||
20160123
|
||||
+ ifdef'd header-file definition of mouse_trafo() with NCURSES_NOMACROS
|
||||
(report by Corey Minyard).
|
||||
|
||||
4
dist.mk
4
dist.mk
@ -25,7 +25,7 @@
|
||||
# use or other dealings in this Software without prior written #
|
||||
# authorization. #
|
||||
##############################################################################
|
||||
# $Id: dist.mk,v 1.1090 2016/01/23 17:00:00 tom Exp $
|
||||
# $Id: dist.mk,v 1.1091 2016/01/30 15:30:48 tom Exp $
|
||||
# Makefile for creating ncurses distributions.
|
||||
#
|
||||
# This only needs to be used directly as a makefile by developers, but
|
||||
@ -37,7 +37,7 @@ SHELL = /bin/sh
|
||||
# These define the major/minor/patch versions of ncurses.
|
||||
NCURSES_MAJOR = 6
|
||||
NCURSES_MINOR = 0
|
||||
NCURSES_PATCH = 20160123
|
||||
NCURSES_PATCH = 20160130
|
||||
|
||||
# We don't append the patch to the version, since this only applies to releases
|
||||
VERSION = $(NCURSES_MAJOR).$(NCURSES_MINOR)
|
||||
|
||||
@ -46,19 +46,16 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>captoinfo</STRONG> - convert a <EM>termcap</EM> description into a <EM>terminfo</EM>
|
||||
description
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>captoinfo</STRONG> [<STRONG>-v</STRONG><EM>n</EM> <EM>width</EM>] [<STRONG>-V</STRONG>] [<STRONG>-1</STRONG>] [<STRONG>-w</STRONG> <EM>width</EM>] <EM>file</EM> . . .
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
<STRONG>captoinfo</STRONG> looks in each given text <EM>file</EM> for <STRONG>termcap</STRONG>
|
||||
descriptions. For each one found, an equivalent <STRONG>terminfo</STRONG>
|
||||
description is written to standard output. Termcap <STRONG>tc</STRONG>
|
||||
@ -85,14 +82,12 @@
|
||||
<STRONG>-w</STRONG> change the output to <EM>width</EM> characters.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-FILES">FILES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
|
||||
/usr/share/terminfo Compiled terminal description data-
|
||||
base.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-TRANSLATIONS-FROM-NONSTANDARD-CAPABILITIES">TRANSLATIONS FROM NONSTANDARD CAPABILITIES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-TRANSLATIONS-FROM-NONSTANDARD-CAPABILITIES">TRANSLATIONS FROM NONSTANDARD CAPABILITIES</a></H2><PRE>
|
||||
Some obsolete nonstandard capabilities will automatically
|
||||
be translated into standard (SVr4/XSI Curses) terminfo
|
||||
capabilities by <STRONG>captoinfo</STRONG>. Whenever one of these auto-
|
||||
@ -191,8 +186,7 @@
|
||||
message.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
This utility is actually a link to <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, running in <EM>-I</EM>
|
||||
mode. You can use other <STRONG>tic</STRONG> options such as <STRONG>-f</STRONG> and <STRONG>-x</STRONG>.
|
||||
|
||||
@ -201,15 +195,13 @@
|
||||
repeat it n times.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
|
||||
|
||||
This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20151205).
|
||||
This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20160130).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
Eric S. Raymond <esr@snark.thyrsus.com> and
|
||||
Thomas E. Dickey <dickey@invisible-island.net>
|
||||
|
||||
|
||||
@ -45,18 +45,15 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>clear</STRONG> - clear the terminal screen
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>clear</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
<STRONG>clear</STRONG> clears your screen if this is possible, including
|
||||
its scrollback buffer (if the extended "E3" capability is
|
||||
defined). <STRONG>clear</STRONG> looks in the environment for the terminal
|
||||
@ -67,11 +64,10 @@
|
||||
present.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
|
||||
|
||||
This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20151205).
|
||||
This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20160130).
|
||||
|
||||
|
||||
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>add_wch</STRONG>, <STRONG>wadd_wch</STRONG>, <STRONG>mvadd_wch</STRONG>, <STRONG>mvwadd_wch</STRONG>, <STRONG>echo_wchar</STRONG>,
|
||||
<STRONG>wecho_wchar</STRONG> - add a complex character and rendition to a
|
||||
<STRONG>curses</STRONG> window, then advance the cursor
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>add_wch(</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
|
||||
@ -65,11 +63,9 @@
|
||||
<STRONG>int</STRONG> <STRONG>wecho_wchar(</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-add_wch">add_wch</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-add_wch">add_wch</a></H3><PRE>
|
||||
The <STRONG>add_wch</STRONG>, <STRONG>wadd_wch</STRONG>, <STRONG>mvadd_wch</STRONG>, and <STRONG>mvwadd_wch</STRONG> functions
|
||||
put the complex character <EM>wch</EM> into the given window at its
|
||||
current position, which is then advanced. These functions
|
||||
@ -93,8 +89,7 @@
|
||||
updated and the cursor moves as if <STRONG>addch</STRONG> were called.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-echo_wchar">echo_wchar</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-echo_wchar">echo_wchar</a></H3><PRE>
|
||||
The <STRONG>echo_wchar</STRONG> function is functionally equivalent to a
|
||||
call to <STRONG>add_wch</STRONG> followed by a call to <STRONG>refresh</STRONG>. Similarly,
|
||||
the <STRONG>wecho_wchar</STRONG> is functionally equivalent to a call to
|
||||
@ -105,8 +100,7 @@
|
||||
functions instead of their equivalents.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Line-Graphics">Line Graphics</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Line-Graphics">Line Graphics</a></H3><PRE>
|
||||
Like <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>, <STRONG>addch_wch</STRONG> accepts symbols which make it
|
||||
simple to draw lines and other frequently used special
|
||||
characters. These symbols correspond to the same VT100
|
||||
@ -177,8 +171,7 @@
|
||||
WACS_D_PLUS 0x256c + double large plus or crossover
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on
|
||||
success.
|
||||
|
||||
@ -187,14 +180,12 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>add_wch</STRONG>, <STRONG>mvadd_wch</STRONG>, <STRONG>mvwadd_wch</STRONG>, and <STRONG>echo_wchar</STRONG>
|
||||
may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
All of these functions are described in the XSI Curses
|
||||
standard, Issue 4. The defaults specified for line-draw-
|
||||
ing characters apply in the POSIX locale.
|
||||
@ -220,8 +211,7 @@
|
||||
definitions which are not in the SVr4 implementations.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>, <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>,
|
||||
<STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG>putwc(3)</STRONG>
|
||||
|
||||
|
||||
@ -45,16 +45,14 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>add_wchstr</STRONG>, <STRONG>add_wchnstr</STRONG>, <STRONG>wadd_wchstr</STRONG>, <STRONG>wadd_wchnstr</STRONG>,
|
||||
<STRONG>mvadd_wchstr</STRONG>, <STRONG>mvadd_wchnstr</STRONG>, <STRONG>mvwadd_wchstr</STRONG>, <STRONG>mvwadd_wchnstr</STRONG>
|
||||
- add an array of complex characters (and attributes) to a
|
||||
curses window
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>add_wchstr(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG>
|
||||
@ -67,8 +65,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>mvwadd_wchnstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These functions copy the (null-terminated) array of com-
|
||||
plex characters <EM>wchstr</EM> into the window image structure
|
||||
starting at the current cursor position. The four func-
|
||||
@ -98,8 +95,7 @@
|
||||
background character and rendition.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All functions return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG>
|
||||
on success.
|
||||
|
||||
@ -111,19 +107,16 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
All functions except <STRONG>wadd_wchnstr</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These entry points are described in the XSI Curses stan-
|
||||
dard, Issue 4.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
|
||||
|
||||
Comparable functions in the narrow-character (ncurses) li-
|
||||
|
||||
@ -46,15 +46,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>addch</STRONG>, <STRONG>waddch</STRONG>, <STRONG>mvaddch</STRONG>, <STRONG>mvwaddch</STRONG>, <STRONG>echochar</STRONG>, <STRONG>wechochar</STRONG> -
|
||||
add a character (with attributes) to a <STRONG>curses</STRONG> window, then
|
||||
advance the cursor
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>addch(const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
|
||||
@ -65,11 +63,9 @@
|
||||
<STRONG>int</STRONG> <STRONG>wechochar(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Adding-characters">Adding characters</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Adding-characters">Adding characters</a></H3><PRE>
|
||||
The <STRONG>addch</STRONG>, <STRONG>waddch</STRONG>, <STRONG>mvaddch</STRONG> and <STRONG>mvwaddch</STRONG> routines put the
|
||||
character <EM>ch</EM> into the given window at its current window
|
||||
position, which is then advanced. They are analogous to
|
||||
@ -119,8 +115,7 @@
|
||||
into characters.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Echoing-characters">Echoing characters</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Echoing-characters">Echoing characters</a></H3><PRE>
|
||||
The <STRONG>echochar</STRONG> and <STRONG>wechochar</STRONG> routines are equivalent to a
|
||||
call to <STRONG>addch</STRONG> followed by a call to <STRONG>refresh</STRONG>, or a call to
|
||||
<STRONG>waddch</STRONG> followed by a call to <STRONG>wrefresh</STRONG>. The knowledge that
|
||||
@ -130,8 +125,7 @@
|
||||
equivalents.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Line-Graphics">Line Graphics</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Line-Graphics">Line Graphics</a></H3><PRE>
|
||||
The following variables may be used to add line drawing
|
||||
characters to the screen with routines of the <STRONG>addch</STRONG> fam-
|
||||
ily. The default character listed below is used if the
|
||||
@ -178,8 +172,7 @@
|
||||
ACS_VLINE | vertical line
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on
|
||||
success (the SVr4 manuals specify only "an integer value
|
||||
other than <STRONG>ERR</STRONG>") upon successful completion, unless other-
|
||||
@ -190,14 +183,12 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>addch</STRONG>, <STRONG>mvaddch</STRONG>, <STRONG>mvwaddch</STRONG>, and <STRONG>echochar</STRONG> may be
|
||||
macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
All these functions are described in the XSI Curses stan-
|
||||
dard, Issue 4. The defaults specified for forms-drawing
|
||||
characters apply in the POSIX locale.
|
||||
@ -237,8 +228,7 @@
|
||||
of other implementations, but is not documented.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>, <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>,
|
||||
<STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>,
|
||||
<STRONG>putc(3)</STRONG>.
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>addchstr</STRONG>, <STRONG>addchnstr</STRONG>, <STRONG>waddchstr</STRONG>, <STRONG>waddchnstr</STRONG>, <STRONG>mvaddchstr</STRONG>,
|
||||
<STRONG>mvaddchnstr</STRONG>, <STRONG>mvwaddchstr</STRONG>, <STRONG>mvwaddchnstr</STRONG> - add a string of
|
||||
characters (and attributes) to a <STRONG>curses</STRONG> window
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>addchstr(const</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr);</STRONG>
|
||||
@ -66,8 +64,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>mvwaddchnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These functions copy the (null-terminated) <EM>chstr</EM> array in-
|
||||
to the window image structure starting at the current cur-
|
||||
sor position. The four functions with <EM>n</EM> as the last argu-
|
||||
@ -90,8 +87,7 @@
|
||||
gin, rather than wrapping it around to the new line.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All functions return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG>
|
||||
on success.
|
||||
|
||||
@ -103,19 +99,16 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
All functions except <STRONG>waddchnstr</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These entry points are described in the XSI Curses stan-
|
||||
dard, Issue 4.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
|
||||
|
||||
Comparable functions in the wide-character (ncursesw) li-
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>addstr</STRONG>, <STRONG>addnstr</STRONG>, <STRONG>waddstr</STRONG>, <STRONG>waddnstr</STRONG>, <STRONG>mvaddstr</STRONG>, <STRONG>mvaddnstr</STRONG>,
|
||||
<STRONG>mvwaddstr</STRONG>, <STRONG>mvwaddnstr</STRONG> - add a string of characters to a
|
||||
<STRONG>curses</STRONG> window and advance cursor
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>addstr(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
|
||||
@ -66,8 +64,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>mvwaddnstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str,</EM> <EM>int</EM> <EM>n</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These functions write the (null-terminated) character
|
||||
string <EM>str</EM> on the given window. It is similar to calling
|
||||
<STRONG>waddch</STRONG> once for each character in the string.
|
||||
@ -81,8 +78,7 @@
|
||||
If <EM>n</EM> is -1, then the entire string will be added.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All functions return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG>
|
||||
on success.
|
||||
|
||||
@ -100,19 +96,16 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
All of these functions except <STRONG>waddnstr</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are described in the XSI Curses standard,
|
||||
Issue 4.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>.
|
||||
|
||||
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>addwstr</STRONG>, <STRONG>addnwstr</STRONG>, <STRONG>waddwstr</STRONG>, <STRONG>waddnwstr</STRONG>, <STRONG>mvaddwstr</STRONG>,
|
||||
<STRONG>mvaddnwstr</STRONG>, <STRONG>mvwaddwstr</STRONG>, <STRONG>mvwaddnwstr</STRONG> - add a string of wide
|
||||
characters to a <STRONG>curses</STRONG> window and advance cursor
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>addwstr(const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
|
||||
@ -66,8 +64,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>mvwaddnwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These functions write the characters of the (null-termi-
|
||||
nated) <STRONG>wchar_t</STRONG> character string <EM>wstr</EM> on the given window.
|
||||
It is similar to constructing a <STRONG>cchar_t</STRONG> for each wchar_t
|
||||
@ -84,8 +81,7 @@
|
||||
added.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All functions return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG>
|
||||
on success.
|
||||
|
||||
@ -104,19 +100,16 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
All of these functions except <STRONG>waddnwstr</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are described in the XSI Curses standard,
|
||||
Issue 4.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>
|
||||
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@
|
||||
* sale, use or other dealings in this Software without prior written *
|
||||
* authorization. *
|
||||
****************************************************************************
|
||||
* @Id: curs_attr.3x,v 1.43 2015/12/05 18:46:04 tom Exp @
|
||||
* @Id: curs_attr.3x,v 1.44 2015/12/13 21:54:05 tom Exp @
|
||||
-->
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
|
||||
<HTML>
|
||||
@ -46,8 +46,7 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>attroff</STRONG>, <STRONG>wattroff</STRONG>, <STRONG>attron</STRONG>, <STRONG>wattron</STRONG>, <STRONG>attrset</STRONG>, <STRONG>wattrset</STRONG>,
|
||||
<STRONG>color_set</STRONG>, <STRONG>wcolor_set</STRONG>, <STRONG>standend</STRONG>, <STRONG>wstandend</STRONG>, <STRONG>standout</STRONG>,
|
||||
<STRONG>wstandout</STRONG>, <STRONG>attr_get</STRONG>, <STRONG>wattr_get</STRONG>, <STRONG>attr_off</STRONG>, <STRONG>wattr_off</STRONG>,
|
||||
@ -56,8 +55,7 @@
|
||||
window attribute control routines
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
<STRONG>int</STRONG> <STRONG>attroff(int</STRONG> <EM>attrs);</EM>
|
||||
<STRONG>int</STRONG> <STRONG>wattroff(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>attrs</EM><STRONG>);</STRONG>
|
||||
@ -93,8 +91,7 @@
|
||||
<STRONG>PAIR_NUMBER(</STRONG><EM>attrs</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These routines manipulate the current attributes of the
|
||||
named window. The current attributes of a window apply to
|
||||
all characters that are written into the window with <STRONG>wadd-</STRONG>
|
||||
@ -106,8 +103,7 @@
|
||||
on the screen.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-attrset">attrset</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-attrset">attrset</a></H3><PRE>
|
||||
The routine <STRONG>attrset</STRONG> sets the current attributes of the
|
||||
given window to <EM>attrs</EM>. The routine <STRONG>attroff</STRONG> turns off the
|
||||
named attributes without turning any other attributes on
|
||||
@ -123,8 +119,7 @@
|
||||
used for erasing and clearing.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-attr_set">attr_set</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-attr_set">attr_set</a></H3><PRE>
|
||||
The <STRONG>attrset</STRONG> routine is actually a legacy feature predating
|
||||
SVr4 curses but kept in X/Open Curses for the same reason
|
||||
that SVr4 curses kept it: compatibility. The routine <STRONG>at-</STRONG>
|
||||
@ -135,16 +130,14 @@
|
||||
ments of type <STRONG>attr_t</STRONG> rather than <STRONG>int</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-color_set">color_set</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-color_set">color_set</a></H3><PRE>
|
||||
The routine <STRONG>color_set</STRONG> sets the current color of the given
|
||||
window to the foreground/background combination described
|
||||
by the color_pair_number. The parameter opts is reserved
|
||||
for future use, applications must supply a null pointer.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-attr_get">attr_get</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-attr_get">attr_get</a></H3><PRE>
|
||||
The routine <STRONG>wattr_get</STRONG> returns the current attribute and
|
||||
color pair for the given window; <STRONG>attr_get</STRONG> returns the cur-
|
||||
rent attribute and color pair for <STRONG>stdscr</STRONG>.
|
||||
@ -154,8 +147,7 @@
|
||||
<STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-chgat">chgat</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-chgat">chgat</a></H3><PRE>
|
||||
The routine <STRONG>chgat</STRONG> changes the attributes of a given number
|
||||
of characters starting at the current cursor location of
|
||||
<STRONG>stdscr</STRONG>. It does not update the cursor and does not per-
|
||||
@ -170,8 +162,7 @@
|
||||
(leave it <STRONG>NULL</STRONG>).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Attributes">Attributes</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Attributes">Attributes</a></H3><PRE>
|
||||
The following video attributes, defined in <STRONG><curses.h></STRONG>, can
|
||||
be passed to the routines <STRONG>attron</STRONG>, <STRONG>attroff</STRONG>, and <STRONG>attrset</STRONG>, or
|
||||
OR'd with the characters passed to <STRONG>addch</STRONG> (see <STRONG>curs_add-</STRONG>
|
||||
@ -220,8 +211,7 @@
|
||||
claims (falsely) that these routines always return <STRONG>1</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>attroff</STRONG>, <STRONG>wattroff</STRONG>, <STRONG>attron</STRONG>, <STRONG>wattron</STRONG>, <STRONG>attrset</STRONG>,
|
||||
<STRONG>wattrset</STRONG>, <STRONG>standend</STRONG> and <STRONG>standout</STRONG> may be macros.
|
||||
|
||||
@ -233,8 +223,7 @@
|
||||
support more than 256 color pairs.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are supported in the XSI Curses standard,
|
||||
Issue 4. The standard defined the dedicated type for
|
||||
highlights, <STRONG>attr_t</STRONG>, which is not defined in SVr4 curses.
|
||||
@ -289,8 +278,7 @@
|
||||
(i.e., via the <STRONG>sgr1</STRONG> capability).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All routines return the integer <STRONG>OK</STRONG> on success, or <STRONG>ERR</STRONG> on
|
||||
failure.
|
||||
|
||||
@ -307,8 +295,7 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>, <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>,
|
||||
<STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>, <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
|
||||
|
||||
|
||||
@ -45,21 +45,18 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>beep</STRONG>, <STRONG>flash</STRONG> - <STRONG>curses</STRONG> bell and screen flash routines
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>beep(void);</STRONG>
|
||||
<STRONG>int</STRONG> <STRONG>flash(void);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <STRONG>beep</STRONG> and <STRONG>flash</STRONG> routines are used to alert the terminal
|
||||
user. The routine <STRONG>beep</STRONG> sounds an audible alarm on the
|
||||
terminal, if possible; otherwise it flashes the screen
|
||||
@ -70,27 +67,23 @@
|
||||
flash the screen.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
These routines return <STRONG>OK</STRONG> if they succeed in beeping or
|
||||
flashing, <STRONG>ERR</STRONG> otherwise.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
|
||||
SVr4's beep and flash routines always returned <STRONG>OK</STRONG>, so it
|
||||
was not possible to tell when the beep or flash failed.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are described in the XSI Curses standard,
|
||||
Issue 4. Like SVr4, it specifies that they always return
|
||||
<STRONG>OK</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
|
||||
|
||||
|
||||
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>bkgdset</STRONG>, <STRONG>wbkgdset</STRONG>, <STRONG>bkgd</STRONG>, <STRONG>wbkgd</STRONG>, <STRONG>getbkgd</STRONG> - <STRONG>curses</STRONG> window
|
||||
background manipulation routines
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>void</STRONG> <STRONG>bkgdset(chtype</STRONG> <EM>ch</EM><STRONG>);</STRONG>
|
||||
@ -62,11 +60,9 @@
|
||||
<STRONG>chtype</STRONG> <STRONG>getbkgd(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-bkgdset">bkgdset</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-bkgdset">bkgdset</a></H3><PRE>
|
||||
The <STRONG>bkgdset</STRONG> and <STRONG>wbkgdset</STRONG> routines manipulate the back-
|
||||
ground of the named window. The window background is a
|
||||
<STRONG>chtype</STRONG> consisting of any combination of attributes (i.e.,
|
||||
@ -84,8 +80,7 @@
|
||||
graphic rendition of the character put on the screen.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-bkgd">bkgd</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-bkgd">bkgd</a></H3><PRE>
|
||||
The <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> functions set the background property
|
||||
of the current or specified window and then apply this
|
||||
setting to every character position in that window:
|
||||
@ -97,33 +92,28 @@
|
||||
is changed to the new background character.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-getbkgd">getbkgd</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-getbkgd">getbkgd</a></H3><PRE>
|
||||
The <STRONG>getbkgd</STRONG> function returns the given window's current
|
||||
background character/attribute pair.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The routines <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> return the integer <STRONG>OK</STRONG>. The
|
||||
SVr4.0 manual says "or a non-negative integer if <STRONG>immedok</STRONG>
|
||||
is set", but this appears to be an error.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>bkgdset</STRONG> and <STRONG>bkgd</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are described in the XSI Curses standard,
|
||||
Issue 4. It specifies that <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> return <STRONG>ERR</STRONG> on
|
||||
failure, but gives no failure conditions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>, <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG>curs_out-</STRONG>
|
||||
<STRONG><A HREF="curs_outopts.3x.html">opts(3x)</A></STRONG>
|
||||
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>bkgrnd</STRONG>, <STRONG>wbkgrnd</STRONG>, <STRONG>bkgrndset</STRONG>, <STRONG>wbkgrndset</STRONG>, <STRONG>getbkgrnd</STRONG>, <STRONG>wget-</STRONG>
|
||||
<STRONG>bkgrnd</STRONG> - <STRONG>curses</STRONG> window complex background manipulation
|
||||
routines
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>bkgrnd(</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
|
||||
@ -64,11 +62,9 @@
|
||||
<STRONG>int</STRONG> <STRONG>wgetbkgrnd(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-bkgrndset">bkgrndset</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-bkgrndset">bkgrndset</a></H3><PRE>
|
||||
The <STRONG>bkgrndset</STRONG> and <STRONG>wbkgrndset</STRONG> routines manipulate the back-
|
||||
ground of the named window. The window background is a
|
||||
<STRONG>cchar_t</STRONG> consisting of any combination of attributes (i.e.,
|
||||
@ -86,8 +82,7 @@
|
||||
graphic rendition of the character put on the screen.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-bkgrnd">bkgrnd</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-bkgrnd">bkgrnd</a></H3><PRE>
|
||||
The <STRONG>bkgrnd</STRONG> and <STRONG>wbkgrnd</STRONG> functions set the background prop-
|
||||
erty of the current or specified window and then apply
|
||||
this setting to every character position in that window:
|
||||
@ -99,19 +94,16 @@
|
||||
is changed to the new background character.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-getbkgrnd">getbkgrnd</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-getbkgrnd">getbkgrnd</a></H3><PRE>
|
||||
The <STRONG>getbkgrnd</STRONG> function returns the given window's current
|
||||
background character/attribute pair via the <STRONG>wch</STRONG> pointer.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>bkgrnd</STRONG>, <STRONG>bkgrndset</STRONG>, and <STRONG>getbkgrnd</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The <STRONG>bkgrndset</STRONG> and <STRONG>wbkgrndset</STRONG> routines do not return a
|
||||
value.
|
||||
|
||||
@ -120,8 +112,7 @@
|
||||
treated as an error.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
|
||||
|
||||
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>border</STRONG>, <STRONG>wborder</STRONG>, <STRONG>box</STRONG>, <STRONG>hline</STRONG>, <STRONG>whline</STRONG>, <STRONG>vline</STRONG>, <STRONG>wvline</STRONG>,
|
||||
<STRONG>mvhline</STRONG>, <STRONG>mvwhline</STRONG>, <STRONG>mvvline</STRONG>, <STRONG>mvwvline</STRONG> - create <STRONG>curses</STRONG>
|
||||
borders, horizontal and vertical lines
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
<STRONG>int</STRONG> <STRONG>border(chtype</STRONG> <STRONG>ls,</STRONG> <STRONG>chtype</STRONG> <STRONG>rs,</STRONG> <STRONG>chtype</STRONG> <STRONG>ts,</STRONG> <STRONG>chtype</STRONG> <STRONG>bs,</STRONG>
|
||||
<STRONG>chtype</STRONG> <STRONG>tl,</STRONG> <STRONG>chtype</STRONG> <STRONG>tr,</STRONG> <STRONG>chtype</STRONG> <STRONG>bl,</STRONG> <STRONG>chtype</STRONG> <STRONG>br);</STRONG>
|
||||
@ -71,8 +69,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>mvwvline(WINDOW</STRONG> <STRONG>*,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <STRONG>border</STRONG>, <STRONG>wborder</STRONG> and <STRONG>box</STRONG> routines draw a box around the
|
||||
edges of a window. Other than the window, each argument
|
||||
is a character with attributes:
|
||||
@ -115,8 +112,7 @@
|
||||
many as fit into the window.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All routines return the integer <STRONG>OK</STRONG>. The SVr4.0 manual
|
||||
says "or a non-negative integer if <STRONG>immedok</STRONG> is set", but
|
||||
this appears to be an error.
|
||||
@ -129,8 +125,7 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The borders generated by these functions are <EM>inside</EM> bor-
|
||||
ders (this is also true of SVr4 curses, though the fact is
|
||||
not documented).
|
||||
@ -138,15 +133,13 @@
|
||||
Note that <STRONG>border</STRONG> and <STRONG>box</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are described in the XSI Curses standard,
|
||||
Issue 4. The standard specifies that they return <STRONG>ERR</STRONG> on
|
||||
failure, but specifies no error conditions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>.
|
||||
|
||||
|
||||
|
||||
@ -45,16 +45,14 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>border_set</STRONG>, <STRONG>wborder_set</STRONG>, <STRONG>box_set</STRONG>, <STRONG>hline_set</STRONG>, <STRONG>whline_set</STRONG>,
|
||||
<STRONG>mvhline_set</STRONG>, <STRONG>mvwhline_set</STRONG>, <STRONG>vline_set</STRONG>, <STRONG>wvline_set</STRONG>,
|
||||
<STRONG>mvvline_set</STRONG>, <STRONG>mvwvline_set</STRONG> - create <STRONG>curses</STRONG> borders or lines
|
||||
using complex characters and renditions
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>border_set(</STRONG>
|
||||
@ -98,8 +96,7 @@
|
||||
<STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM>, <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <STRONG>border_set</STRONG> and <STRONG>wborder_set</STRONG> functions draw a border
|
||||
around the edges of the current or specified window.
|
||||
These functions do not change the cursor position, and do
|
||||
@ -147,14 +144,12 @@
|
||||
the window.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>border_set</STRONG>, <STRONG>hline_set</STRONG>, <STRONG>mvhline_set</STRONG>, <STRONG>mvvline_set</STRONG>,
|
||||
<STRONG>mvwhline_set</STRONG>, <STRONG>mvwvline_set</STRONG>, and <STRONG>vline_set</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Upon successful completion, these functions return <STRONG>OK</STRONG>.
|
||||
Otherwise, they return <STRONG>ERR</STRONG>.
|
||||
|
||||
@ -166,8 +161,7 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>, <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG>, <STRONG>curs_out-</STRONG>
|
||||
<STRONG><A HREF="curs_outopts.3x.html">opts(3x)</A></STRONG>
|
||||
|
||||
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>erase</STRONG>, <STRONG>werase</STRONG>, <STRONG>clear</STRONG>, <STRONG>wclear</STRONG>, <STRONG>clrtobot</STRONG>, <STRONG>wclrtobot</STRONG>,
|
||||
<STRONG>clrtoeol</STRONG>, <STRONG>wclrtoeol</STRONG> - clear all or part of a <STRONG>curses</STRONG> window
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#</STRONG> <STRONG>include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>erase(void);</STRONG>
|
||||
@ -65,8 +63,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>wclrtoeol(WINDOW</STRONG> <STRONG>*win);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <STRONG>erase</STRONG> and <STRONG>werase</STRONG> routines copy blanks to every posi-
|
||||
tion in the window, clearing the screen.
|
||||
|
||||
@ -88,8 +85,7 @@
|
||||
dition (as set by <STRONG>wbkgdset</STRONG>) merged into them.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All routines return the integer <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> on
|
||||
failure. The SVr4.0 manual says "or a non-negative inte-
|
||||
ger if <STRONG>immedok</STRONG> is set", but this appears to be an error.
|
||||
@ -99,14 +95,12 @@
|
||||
error if it is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>erase</STRONG>, <STRONG>werase</STRONG>, <STRONG>clear</STRONG>, <STRONG>wclear</STRONG>, <STRONG>clrtobot</STRONG>, and <STRONG>clr-</STRONG>
|
||||
<STRONG>toeol</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are described in the XSI Curses standard,
|
||||
Issue 4. The standard specifies that they return <STRONG>ERR</STRONG> on
|
||||
failure, but specifies no error conditions.
|
||||
@ -128,8 +122,7 @@
|
||||
ing the next <STRONG>wrefresh</STRONG>, use <STRONG>werase</STRONG> instead.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG>curs_vari-</STRONG>
|
||||
<STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG>
|
||||
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>start_color</STRONG>, <STRONG>init_pair</STRONG>, <STRONG>init_color</STRONG>, <STRONG>has_colors</STRONG>,
|
||||
<STRONG>can_change_color</STRONG>, <STRONG>color_content</STRONG>, <STRONG>pair_content</STRONG>, <STRONG>COLOR_PAIR</STRONG>
|
||||
- <STRONG>curses</STRONG> color manipulation routines
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#</STRONG> <STRONG>include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>start_color(void);</STRONG>
|
||||
@ -67,11 +65,9 @@
|
||||
<STRONG>int</STRONG> <STRONG>COLOR_PAIR(int</STRONG> <STRONG>n);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Overview">Overview</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Overview">Overview</a></H3><PRE>
|
||||
<STRONG>curses</STRONG> supports color attributes on terminals with that
|
||||
capability. To use these routines <STRONG>start_color</STRONG> must be
|
||||
called, usually right after <STRONG>initscr</STRONG>. Colors are always
|
||||
@ -95,8 +91,7 @@
|
||||
how a given color-pair is currently defined.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Color-Rendering">Color Rendering</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Color-Rendering">Color Rendering</a></H3><PRE>
|
||||
The <STRONG>curses</STRONG> library combines these inputs to produce the
|
||||
actual foreground and background colors shown on the
|
||||
screen:
|
||||
@ -141,8 +136,7 @@
|
||||
background character.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Routine-Descriptions">Routine Descriptions</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Routine-Descriptions">Routine Descriptions</a></H3><PRE>
|
||||
The <STRONG>start_color</STRONG> routine requires no arguments. It must be
|
||||
called if the programmer wants to use colors, and before
|
||||
any other color manipulation routine is called. It is
|
||||
@ -275,8 +269,7 @@
|
||||
through <STRONG>COLORS</STRONG>, inclusive.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Colors">Colors</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Colors">Colors</a></H3><PRE>
|
||||
In <STRONG><curses.h></STRONG> the following macros are defined. These are
|
||||
the standard colors (ISO-6429). <STRONG>curses</STRONG> also assumes that
|
||||
<STRONG>COLOR_BLACK</STRONG> is the default background color for all termi-
|
||||
@ -292,8 +285,7 @@
|
||||
<STRONG>COLOR_WHITE</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The routines <STRONG>can_change_color()</STRONG> and <STRONG>has_colors()</STRONG> return
|
||||
<STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>.
|
||||
|
||||
@ -321,8 +313,7 @@
|
||||
located.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
In the <EM>ncurses</EM> implementation, there is a separate color
|
||||
activation flag, color palette, color pairs table, and as-
|
||||
sociated COLORS and COLOR_PAIRS counts for each screen;
|
||||
@ -353,8 +344,7 @@
|
||||
<STRONG>o</STRONG> Color RGB values are not settable.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
This implementation satisfies XSI Curses's minimum maxi-
|
||||
mums for <STRONG>COLORS</STRONG> and <STRONG>COLOR_PAIRS</STRONG>.
|
||||
|
||||
@ -372,8 +362,7 @@
|
||||
will treat those as optional parameters when null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></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_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG>curs_vari-</STRONG>
|
||||
<STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG>, <STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG>
|
||||
|
||||
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>delch</STRONG>, <STRONG>wdelch</STRONG>, <STRONG>mvdelch</STRONG>, <STRONG>mvwdelch</STRONG> - delete character under
|
||||
the cursor in a <STRONG>curses</STRONG> window
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>delch(void);</STRONG>
|
||||
@ -61,8 +59,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>mvwdelch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These routines delete the character under the cursor; all
|
||||
characters to the right of the cursor on the same line are
|
||||
moved to the left one position and the last character on
|
||||
@ -72,8 +69,7 @@
|
||||
ture.)
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All routines return the integer <STRONG>ERR</STRONG> upon failure and an <STRONG>OK</STRONG>
|
||||
(SVr4 specifies only "an integer value other than <STRONG>ERR</STRONG>")
|
||||
upon successful completion.
|
||||
@ -83,20 +79,17 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>delch</STRONG>, <STRONG>mvdelch</STRONG>, and <STRONG>mvwdelch</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are described in the XSI Curses standard,
|
||||
Issue 4. The standard specifies that they return <STRONG>ERR</STRONG> on
|
||||
failure, but specifies no error conditions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
|
||||
|
||||
|
||||
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>deleteln</STRONG>, <STRONG>wdeleteln</STRONG>, <STRONG>insdelln</STRONG>, <STRONG>winsdelln</STRONG>, <STRONG>insertln</STRONG>, <STRONG>win-</STRONG>
|
||||
<STRONG>sertln</STRONG> - delete and insert lines in a <STRONG>curses</STRONG> window
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>deleteln(void);</STRONG>
|
||||
@ -63,8 +61,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>winsertln(WINDOW</STRONG> <STRONG>*win);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <STRONG>deleteln</STRONG> and <STRONG>wdeleteln</STRONG> routines delete the line under
|
||||
the cursor in the window; all lines below the current line
|
||||
are moved up one line. The bottom line of the window is
|
||||
@ -81,8 +78,7 @@
|
||||
above the current line and the bottom line is lost.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All routines return the integer <STRONG>ERR</STRONG> upon failure and an <STRONG>OK</STRONG>
|
||||
(SVr4 specifies only "an integer value other than <STRONG>ERR</STRONG>")
|
||||
upon successful completion.
|
||||
@ -92,15 +88,13 @@
|
||||
returned.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are described in the XSI Curses standard,
|
||||
Issue 4. The standard specifies that they return <STRONG>ERR</STRONG> on
|
||||
failure, but specifies no error conditions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that all but <STRONG>winsdelln</STRONG> may be macros.
|
||||
|
||||
These routines do not require a hardware line delete or
|
||||
@ -109,8 +103,7 @@
|
||||
has been set on the current window.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
|
||||
|
||||
|
||||
|
||||
@ -46,22 +46,19 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>curses_version</STRONG>, <STRONG>use_extended_names</STRONG> - miscellaneous curses
|
||||
extensions
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>curses_version(void);</STRONG>
|
||||
<STRONG>int</STRONG> <STRONG>use_extended_names(bool</STRONG> <STRONG>enable);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These functions are extensions to the curses library which
|
||||
do not fit easily into other categories.
|
||||
|
||||
@ -79,23 +76,20 @@
|
||||
implementations of curses.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines are specific to ncurses. They were not
|
||||
supported on Version 7, BSD or System V implementations.
|
||||
It is recommended that any code depending on them be con-
|
||||
ditioned using NCURSES_VERSION.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>, <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>, <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG>,
|
||||
<STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG>, <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>, <STRONG>key-</STRONG>
|
||||
<STRONG><A HREF="keybound.3x.html">bound(3x)</A></STRONG>, <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>, <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>, <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
Thomas Dickey.
|
||||
|
||||
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, <STRONG>mvwget_wch</STRONG>, <STRONG>unget_wch</STRONG> - get
|
||||
(or push back) a wide character from curses terminal key-
|
||||
board
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>get_wch(wint_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
|
||||
@ -63,8 +61,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>unget_wch(const</STRONG> <STRONG>wchar_t</STRONG> <EM>wch</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, and <STRONG>mvwget_wch</STRONG> functions
|
||||
read a character from the terminal associated with the
|
||||
current or specified window. In no-delay mode, if no
|
||||
@ -104,8 +101,7 @@
|
||||
operation may fail.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><curses.h></STRONG> automatically includes the
|
||||
header file <STRONG><stdio.h></STRONG>.
|
||||
|
||||
@ -121,8 +117,7 @@
|
||||
All functions except <STRONG>wget_wch</STRONG> and <STRONG>unget_wch</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
When <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, and <STRONG>mvwget_wch</STRONG> func-
|
||||
tions successfully report the pressing of a function key,
|
||||
they return <STRONG>KEY_CODE_YES</STRONG>. When they successfully report a
|
||||
@ -137,8 +132,7 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>, <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG>,
|
||||
<STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>, <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>
|
||||
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>get_wstr</STRONG>, <STRONG>getn_wstr</STRONG>, <STRONG>wget_wstr</STRONG>, <STRONG>wgetn_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>,
|
||||
<STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwget_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG> - get an array of
|
||||
wide characters from a curses terminal keyboard
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>get_wstr(wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
|
||||
@ -66,8 +64,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>mvwgetn_wstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The effect of <STRONG>get_wstr</STRONG> is as though a series of calls to
|
||||
<STRONG>get_wch</STRONG> were made, until a newline, other end-of-line, or
|
||||
end-of-file condition is processed. An end-of-file condi-
|
||||
@ -102,8 +99,7 @@
|
||||
the application prevent overflow of the input buffer.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Using <STRONG>get_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>, <STRONG>mvwget_wstr</STRONG>, or <STRONG>wget_wstr</STRONG> to
|
||||
read a line that overflows the array pointed to by <STRONG>wstr</STRONG>
|
||||
causes undefined results. The use of <STRONG>getn_wstr</STRONG>,
|
||||
@ -117,8 +113,7 @@
|
||||
All of these routines except <STRONG>wgetn_wstr</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All of these functions return <STRONG>OK</STRONG> upon successful comple-
|
||||
tion. Otherwise, they return <STRONG>ERR</STRONG>.
|
||||
|
||||
@ -134,8 +129,7 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are described in The Single Unix Specifi-
|
||||
cation, Version 2. No error conditions are defined. This
|
||||
implementation returns ERR if the window pointer is null,
|
||||
@ -149,8 +143,7 @@
|
||||
<STRONG>wint_t</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
Functions: <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>, <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>.
|
||||
|
||||
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>getcchar</STRONG>, <STRONG>setcchar</STRONG> - Get a wide character string and ren-
|
||||
dition from a <STRONG>cchar_t</STRONG> or set a <STRONG>cchar_t</STRONG> from a wide-charac-
|
||||
ter string
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>getcchar(</STRONG>
|
||||
@ -71,11 +69,9 @@
|
||||
<STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM> <STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-getcchar">getcchar</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-getcchar">getcchar</a></H3><PRE>
|
||||
The <STRONG>getcchar</STRONG> function gets a wide-character string and
|
||||
rendition from a <STRONG>cchar_t</STRONG> argument. When <EM>wch</EM> is not a null
|
||||
pointer, the <STRONG>getcchar</STRONG> function does the following:
|
||||
@ -101,8 +97,7 @@
|
||||
<EM>color</EM><STRONG>_</STRONG><EM>pair</EM>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-setcchar">setcchar</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-setcchar">setcchar</a></H3><PRE>
|
||||
The <STRONG>setcchar</STRONG> function initializes the location pointed to
|
||||
by <EM>wcval</EM> by using:
|
||||
|
||||
@ -122,8 +117,7 @@
|
||||
allowed.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The <EM>opts</EM> argument is reserved for future use. Currently,
|
||||
an application must provide a null pointer as <EM>opts</EM>.
|
||||
|
||||
@ -133,8 +127,7 @@
|
||||
effect is unspecified.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
When <EM>wch</EM> is a null pointer, <STRONG>getcchar</STRONG> returns the number of
|
||||
wide characters referenced by <EM>wcval</EM>, including one for a
|
||||
trailing null.
|
||||
@ -146,8 +139,7 @@
|
||||
wise, it returns <STRONG>ERR</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
Functions: <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,
|
||||
<STRONG>wcwidth(3)</STRONG>.
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@
|
||||
* sale, use or other dealings in this Software without prior written *
|
||||
* authorization. *
|
||||
****************************************************************************
|
||||
* @Id: curs_getch.3x,v 1.43 2015/09/19 22:25:05 tom Exp @
|
||||
* @Id: curs_getch.3x,v 1.44 2015/12/20 01:43:03 tom Exp @
|
||||
-->
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
|
||||
<HTML>
|
||||
@ -46,14 +46,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>getch</STRONG>, <STRONG>wgetch</STRONG>, <STRONG>mvgetch</STRONG>, <STRONG>mvwgetch</STRONG>, <STRONG>ungetch</STRONG>, <STRONG>has_key</STRONG> - get
|
||||
(or push back) characters from <STRONG>curses</STRONG> terminal keyboard
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>getch(void);</STRONG>
|
||||
@ -64,11 +62,9 @@
|
||||
<STRONG>int</STRONG> <STRONG>has_key(int</STRONG> <EM>ch</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Reading-characters">Reading characters</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Reading-characters">Reading characters</a></H3><PRE>
|
||||
The <STRONG>getch</STRONG>, <STRONG>wgetch</STRONG>, <STRONG>mvgetch</STRONG> and <STRONG>mvwgetch</STRONG>, routines read a
|
||||
character from the window. In no-delay mode, if no input
|
||||
is waiting, the value <STRONG>ERR</STRONG> is returned. In delay mode, the
|
||||
@ -103,8 +99,7 @@
|
||||
called before another character is read.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Keypad-mode">Keypad mode</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Keypad-mode">Keypad mode</a></H3><PRE>
|
||||
If <STRONG>keypad</STRONG> is <STRONG>TRUE</STRONG>, and a function key is pressed, the to-
|
||||
ken for that function key is returned instead of the raw
|
||||
characters. Possible function keys are defined in <STRONG><curs-</STRONG>
|
||||
@ -123,19 +118,26 @@
|
||||
cape key and the escape is returned to the program.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Ungetting-characters">Ungetting characters</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Ungetting-characters">Ungetting characters</a></H3><PRE>
|
||||
The <STRONG>ungetch</STRONG> routine places <EM>ch</EM> back onto the input queue to
|
||||
be returned by the next call to <STRONG>wgetch</STRONG>. There is just one
|
||||
input queue for all windows.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Predefined-key-codes">Predefined key-codes</a></H3><PRE>
|
||||
The following special keys, defined in <STRONG><curses.h></STRONG>, may be
|
||||
returned by <STRONG>getch</STRONG> if <STRONG>keypad</STRONG> has been enabled. Not all of
|
||||
these are necessarily supported on any particular termi-
|
||||
nal.
|
||||
</PRE><H3><a name="h3-Predefined-key-codes">Predefined key-codes</a></H3><PRE>
|
||||
The following special keys are defined in <STRONG><curses.h></STRONG>.
|
||||
|
||||
<STRONG>o</STRONG> Except for the special case <STRONG>KEY_RESIZE</STRONG>, it is neces-
|
||||
sary to enable <STRONG>keypad</STRONG> for <STRONG>getch</STRONG> to return these codes.
|
||||
|
||||
<STRONG>o</STRONG> Not all of these are necessarily supported on any par-
|
||||
ticular terminal.
|
||||
|
||||
<STRONG>o</STRONG> The naming convention may seem obscure, with some ap-
|
||||
parent misspellings (such as "RSUME" for "resume").
|
||||
The names correspond to the long terminfo capability
|
||||
names for the keys, and were defined long ago, in the
|
||||
1980s.
|
||||
|
||||
<EM>Name</EM> <EM>Key</EM> <EM>name</EM>
|
||||
-------------------------------------------------
|
||||
@ -177,6 +179,7 @@
|
||||
KEY_BTAB Back tab key
|
||||
KEY_BEG Beg(inning) key
|
||||
KEY_CANCEL Cancel key
|
||||
|
||||
KEY_CLOSE Close key
|
||||
KEY_COMMAND Cmd (command) key
|
||||
KEY_COPY Copy key
|
||||
@ -186,7 +189,6 @@
|
||||
KEY_FIND Find key
|
||||
KEY_HELP Help key
|
||||
KEY_MARK Mark key
|
||||
|
||||
KEY_MESSAGE Message key
|
||||
KEY_MOUSE Mouse event read
|
||||
KEY_MOVE Move key
|
||||
@ -243,41 +245,39 @@
|
||||
+-----+------+-------+
|
||||
| <STRONG>C1</STRONG> | <STRONG>down</STRONG> | <STRONG>C3</STRONG> |
|
||||
+-----+------+-------+
|
||||
A few of these predefined values do <EM>not</EM> correspond to a
|
||||
A few of these predefined values do <EM>not</EM> correspond to a
|
||||
real key:
|
||||
|
||||
<STRONG>o</STRONG> <STRONG>KEY_RESIZE</STRONG> is returned when the <STRONG>SIGWINCH</STRONG> signal has
|
||||
been detected (see <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG> and <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>).
|
||||
This code is returned whether or not <STRONG>keypad</STRONG> has been
|
||||
<STRONG>o</STRONG> <STRONG>KEY_RESIZE</STRONG> is returned when the <STRONG>SIGWINCH</STRONG> signal has
|
||||
been detected (see <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG> and <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>).
|
||||
This code is returned whether or not <STRONG>keypad</STRONG> has been
|
||||
enabled.
|
||||
|
||||
<STRONG>o</STRONG> <STRONG>KEY_MOUSE</STRONG> is returned for mouse-events (see
|
||||
<STRONG>o</STRONG> <STRONG>KEY_MOUSE</STRONG> is returned for mouse-events (see
|
||||
<STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>). This code relies upon whether or not
|
||||
<STRONG><A HREF="keypad.3x.html">keypad(3x)</A></STRONG> has been enabled, because (e.g., with <EM>xterm</EM>
|
||||
mouse prototocol) ncurses must read escape sequences,
|
||||
mouse prototocol) ncurses must read escape sequences,
|
||||
just like a function key.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Testing-key-codes">Testing key-codes</a></H3><PRE>
|
||||
The <STRONG>has_key</STRONG> routine takes a key-code value from the above
|
||||
list, and returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG> according to whether the
|
||||
</PRE><H3><a name="h3-Testing-key-codes">Testing key-codes</a></H3><PRE>
|
||||
The <STRONG>has_key</STRONG> routine takes a key-code value from the above
|
||||
list, and returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG> according to whether the
|
||||
current terminal type recognizes a key with that value.
|
||||
|
||||
The library also supports these extensions:
|
||||
|
||||
<STRONG>define_key</STRONG>
|
||||
defines a key-code for a given string (see <STRONG>de-</STRONG>
|
||||
defines a key-code for a given string (see <STRONG>de-</STRONG>
|
||||
<STRONG><A HREF="define_key.3x.html">fine_key(3x)</A></STRONG>).
|
||||
|
||||
<STRONG>key_defined</STRONG>
|
||||
checks if there is a key-code defined for a given
|
||||
checks if there is a key-code defined for a given
|
||||
string (see <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All routines return the integer <STRONG>ERR</STRONG> upon failure and an
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All routines return the integer <STRONG>ERR</STRONG> upon failure and an
|
||||
integer value other than <STRONG>ERR</STRONG> (<STRONG>OK</STRONG> in the case of ungetch())
|
||||
upon successful completion.
|
||||
|
||||
@ -285,112 +285,109 @@
|
||||
returns ERR if there is no more room in the FIFO.
|
||||
|
||||
<STRONG>wgetch</STRONG>
|
||||
returns ERR if the window pointer is null, or if
|
||||
returns ERR if the window pointer is null, or if
|
||||
its timeout expires without having any data.
|
||||
|
||||
Functions with a "mv" prefix first perform a cursor move-
|
||||
ment using <STRONG>wmove</STRONG>, and return an error if the position is
|
||||
Functions with a "mv" prefix first perform a cursor move-
|
||||
ment using <STRONG>wmove</STRONG>, and return an error if the position is
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Use of the escape key by a programmer for a single charac-
|
||||
ter function is discouraged, as it will cause a delay of
|
||||
ter function is discouraged, as it will cause a delay of
|
||||
up to one second while the keypad code looks for a follow-
|
||||
ing function-key sequence.
|
||||
|
||||
Some keys may be the same as commonly used control keys,
|
||||
e.g., <STRONG>KEY_ENTER</STRONG> versus control/M, <STRONG>KEY_BACKSPACE</STRONG> versus
|
||||
Some keys may be the same as commonly used control keys,
|
||||
e.g., <STRONG>KEY_ENTER</STRONG> versus control/M, <STRONG>KEY_BACKSPACE</STRONG> versus
|
||||
control/H. Some curses implementations may differ accord-
|
||||
ing to whether they treat these control keys specially
|
||||
(and ignore the terminfo), or use the terminfo defini-
|
||||
tions. <STRONG>Ncurses</STRONG> uses the terminfo definition. If it says
|
||||
that <STRONG>KEY_ENTER</STRONG> is control/M, <STRONG>getch</STRONG> will return <STRONG>KEY_ENTER</STRONG>
|
||||
ing to whether they treat these control keys specially
|
||||
(and ignore the terminfo), or use the terminfo defini-
|
||||
tions. <STRONG>Ncurses</STRONG> uses the terminfo definition. If it says
|
||||
that <STRONG>KEY_ENTER</STRONG> is control/M, <STRONG>getch</STRONG> will return <STRONG>KEY_ENTER</STRONG>
|
||||
when you press control/M.
|
||||
|
||||
Generally, <STRONG>KEY_ENTER</STRONG> denotes the character(s) sent by the
|
||||
Generally, <STRONG>KEY_ENTER</STRONG> denotes the character(s) sent by the
|
||||
<EM>Enter</EM> key on the numeric keypad:
|
||||
|
||||
<STRONG>o</STRONG> the terminal description lists the most useful keys,
|
||||
|
||||
<STRONG>o</STRONG> the <EM>Enter</EM> key on the regular keyboard is already han-
|
||||
<STRONG>o</STRONG> the <EM>Enter</EM> key on the regular keyboard is already han-
|
||||
dled by the standard ASCII characters for carriage-re-
|
||||
turn and line-feed,
|
||||
|
||||
<STRONG>o</STRONG> depending on whether <STRONG>nl</STRONG> or <STRONG>nonl</STRONG> was called, pressing
|
||||
"Enter" on the regular keyboard may return either a
|
||||
<STRONG>o</STRONG> depending on whether <STRONG>nl</STRONG> or <STRONG>nonl</STRONG> was called, pressing
|
||||
"Enter" on the regular keyboard may return either a
|
||||
carriage-return or line-feed, and finally
|
||||
|
||||
<STRONG>o</STRONG> "Enter or send" is the standard description for this
|
||||
<STRONG>o</STRONG> "Enter or send" is the standard description for this
|
||||
key.
|
||||
|
||||
When using <STRONG>getch</STRONG>, <STRONG>wgetch</STRONG>, <STRONG>mvgetch</STRONG>, or <STRONG>mvwgetch</STRONG>, nocbreak
|
||||
When using <STRONG>getch</STRONG>, <STRONG>wgetch</STRONG>, <STRONG>mvgetch</STRONG>, or <STRONG>mvwgetch</STRONG>, nocbreak
|
||||
mode (<STRONG>nocbreak</STRONG>) and echo mode (<STRONG>echo</STRONG>) should not be used at
|
||||
the same time. Depending on the state of the tty driver
|
||||
when each character is typed, the program may produce un-
|
||||
the same time. Depending on the state of the tty driver
|
||||
when each character is typed, the program may produce un-
|
||||
desirable results.
|
||||
|
||||
Note that <STRONG>getch</STRONG>, <STRONG>mvgetch</STRONG>, and <STRONG>mvwgetch</STRONG> may be macros.
|
||||
|
||||
Historically, the set of keypad macros was largely defined
|
||||
by the extremely function-key-rich keyboard of the AT&T
|
||||
7300, aka 3B1, aka Safari 4. Modern personal computers
|
||||
usually have only a small subset of these. IBM PC-style
|
||||
consoles typically support little more than <STRONG>KEY_UP</STRONG>,
|
||||
<STRONG>KEY_DOWN</STRONG>, <STRONG>KEY_LEFT</STRONG>, <STRONG>KEY_RIGHT</STRONG>, <STRONG>KEY_HOME</STRONG>, <STRONG>KEY_END</STRONG>,
|
||||
by the extremely function-key-rich keyboard of the AT&T
|
||||
7300, aka 3B1, aka Safari 4. Modern personal computers
|
||||
usually have only a small subset of these. IBM PC-style
|
||||
consoles typically support little more than <STRONG>KEY_UP</STRONG>,
|
||||
<STRONG>KEY_DOWN</STRONG>, <STRONG>KEY_LEFT</STRONG>, <STRONG>KEY_RIGHT</STRONG>, <STRONG>KEY_HOME</STRONG>, <STRONG>KEY_END</STRONG>,
|
||||
<STRONG>KEY_NPAGE</STRONG>, <STRONG>KEY_PPAGE</STRONG>, and function keys 1 through 12. The
|
||||
Ins key is usually mapped to <STRONG>KEY_IC</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The *get* functions are described in the XSI Curses stan-
|
||||
dard, Issue 4. They read single-byte characters only.
|
||||
The standard specifies that they return <STRONG>ERR</STRONG> on failure,
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The *get* functions are described in the XSI Curses stan-
|
||||
dard, Issue 4. They read single-byte characters only.
|
||||
The standard specifies that they return <STRONG>ERR</STRONG> on failure,
|
||||
but specifies no error conditions.
|
||||
|
||||
The echo behavior of these functions on input of <STRONG>KEY_</STRONG> or
|
||||
backspace characters was not specified in the SVr4 docu-
|
||||
The echo behavior of these functions on input of <STRONG>KEY_</STRONG> or
|
||||
backspace characters was not specified in the SVr4 docu-
|
||||
mentation. This description is adopted from the XSI Curs-
|
||||
es standard.
|
||||
|
||||
The behavior of <STRONG>getch</STRONG> and friends in the presence of han-
|
||||
dled signals is unspecified in the SVr4 and XSI Curses
|
||||
documentation. Under historical curses implementations,
|
||||
it varied depending on whether the operating system's im-
|
||||
plementation of handled signal receipt interrupts a
|
||||
<STRONG>read(2)</STRONG> call in progress or not, and also (in some imple-
|
||||
mentations) depending on whether an input timeout or non-
|
||||
The behavior of <STRONG>getch</STRONG> and friends in the presence of han-
|
||||
dled signals is unspecified in the SVr4 and XSI Curses
|
||||
documentation. Under historical curses implementations,
|
||||
it varied depending on whether the operating system's im-
|
||||
plementation of handled signal receipt interrupts a
|
||||
<STRONG>read(2)</STRONG> call in progress or not, and also (in some imple-
|
||||
mentations) depending on whether an input timeout or non-
|
||||
blocking mode has been set.
|
||||
|
||||
<STRONG>KEY_MOUSE</STRONG> is mentioned in XSI Curses, along with a few re-
|
||||
lated terminfo capabilities, but no higher-level functions
|
||||
use the feature. The implementation in ncurses is an ex-
|
||||
use the feature. The implementation in ncurses is an ex-
|
||||
tension.
|
||||
|
||||
<STRONG>KEY_RESIZE</STRONG> is an extension first implemented for ncurses.
|
||||
<STRONG>KEY_RESIZE</STRONG> is an extension first implemented for ncurses.
|
||||
NetBSD curses later added this extension.
|
||||
|
||||
Programmers concerned about portability should be prepared
|
||||
for either of two cases: (a) signal receipt does not in-
|
||||
terrupt <STRONG>getch</STRONG>; (b) signal receipt interrupts <STRONG>getch</STRONG> and
|
||||
causes it to return ERR with <STRONG>errno</STRONG> set to <STRONG>EINTR</STRONG>. Under
|
||||
the <STRONG>ncurses</STRONG> implementation, handled signals never inter-
|
||||
for either of two cases: (a) signal receipt does not in-
|
||||
terrupt <STRONG>getch</STRONG>; (b) signal receipt interrupts <STRONG>getch</STRONG> and
|
||||
causes it to return ERR with <STRONG>errno</STRONG> set to <STRONG>EINTR</STRONG>. Under
|
||||
the <STRONG>ncurses</STRONG> implementation, handled signals never inter-
|
||||
rupt <STRONG>getch</STRONG>.
|
||||
|
||||
The <STRONG>has_key</STRONG> function is unique to <STRONG>ncurses</STRONG>. We recommend
|
||||
that any code using it be conditionalized on the <STRONG>NCURS-</STRONG>
|
||||
The <STRONG>has_key</STRONG> function is unique to <STRONG>ncurses</STRONG>. We recommend
|
||||
that any code using it be conditionalized on the <STRONG>NCURS-</STRONG>
|
||||
<STRONG>ES_VERSION</STRONG> feature macro.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>,
|
||||
<STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>, <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG>re-</STRONG>
|
||||
<STRONG><A HREF="resizeterm.3x.html">sizeterm(3x)</A></STRONG>.
|
||||
|
||||
Comparable functions in the wide-character (ncursesw) li-
|
||||
Comparable functions in the wide-character (ncursesw) li-
|
||||
brary are described in <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>.
|
||||
|
||||
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>getstr</STRONG>, <STRONG>getnstr</STRONG>, <STRONG>wgetstr</STRONG>, <STRONG>wgetnstr</STRONG>, <STRONG>mvgetstr</STRONG>, <STRONG>mvgetnstr</STRONG>,
|
||||
<STRONG>mvwgetstr</STRONG>, <STRONG>mvwgetnstr</STRONG> - accept character strings from
|
||||
<STRONG>curses</STRONG> terminal keyboard
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>getstr(char</STRONG> <STRONG>*str);</STRONG>
|
||||
@ -66,8 +64,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>mvwgetnstr(WINDOW</STRONG> <STRONG>*,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>getstr</STRONG> is equivalent to a series of calls to
|
||||
<STRONG>getch</STRONG>, until a newline or carriage return is received (the
|
||||
terminating character is not included in the returned
|
||||
@ -91,8 +88,7 @@
|
||||
vious character (typically a left motion).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All routines return the integer <STRONG>ERR</STRONG> upon failure and an <STRONG>OK</STRONG>
|
||||
(SVr4 specifies only "an integer value other than <STRONG>ERR</STRONG>")
|
||||
upon successful completion.
|
||||
@ -112,13 +108,11 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>getstr</STRONG>, <STRONG>mvgetstr</STRONG>, and <STRONG>mvwgetstr</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are described in the XSI Curses standard,
|
||||
Issue 4. They read single-byte characters only. The
|
||||
standard does not define any error conditions. This im-
|
||||
@ -138,8 +132,7 @@
|
||||
present but not documented in SVr4.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
|
||||
|
||||
|
||||
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>getyx</STRONG>, <STRONG>getparyx</STRONG>, <STRONG>getbegyx</STRONG>, <STRONG>getmaxyx</STRONG> - get <STRONG>curses</STRONG> cursor
|
||||
and window coordinates
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>void</STRONG> <STRONG>getyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
|
||||
@ -61,8 +59,7 @@
|
||||
<STRONG>void</STRONG> <STRONG>getmaxyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <STRONG>getyx</STRONG> macro places the current cursor position of the
|
||||
given window in the two integer variables <EM>y</EM> and <EM>x</EM>.
|
||||
|
||||
@ -76,21 +73,18 @@
|
||||
window.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The return values of these macros are undefined (i.e.,
|
||||
they should not be used as the right-hand side of assign-
|
||||
ment statements).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
All of these interfaces are macros. A "<STRONG>&</STRONG>" is not neces-
|
||||
sary before the variables <EM>y</EM> and <EM>x</EM>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The <STRONG>getyx</STRONG>, <STRONG>getparyx</STRONG>, <STRONG>getbegyx</STRONG> and <STRONG>getmaxyx</STRONG> macros are
|
||||
described in the XSI Curses standard, Issue 4.
|
||||
|
||||
@ -114,8 +108,7 @@
|
||||
<STRONG>getmaxyx</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>, <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>
|
||||
|
||||
|
||||
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>in_wch</STRONG>, <STRONG>mvin_wch</STRONG>, <STRONG>mvwin_wch</STRONG>, <STRONG>win_wch</STRONG> - extract a complex
|
||||
character and rendition from a window
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>in_wch(cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>);</STRONG>
|
||||
@ -61,15 +59,13 @@
|
||||
<STRONG>int</STRONG> <STRONG>win_wch(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These functions extract the complex character and rendi-
|
||||
tion from the current position in the named window into
|
||||
the <STRONG>cchar_t</STRONG> object referenced by wcval.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
No errors are defined in the XSI Curses standard. This
|
||||
implementation checks for null pointers, returns ERR in
|
||||
that case. Also, the <EM>mv</EM> routines check for error moving
|
||||
@ -81,19 +77,16 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that all of these routines may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are described in the XSI Curses standard,
|
||||
Issue 4.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>.
|
||||
|
||||
|
||||
|
||||
@ -45,16 +45,14 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>in_wchstr</STRONG>, <STRONG>in_wchnstr</STRONG>, <STRONG>win_wchstr</STRONG>, <STRONG>win_wchnstr</STRONG>,
|
||||
<STRONG>mvin_wchstr</STRONG>, <STRONG>mvin_wchnstr</STRONG>, <STRONG>mvwin_wchstr</STRONG>, <STRONG>mvwin_wchnstr</STRONG> -
|
||||
get an array of complex characters and renditions from a
|
||||
curses window
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>in_wchstr(cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG>
|
||||
@ -67,8 +65,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>mvwin_wchnstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM>, int <EM>n</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These functions return an array of complex characters in
|
||||
<EM>wchstr</EM>, starting at the current cursor position in the
|
||||
named window. Attributes (rendition) are stored with the
|
||||
@ -78,8 +75,7 @@
|
||||
<STRONG>str</STRONG> fill the array with at most <EM>n</EM> <STRONG>cchar_t</STRONG> elements.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that all routines except <STRONG>win_wchnstr</STRONG> may be macros.
|
||||
|
||||
Reading a line that overflows the array pointed to by <EM>wch-</EM>
|
||||
@ -89,8 +85,7 @@
|
||||
recommended.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Upon successful completion, these functions return <STRONG>OK</STRONG>.
|
||||
Otherwise, they return <STRONG>ERR</STRONG>.
|
||||
|
||||
@ -99,15 +94,13 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The XSI Curses defines no error conditions. This imple-
|
||||
mentation checks for null pointers, returning ERR in that
|
||||
case.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
Functions: <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>, <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>,
|
||||
<STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG>
|
||||
|
||||
|
||||
@ -46,14 +46,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>inch</STRONG>, <STRONG>winch</STRONG>, <STRONG>mvinch</STRONG>, <STRONG>mvwinch</STRONG> - get a character and
|
||||
attributes from a <STRONG>curses</STRONG> window
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>chtype</STRONG> <STRONG>inch(void);</STRONG>
|
||||
@ -62,8 +60,7 @@
|
||||
<STRONG>chtype</STRONG> <STRONG>mvwinch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These routines return the character, of type <STRONG>chtype</STRONG>, at
|
||||
the current position in the named window. If any
|
||||
attributes are set for that position, their values are
|
||||
@ -72,8 +69,7 @@
|
||||
to extract the character or attributes alone.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Attributes">Attributes</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Attributes">Attributes</a></H3><PRE>
|
||||
The following bit-masks may be AND-ed with characters
|
||||
returned by <STRONG>winch</STRONG>.
|
||||
|
||||
@ -82,26 +78,22 @@
|
||||
<STRONG>A_COLOR</STRONG> Bit-mask to extract color-pair field information
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Functions with a "mv" prefix first perform a cursor move-
|
||||
ment using <STRONG>wmove</STRONG>, and return an error if the position is
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that all of these routines may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are described in the XSI Curses standard,
|
||||
Issue 4.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
|
||||
|
||||
Comparable functions in the wide-character (ncursesw)
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>inchstr</STRONG>, <STRONG>inchnstr</STRONG>, <STRONG>winchstr</STRONG>, <STRONG>winchnstr</STRONG>, <STRONG>mvinchstr</STRONG>,
|
||||
<STRONG>mvinchnstr</STRONG>, <STRONG>mvwinchstr</STRONG>, <STRONG>mvwinchnstr</STRONG> - get a string of
|
||||
characters (and attributes) from a <STRONG>curses</STRONG> window
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>inchstr(chtype</STRONG> <STRONG>*chstr);</STRONG>
|
||||
@ -67,8 +65,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>n);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These routines return a NULL-terminated array of <STRONG>chtype</STRONG>
|
||||
quantities, starting at the current cursor position in the
|
||||
named window and ending at the right margin of the window.
|
||||
@ -80,8 +77,7 @@
|
||||
the <EM>chstr</EM> [see <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>].
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All routines return the integer <STRONG>ERR</STRONG> upon failure and an
|
||||
integer value other than <STRONG>ERR</STRONG> upon successful completion
|
||||
(the number of characters retrieved, exclusive of the
|
||||
@ -96,8 +92,7 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that all routines except <STRONG>winchnstr</STRONG> may be macros.
|
||||
SVr4 does not document whether the result string is zero-
|
||||
terminated; it does not document whether a length limit
|
||||
@ -105,16 +100,14 @@
|
||||
the meaning of the return value.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are described in the XSI Curses standard,
|
||||
Issue 4. It is no more specific than the SVr4 documenta-
|
||||
tion on the trailing 0. It does specify that the success-
|
||||
ful return of the functions is <STRONG>OK</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>.
|
||||
|
||||
Comparable functions in the wide-character (ncursesw) li-
|
||||
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>initscr</STRONG>, <STRONG>newterm</STRONG>, <STRONG>endwin</STRONG>, <STRONG>isendwin</STRONG>, <STRONG>set_term</STRONG>, <STRONG>delscreen</STRONG> -
|
||||
<STRONG>curses</STRONG> screen initialization and manipulation routines
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>WINDOW</STRONG> <STRONG>*initscr(void);</STRONG>
|
||||
@ -63,11 +61,9 @@
|
||||
<STRONG>void</STRONG> <STRONG>delscreen(SCREEN*</STRONG> <EM>sp</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-initscr">initscr</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-initscr">initscr</a></H3><PRE>
|
||||
<STRONG>initscr</STRONG> is normally the first <STRONG>curses</STRONG> routine to call when
|
||||
initializing a program. A few special routines sometimes
|
||||
need to be called before it; these are <STRONG>slk_init</STRONG>, <STRONG>filter</STRONG>,
|
||||
@ -82,8 +78,7 @@
|
||||
<STRONG>stdscr</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-newterm">newterm</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-newterm">newterm</a></H3><PRE>
|
||||
A program that outputs to more than one terminal should
|
||||
use the <STRONG>newterm</STRONG> routine for each terminal instead of
|
||||
<STRONG>initscr</STRONG>. A program that needs to inspect capabilities, so
|
||||
@ -103,8 +98,7 @@
|
||||
If the <EM>type</EM> parameter is <STRONG>NULL</STRONG>, <STRONG>$TERM</STRONG> will be used.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-endwin">endwin</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-endwin">endwin</a></H3><PRE>
|
||||
The program must also call <STRONG>endwin</STRONG> for each terminal being
|
||||
used before exiting from <STRONG>curses</STRONG>. If <STRONG>newterm</STRONG> is called
|
||||
more than once for the same terminal, the first terminal
|
||||
@ -125,15 +119,13 @@
|
||||
es the program to resume visual mode.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-isendwin">isendwin</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-isendwin">isendwin</a></H3><PRE>
|
||||
The <STRONG>isendwin</STRONG> routine returns <STRONG>TRUE</STRONG> if <STRONG>endwin</STRONG> has been
|
||||
called without any subsequent calls to <STRONG>wrefresh</STRONG>, and <STRONG>FALSE</STRONG>
|
||||
otherwise.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-set_term">set_term</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-set_term">set_term</a></H3><PRE>
|
||||
The <STRONG>set_term</STRONG> routine is used to switch between different
|
||||
terminals. The screen reference <STRONG>new</STRONG> becomes the new cur-
|
||||
rent terminal. The previous terminal is returned by the
|
||||
@ -142,16 +134,14 @@
|
||||
rent terminal.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-delscreen">delscreen</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-delscreen">delscreen</a></H3><PRE>
|
||||
The <STRONG>delscreen</STRONG> routine frees storage associated with the
|
||||
<STRONG>SCREEN</STRONG> data structure. The <STRONG>endwin</STRONG> routine does not do
|
||||
this, so <STRONG>delscreen</STRONG> should be called after <STRONG>endwin</STRONG> if a par-
|
||||
ticular <STRONG>SCREEN</STRONG> is no longer needed.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
<STRONG>endwin</STRONG> returns the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> upon
|
||||
successful completion.
|
||||
|
||||
@ -171,20 +161,17 @@
|
||||
<STRONG>o</STRONG> <STRONG>set_term</STRONG> returns no error.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>initscr</STRONG> and <STRONG>newterm</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions were described in the XSI Curses standard,
|
||||
Issue 4. As of 2015, the current document is X/Open Curs-
|
||||
es, Issue 7.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Differences">Differences</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Differences">Differences</a></H3><PRE>
|
||||
X/Open specifies that portable applications must not call
|
||||
<STRONG>initscr</STRONG> more than once:
|
||||
|
||||
@ -200,8 +187,7 @@
|
||||
the return value of <STRONG>initscr</STRONG> in XSI Curses.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Unset-TERM-Variable">Unset TERM Variable</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Unset-TERM-Variable">Unset TERM Variable</a></H3><PRE>
|
||||
If the TERM variable is missing or empty, <STRONG>initscr</STRONG> uses the
|
||||
value "unknown", which normally corresponds to a terminal
|
||||
entry with the <EM>generic</EM> (<EM>gn</EM>) capability. Generic entries
|
||||
@ -211,8 +197,7 @@
|
||||
ly.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Signal-Handlers">Signal Handlers</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Signal-Handlers">Signal Handlers</a></H3><PRE>
|
||||
Quoting from X/Open Curses, section 3.1.1:
|
||||
|
||||
<EM>Curses</EM> <EM>implementations</EM> <EM>may</EM> <EM>provide</EM> <EM>for</EM> <EM>special</EM> <EM>han-</EM>
|
||||
@ -274,8 +259,7 @@
|
||||
<STRONG>stdscr</STRONG>, and update other data such as <STRONG>LINES</STRONG> and <STRONG>COLS</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>,
|
||||
<STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>, <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>, <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG>curs_vari-</STRONG>
|
||||
<STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG>.
|
||||
|
||||
@ -45,16 +45,14 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>cbreak</STRONG>, <STRONG>nocbreak</STRONG>, <STRONG>echo</STRONG>, <STRONG>noecho</STRONG>, <STRONG>halfdelay</STRONG>, <STRONG>intrflush</STRONG>,
|
||||
<STRONG>keypad</STRONG>, <STRONG>meta</STRONG>, <STRONG>nodelay</STRONG>, <STRONG>notimeout</STRONG>, <STRONG>raw</STRONG>, <STRONG>noraw</STRONG>, <STRONG>noqiflush</STRONG>,
|
||||
<STRONG>qiflush</STRONG>, <STRONG>timeout</STRONG>, <STRONG>wtimeout</STRONG>, <STRONG>typeahead</STRONG> - <STRONG>curses</STRONG> input
|
||||
options
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>cbreak(void);</STRONG>
|
||||
@ -76,8 +74,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>typeahead(int</STRONG> <STRONG>fd);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <STRONG>ncurses</STRONG> library provides several functions which let
|
||||
an application change the way input from the terminal is
|
||||
handled. Some are global, applying to all windows. Oth-
|
||||
@ -87,8 +84,7 @@
|
||||
the same behavior is needed.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-cbreak">cbreak</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-cbreak">cbreak</a></H3><PRE>
|
||||
Normally, the tty driver buffers typed characters until a
|
||||
newline or carriage return is typed. The <STRONG>cbreak</STRONG> routine
|
||||
disables line buffering and erase/kill character-process-
|
||||
@ -105,8 +101,7 @@
|
||||
these routines interact with <STRONG>echo</STRONG> and <STRONG>noecho</STRONG>.]
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-echo_noecho">echo/noecho</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-echo_noecho">echo/noecho</a></H3><PRE>
|
||||
The <STRONG>echo</STRONG> and <STRONG>noecho</STRONG> routines control whether characters
|
||||
typed by the user are echoed by <STRONG>getch</STRONG> as they are typed.
|
||||
Echoing by the tty driver is always disabled, but initial-
|
||||
@ -118,8 +113,7 @@
|
||||
interact with <STRONG>cbreak</STRONG> and <STRONG>nocbreak</STRONG>.]
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-halfdelay">halfdelay</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-halfdelay">halfdelay</a></H3><PRE>
|
||||
The <STRONG>halfdelay</STRONG> routine is used for half-delay mode, which
|
||||
is similar to <STRONG>cbreak</STRONG> mode in that characters typed by the
|
||||
user are immediately available to the program. However,
|
||||
@ -129,8 +123,7 @@
|
||||
half-delay mode.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-intrflush">intrflush</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-intrflush">intrflush</a></H3><PRE>
|
||||
If the <STRONG>intrflush</STRONG> option is enabled (<EM>bf</EM> is <STRONG>TRUE</STRONG>), and an
|
||||
interrupt key is pressed on the keyboard (interrupt,
|
||||
break, quit), all output in the tty driver queue will be
|
||||
@ -142,8 +135,7 @@
|
||||
nored.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-keypad">keypad</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-keypad">keypad</a></H3><PRE>
|
||||
The <STRONG>keypad</STRONG> option enables the keypad of the user's termi-
|
||||
nal. If enabled (<EM>bf</EM> is <STRONG>TRUE</STRONG>), the user can press a func-
|
||||
tion key (such as an arrow key) and <STRONG>wgetch</STRONG> returns a sin-
|
||||
@ -157,8 +149,7 @@
|
||||
keypad is <STRONG>FALSE</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-meta">meta</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-meta">meta</a></H3><PRE>
|
||||
Initially, whether the terminal returns 7 or 8 significant
|
||||
bits on input depends on the control mode of the tty driv-
|
||||
er [see <STRONG>termio(7)</STRONG>]. To force 8 bits to be returned, in-
|
||||
@ -173,8 +164,7 @@
|
||||
<STRONG>FALSE</STRONG>) is called.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-nodelay">nodelay</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-nodelay">nodelay</a></H3><PRE>
|
||||
The <STRONG>nodelay</STRONG> option causes <STRONG>getch</STRONG> to be a non-blocking call.
|
||||
If no input is ready, <STRONG>getch</STRONG> returns <STRONG>ERR</STRONG>. If disabled (<EM>bf</EM>
|
||||
is <STRONG>FALSE</STRONG>), <STRONG>getch</STRONG> waits until a key is pressed.
|
||||
@ -187,8 +177,7 @@
|
||||
typed by a user.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-raw_noraw">raw/noraw</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-raw_noraw">raw/noraw</a></H3><PRE>
|
||||
The <STRONG>raw</STRONG> and <STRONG>noraw</STRONG> routines place the terminal into or out
|
||||
of raw mode. Raw mode is similar to <STRONG>cbreak</STRONG> mode, in that
|
||||
characters typed are immediately passed through to the us-
|
||||
@ -199,8 +188,7 @@
|
||||
bits in the tty driver that are not set by <STRONG>curses</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-noqiflush">noqiflush</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-noqiflush">noqiflush</a></H3><PRE>
|
||||
When the <STRONG>noqiflush</STRONG> routine is used, normal flush of input
|
||||
and output queues associated with the <STRONG>INTR</STRONG>, <STRONG>QUIT</STRONG> and <STRONG>SUSP</STRONG>
|
||||
characters will not be done [see <STRONG>termio(7)</STRONG>]. When <STRONG>qiflush</STRONG>
|
||||
@ -210,8 +198,7 @@
|
||||
the interrupt had not occurred, after the handler exits.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-timeout_wtimeout">timeout/wtimeout</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-timeout_wtimeout">timeout/wtimeout</a></H3><PRE>
|
||||
The <STRONG>timeout</STRONG> and <STRONG>wtimeout</STRONG> routines set blocking or non-
|
||||
blocking read for a given window. If <EM>delay</EM> is negative,
|
||||
blocking read is used (i.e., waits indefinitely for in-
|
||||
@ -224,8 +211,7 @@
|
||||
<EM>lay</EM> milliseconds (where <EM>delay</EM> is positive).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-typeahead">typeahead</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-typeahead">typeahead</a></H3><PRE>
|
||||
The <STRONG>curses</STRONG> library does "line-breakout optimization" by
|
||||
looking for typeahead periodically while updating the
|
||||
screen. If input is found, and it is coming from a tty,
|
||||
@ -239,8 +225,7 @@
|
||||
typeahead checking is done.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All routines that return an integer return <STRONG>ERR</STRONG> upon fail-
|
||||
ure and OK (SVr4 specifies only "an integer value other
|
||||
than <STRONG>ERR</STRONG>") upon successful completion, unless otherwise
|
||||
@ -256,8 +241,7 @@
|
||||
the range 1..255.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are described in the XSI Curses standard,
|
||||
Issue 4.
|
||||
|
||||
@ -304,8 +288,7 @@
|
||||
used.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>echo</STRONG>, <STRONG>noecho</STRONG>, <STRONG>halfdelay</STRONG>, <STRONG>intrflush</STRONG>, <STRONG>meta</STRONG>, <STRONG>node-</STRONG>
|
||||
<STRONG>lay</STRONG>, <STRONG>notimeout</STRONG>, <STRONG>noqiflush</STRONG>, <STRONG>qiflush</STRONG>, <STRONG>timeout</STRONG>, and <STRONG>wtimeout</STRONG>
|
||||
may be macros.
|
||||
@ -318,8 +301,7 @@
|
||||
recommended.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>,
|
||||
<STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>, <STRONG>termio(7)</STRONG>
|
||||
|
||||
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>ins_wch</STRONG>, <STRONG>mvins_wch</STRONG>, <STRONG>mvwins_wch</STRONG>, <STRONG>wins_wch</STRONG> - insert a com-
|
||||
plex character and rendition into a window
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
#include <curses.h>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>ins_wch(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
|
||||
@ -62,8 +60,7 @@
|
||||
<EM>*wch</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These routines, insert the complex character <EM>wch</EM> with ren-
|
||||
dition before the character under the cursor. All charac-
|
||||
ters to the right of the cursor are moved one space to the
|
||||
@ -72,8 +69,7 @@
|
||||
change the cursor position.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
If successful, these functions return OK. If not, they
|
||||
return ERR.
|
||||
|
||||
@ -82,13 +78,11 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-ERRORS">ERRORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-ERRORS">ERRORS</a></H2><PRE>
|
||||
No errors are defined.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG>.
|
||||
|
||||
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>ins_wstr</STRONG>, <STRONG>ins_nwstr</STRONG>, <STRONG>wins_wstr</STRONG>, <STRONG>wins_nwstr</STRONG>, <STRONG>mvins_wstr</STRONG>,
|
||||
<STRONG>mvins_nwstr</STRONG>, <STRONG>mvwins_wstr</STRONG>, <STRONG>mvwins_nwstr</STRONG> - insert a wide-
|
||||
character string into a curses window
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>ins_wstr(const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr);</EM>
|
||||
@ -66,8 +64,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>mvwins_nwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These routines insert a <STRONG>wchar_t</STRONG> character string (as many
|
||||
characters as will fit on the line) before the character
|
||||
under the cursor. All characters to the right of the cur-
|
||||
@ -91,8 +88,7 @@
|
||||
ter.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that all but wins_nwstr may be macros.
|
||||
|
||||
If the first character in the string is a nonspacing char-
|
||||
@ -101,8 +97,7 @@
|
||||
trol character.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Upon successful completion, these functions return OK.
|
||||
Otherwise, they return ERR.
|
||||
|
||||
@ -111,8 +106,7 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG>, <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>,
|
||||
<STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG>.
|
||||
|
||||
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>insch</STRONG>, <STRONG>winsch</STRONG>, <STRONG>mvinsch</STRONG>, <STRONG>mvwinsch</STRONG> - insert a character
|
||||
before cursor in a <STRONG>curses</STRONG> window
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>insch(chtype</STRONG> <STRONG>ch);</STRONG>
|
||||
@ -61,8 +59,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>mvwinsch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These routines insert the character <EM>ch</EM> before the charac-
|
||||
ter under the cursor. All characters to the right of the
|
||||
cursor are moved one space to the right, with the possi-
|
||||
@ -71,8 +68,7 @@
|
||||
tion.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All routines that return an integer return <STRONG>ERR</STRONG> upon fail-
|
||||
ure and OK (SVr4 specifies only "an integer value other
|
||||
than <STRONG>ERR</STRONG>") upon successful completion, unless otherwise
|
||||
@ -83,22 +79,19 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
These routines do not necessarily imply use of a hardware
|
||||
insert character feature.
|
||||
|
||||
Note that <STRONG>insch</STRONG>, <STRONG>mvinsch</STRONG>, and <STRONG>mvwinsch</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are described in the XSI Curses standard,
|
||||
Issue 4.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
|
||||
|
||||
Comparable functions in the wide-character (ncursesw)
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>insstr</STRONG>, <STRONG>insnstr</STRONG>, <STRONG>winsstr</STRONG>, <STRONG>winsnstr</STRONG>, <STRONG>mvinsstr</STRONG>, <STRONG>mvinsnstr</STRONG>,
|
||||
<STRONG>mvwinsstr</STRONG>, <STRONG>mvwinsnstr</STRONG> - insert string before cursor in a
|
||||
<STRONG>curses</STRONG> window
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
<STRONG>int</STRONG> <STRONG>insstr(const</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
|
||||
<STRONG>int</STRONG> <STRONG>insnstr(const</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
|
||||
@ -66,8 +64,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>n);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These routines insert a character string (as many charac-
|
||||
ters as will fit on the line) before the character under
|
||||
the cursor. All characters to the right of the cursor are
|
||||
@ -81,8 +78,7 @@
|
||||
Special characters are handled as in <STRONG>addch</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All routines that return an integer return <STRONG>ERR</STRONG> upon fail-
|
||||
ure and OK (SVr4 specifies only "an integer value other
|
||||
than <STRONG>ERR</STRONG>") upon successful completion, unless otherwise
|
||||
@ -97,13 +93,11 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that all but <STRONG>winsnstr</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are described in the XSI Curses standard,
|
||||
Issue 4, which adds const qualifiers to the arguments.
|
||||
|
||||
@ -114,8 +108,7 @@
|
||||
inconsistency.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>, <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>.
|
||||
|
||||
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>instr</STRONG>, <STRONG>innstr</STRONG>, <STRONG>winstr</STRONG>, <STRONG>winnstr</STRONG>, <STRONG>mvinstr</STRONG>, <STRONG>mvinnstr</STRONG>, <STRONG>mvwin-</STRONG>
|
||||
<STRONG>str</STRONG>, <STRONG>mvwinnstr</STRONG> - get a string of characters from a <STRONG>curses</STRONG>
|
||||
window
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>instr(char</STRONG> <STRONG>*str);</STRONG>
|
||||
@ -67,8 +65,7 @@
|
||||
<STRONG>n);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These routines return a string of characters in <EM>str</EM>,
|
||||
extracted starting at the current cursor position in the
|
||||
named window. Attributes are stripped from the charac-
|
||||
@ -77,8 +74,7 @@
|
||||
(exclusive of the trailing NUL).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All of the functions return <STRONG>ERR</STRONG> upon failure, or the num-
|
||||
ber of characters actually read into the string.
|
||||
|
||||
@ -91,13 +87,11 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that all routines except <STRONG>winnstr</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
SVr4 does not document whether a length limit includes or
|
||||
excludes the trailing NUL.
|
||||
|
||||
@ -106,8 +100,7 @@
|
||||
return the string ending at the right margin.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
|
||||
|
||||
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>inwstr</STRONG>, <STRONG>innwstr</STRONG>, <STRONG>winwstr</STRONG>, <STRONG>winnwstr</STRONG>, <STRONG>mvinwstr</STRONG>, <STRONG>mvinnwstr</STRONG>,
|
||||
<STRONG>mvwinwstr</STRONG>, <STRONG>mvwinnwstr</STRONG> - get a string of <STRONG>wchar_t</STRONG> characters
|
||||
from a curses window
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>inwstr(wchar_t</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
|
||||
@ -66,8 +64,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>mvwinnwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These routines return a string of <STRONG>wchar_t</STRONG> characters in
|
||||
<EM>wstr</EM>, extracted starting at the current cursor position in
|
||||
the named window. Attributes are stripped from the char-
|
||||
@ -81,13 +78,11 @@
|
||||
character, an error is generated.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that all routines except <STRONG>winnwstr</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All routines return <STRONG>ERR</STRONG> upon failure. Upon successful com-
|
||||
pletion, the *<STRONG>inwstr</STRONG> routines return <STRONG>OK</STRONG>, and the *<STRONG>innwstr</STRONG>
|
||||
routines return the number of characters read into the
|
||||
@ -98,8 +93,7 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>, <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG>
|
||||
|
||||
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>def_prog_mode</STRONG>, <STRONG>def_shell_mode</STRONG>, <STRONG>reset_prog_mode</STRONG>,
|
||||
<STRONG>reset_shell_mode</STRONG>, <STRONG>resetty</STRONG>, <STRONG>savetty</STRONG>, <STRONG>getsyx</STRONG>, <STRONG>setsyx</STRONG>,
|
||||
<STRONG>ripoffline</STRONG>, <STRONG>curs_set</STRONG>, <STRONG>napms</STRONG> - low-level <STRONG>curses</STRONG> routines
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>def_prog_mode(void);</STRONG>
|
||||
@ -69,15 +67,13 @@
|
||||
<STRONG>int</STRONG> <STRONG>napms(int</STRONG> <EM>ms</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The following routines give low-level access to various
|
||||
<STRONG>curses</STRONG> capabilities. These routines typically are used
|
||||
inside library routines.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-def_prog_mode_-def_shell_mode">def_prog_mode, def_shell_mode</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-def_prog_mode_-def_shell_mode">def_prog_mode, def_shell_mode</a></H3><PRE>
|
||||
The <STRONG>def_prog_mode</STRONG> and <STRONG>def_shell_mode</STRONG> routines save the
|
||||
current terminal modes as the "program" (in <STRONG>curses</STRONG>) or
|
||||
"shell" (not in <STRONG>curses</STRONG>) state for use by the <STRONG>re-</STRONG>
|
||||
@ -86,8 +82,7 @@
|
||||
each screen context allocated by <STRONG>newterm()</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-reset_prog_mode_-reset_shell_mode">reset_prog_mode, reset_shell_mode</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-reset_prog_mode_-reset_shell_mode">reset_prog_mode, reset_shell_mode</a></H3><PRE>
|
||||
The <STRONG>reset_prog_mode</STRONG> and <STRONG>reset_shell_mode</STRONG> routines restore
|
||||
the terminal to "program" (in <STRONG>curses</STRONG>) or "shell" (out of
|
||||
<STRONG>curses</STRONG>) state. These are done automatically by <STRONG>endwin</STRONG>
|
||||
@ -95,16 +90,14 @@
|
||||
not called.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-resetty_-savetty">resetty, savetty</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-resetty_-savetty">resetty, savetty</a></H3><PRE>
|
||||
The <STRONG>resetty</STRONG> and <STRONG>savetty</STRONG> routines save and restore the
|
||||
state of the terminal modes. <STRONG>savetty</STRONG> saves the current
|
||||
state in a buffer and <STRONG>resetty</STRONG> restores the state to what
|
||||
it was at the last call to <STRONG>savetty</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-getsyx">getsyx</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-getsyx">getsyx</a></H3><PRE>
|
||||
The <STRONG>getsyx</STRONG> routine returns the current coordinates of the
|
||||
virtual screen cursor in <EM>y</EM> and <EM>x</EM>. If <STRONG>leaveok</STRONG> is currently
|
||||
<STRONG>TRUE</STRONG>, then <STRONG>-1</STRONG>,<STRONG>-1</STRONG> is returned. If lines have been removed
|
||||
@ -113,8 +106,7 @@
|
||||
as arguments for <STRONG>setsyx</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-setsyx">setsyx</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-setsyx">setsyx</a></H3><PRE>
|
||||
The <STRONG>setsyx</STRONG> routine sets the virtual screen cursor to <EM>y</EM>, <EM>x</EM>.
|
||||
If <EM>y</EM> and <EM>x</EM> are both <STRONG>-1</STRONG>, then <STRONG>leaveok</STRONG> is set. The two rou-
|
||||
tines <STRONG>getsyx</STRONG> and <STRONG>setsyx</STRONG> are designed to be used by a li-
|
||||
@ -126,8 +118,7 @@
|
||||
<STRONG>doupdate</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-ripoffline">ripoffline</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-ripoffline">ripoffline</a></H3><PRE>
|
||||
The <STRONG>ripoffline</STRONG> routine provides access to the same facili-
|
||||
ty that <STRONG>slk_init</STRONG> [see <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>] uses to reduce the
|
||||
size of the screen. <STRONG>ripoffline</STRONG> must be called before
|
||||
@ -159,8 +150,7 @@
|
||||
<STRONG>initscr</STRONG> or <STRONG>newterm</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-curs_set">curs_set</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-curs_set">curs_set</a></H3><PRE>
|
||||
The <STRONG>curs_set</STRONG> routine sets the cursor state to invisible,
|
||||
normal, or very visible for <STRONG>visibility</STRONG> equal to <STRONG>0</STRONG>, <STRONG>1</STRONG>, or <STRONG>2</STRONG>
|
||||
respectively. If the terminal supports the <EM>visibility</EM> re-
|
||||
@ -168,13 +158,11 @@
|
||||
<STRONG>ERR</STRONG> is returned.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-napms">napms</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-napms">napms</a></H3><PRE>
|
||||
The <STRONG>napms</STRONG> routine is used to sleep for <EM>ms</EM> milliseconds.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Except for <STRONG>curs_set</STRONG>, these routines always return <STRONG>OK</STRONG>.
|
||||
|
||||
<STRONG>curs_set</STRONG> returns the previous cursor state, or <STRONG>ERR</STRONG> if the
|
||||
@ -194,8 +182,7 @@
|
||||
lines exceeds the maximum (NRIPS = 5).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>getsyx</STRONG> is a macro, so <STRONG>&</STRONG> is not necessary before
|
||||
the variables <EM>y</EM> and <EM>x</EM>.
|
||||
|
||||
@ -211,8 +198,7 @@
|
||||
to restore that.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The functions <STRONG>setsyx</STRONG> and <STRONG>getsyx</STRONG> are not described in the
|
||||
XSI Curses standard, Issue 4. All other functions are as
|
||||
described in XSI Curses.
|
||||
@ -222,8 +208,7 @@
|
||||
macros with no documented semantics for the return value.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></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_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG>curs_re-</STRONG>
|
||||
<STRONG><A HREF="curs_refresh.3x.html">fresh(3x)</A></STRONG>, <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>, <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>, <STRONG>curs_vari-</STRONG>
|
||||
<STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG>.
|
||||
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
curs_legacy - get <STRONG>curses</STRONG> cursor and window coordinates,
|
||||
attributes
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>getattrs(WINDOW</STRONG> <STRONG>*win);</STRONG>
|
||||
@ -66,8 +64,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>getpary(WINDOW</STRONG> <STRONG>*win);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <STRONG>getbegy</STRONG> and <STRONG>getbegx</STRONG> functions return the same data as
|
||||
<STRONG>getbegyx</STRONG>.
|
||||
|
||||
@ -81,14 +78,12 @@
|
||||
<STRONG>getparyx</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
These functions return an integer, or ERR if the window
|
||||
parameter is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
All of these interfaces are provided as macros and func-
|
||||
tions. The macros are suppressed (and only the functions
|
||||
provided) when <STRONG>NCURSES_OPAQUE</STRONG> is defined. The standard
|
||||
@ -98,14 +93,12 @@
|
||||
the WINDOW structure.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions were supported on Version 7, BSD or System
|
||||
V implementations.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG>, <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>
|
||||
|
||||
|
||||
|
||||
@ -45,22 +45,19 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>_nc_freeall</STRONG> <STRONG>_nc_free_and_exit</STRONG> - <STRONG>curses</STRONG> memory-leak
|
||||
checking
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>void</STRONG> <STRONG>_nc_freeall(void);</STRONG>
|
||||
<STRONG>void</STRONG> <STRONG>_nc_free_and_exit(int);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These functions are used to simplify analysis of memory
|
||||
leaks in the ncurses library. They are normally not
|
||||
available; they must be configured into the library at
|
||||
@ -84,18 +81,15 @@
|
||||
code to pass to the exit routine.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
These functions do not return a value.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are not part of the XSI interface.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
|
||||
|
||||
|
||||
|
||||
@ -46,15 +46,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>has_mouse</STRONG>, <STRONG>getmouse</STRONG>, <STRONG>ungetmouse</STRONG>, <STRONG>mousemask</STRONG>, <STRONG>wenclose</STRONG>,
|
||||
<STRONG>mouse_trafo</STRONG>, <STRONG>wmouse_trafo</STRONG>, <STRONG>mouseinterval</STRONG> - mouse interface
|
||||
through curses
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>typedef</STRONG> <STRONG>unsigned</STRONG> <STRONG>long</STRONG> <STRONG>mmask_t;</STRONG>
|
||||
@ -76,15 +74,13 @@
|
||||
<STRONG>int</STRONG> <STRONG>mouseinterval(int</STRONG> <EM>erval</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These functions provide an interface to mouse events from
|
||||
<STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>. Mouse events are represented by <STRONG>KEY_MOUSE</STRONG>
|
||||
pseudo-key values in the <STRONG>wgetch</STRONG> input stream.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-mousemask">mousemask</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-mousemask">mousemask</a></H3><PRE>
|
||||
To make mouse events visible, use the <STRONG>mousemask</STRONG> function.
|
||||
This will set the mouse events to be reported. By de-
|
||||
fault, no mouse events are reported. The function will
|
||||
@ -99,8 +95,7 @@
|
||||
Whether this happens is device-dependent.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Mouse-events">Mouse events</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Mouse-events">Mouse events</a></H3><PRE>
|
||||
Here are the mouse event type masks which may be defined:
|
||||
|
||||
<EM>Name</EM> <EM>Description</EM>
|
||||
@ -145,8 +140,7 @@
|
||||
---------------------------------------------------------------------
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-getmouse">getmouse</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-getmouse">getmouse</a></H3><PRE>
|
||||
Once a class of mouse events has been made visible in a
|
||||
window, calling the <STRONG>wgetch</STRONG> function on that window may re-
|
||||
turn <STRONG>KEY_MOUSE</STRONG> as an indicator that a mouse event has been
|
||||
@ -162,16 +156,14 @@
|
||||
next older item from the queue.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-ungetmouse">ungetmouse</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-ungetmouse">ungetmouse</a></H3><PRE>
|
||||
The <STRONG>ungetmouse</STRONG> function behaves analogously to <STRONG>ungetch</STRONG>.
|
||||
It pushes a <STRONG>KEY_MOUSE</STRONG> event onto the input queue, and as-
|
||||
sociates with that event the given state data and screen-
|
||||
relative character-cell coordinates.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-wenclose">wenclose</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-wenclose">wenclose</a></H3><PRE>
|
||||
The <STRONG>wenclose</STRONG> function tests whether a given pair of
|
||||
screen-relative character-cell coordinates is enclosed by
|
||||
a given window, returning <STRONG>TRUE</STRONG> if it is and <STRONG>FALSE</STRONG> other-
|
||||
@ -179,8 +171,7 @@
|
||||
screen windows enclose the location of a mouse event.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-wmouse_trafo">wmouse_trafo</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-wmouse_trafo">wmouse_trafo</a></H3><PRE>
|
||||
The <STRONG>wmouse_trafo</STRONG> function transforms a given pair of coor-
|
||||
dinates from stdscr-relative coordinates to coordinates
|
||||
relative to the given window or vice versa. The resulting
|
||||
@ -211,14 +202,12 @@
|
||||
nates if the transformation was successful.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-mouse_trafo">mouse_trafo</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-mouse_trafo">mouse_trafo</a></H3><PRE>
|
||||
The <STRONG>mouse_trafo</STRONG> function performs the same translation as
|
||||
<STRONG>wmouse_trafo</STRONG>, using stdscr for <STRONG>win</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-mouseinterval">mouseinterval</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-mouseinterval">mouseinterval</a></H3><PRE>
|
||||
The <STRONG>mouseinterval</STRONG> function sets the maximum time (in thou-
|
||||
sands of a second) that can elapse between press and re-
|
||||
lease events for them to be recognized as a click. Use
|
||||
@ -228,8 +217,7 @@
|
||||
default is one sixth of a second.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-has_mouse">has_mouse</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-has_mouse">has_mouse</a></H3><PRE>
|
||||
The <STRONG>has_mouse</STRONG> function returns <STRONG>TRUE</STRONG> if the mouse driver
|
||||
has been successfully initialized.
|
||||
|
||||
@ -239,8 +227,7 @@
|
||||
<STRONG>str</STRONG> that expects a linefeed for input-loop termination.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
<STRONG>getmouse</STRONG> and <STRONG>ungetmouse</STRONG> return the integer <STRONG>ERR</STRONG> upon fail-
|
||||
ure or <STRONG>OK</STRONG> upon successful completion:
|
||||
|
||||
@ -266,8 +253,7 @@
|
||||
<STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG> depending on their test result.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These calls were designed for <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, and are not
|
||||
found in SVr4 curses, 4.4BSD curses, or any other previous
|
||||
version of curses.
|
||||
@ -322,8 +308,7 @@
|
||||
ton-releases.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-BUGS">BUGS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-BUGS">BUGS</a></H2><PRE>
|
||||
Mouse events under xterm will not in fact be ignored dur-
|
||||
ing cooked mode, if they have been enabled by <STRONG>mousemask</STRONG>.
|
||||
Instead, the xterm mouse report sequence will appear in
|
||||
@ -345,8 +330,7 @@
|
||||
events.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>, <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>, <STRONG>curs_vari-</STRONG>
|
||||
<STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG>.
|
||||
|
||||
|
||||
@ -45,21 +45,18 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>move</STRONG>, <STRONG>wmove</STRONG> - move <STRONG>curses</STRONG> window cursor
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>move(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
|
||||
<STRONG>int</STRONG> <STRONG>wmove(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These routines move the cursor associated with the window
|
||||
to line <EM>y</EM> and column <EM>x</EM>. This routine does not move the
|
||||
physical cursor of the terminal until <STRONG>refresh</STRONG> is called.
|
||||
@ -67,8 +64,7 @@
|
||||
corner of the window, which is (0,0).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
These routines return <STRONG>ERR</STRONG> upon failure and OK (SVr4 speci-
|
||||
fies only "an integer value other than <STRONG>ERR</STRONG>") upon success-
|
||||
ful completion.
|
||||
@ -77,19 +73,16 @@
|
||||
is null, or if the position is outside the window.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>move</STRONG> may be a macro.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are described in the XSI Curses standard,
|
||||
Issue 4.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>
|
||||
|
||||
|
||||
|
||||
@ -45,16 +45,14 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>is_cleared</STRONG>, <STRONG>is_idlok</STRONG>, <STRONG>is_idcok</STRONG>, <STRONG>is_immedok</STRONG>, <STRONG>is_keypad</STRONG>,
|
||||
<STRONG>is_leaveok</STRONG>, <STRONG>is_nodelay</STRONG>, <STRONG>is_notimeout</STRONG>, <STRONG>is_pad</STRONG>, <STRONG>is_scrollok</STRONG>,
|
||||
<STRONG>is_subwin</STRONG>, <STRONG>is_syncok</STRONG>, <STRONG>wgetdelay</STRONG>, <STRONG>wgetparent</STRONG>, <STRONG>wgetscrreg</STRONG> -
|
||||
<STRONG>curses</STRONG> window properties
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>bool</STRONG> <STRONG>is_cleared(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
|
||||
@ -74,8 +72,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>wgetscrreg(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>*top,</STRONG> <STRONG>int</STRONG> <STRONG>*bottom);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
This implementation provides functions which return prop-
|
||||
erties set in the WINDOW structure, allowing it to be
|
||||
"opaque" if the symbol <STRONG>NCURSES_OPAQUE</STRONG> is defined:
|
||||
@ -130,26 +127,22 @@
|
||||
margin as set in <STRONG>wsetscrreg</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
These functions all return <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>, except as noted.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Both a macro and a function are provided for each name.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines are specific to ncurses. They were not
|
||||
supported on Version 7, BSD or System V implementations.
|
||||
It is recommended that any code depending on ncurses ex-
|
||||
tensions be conditioned using NCURSES_VERSION.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG>curs_win-</STRONG>
|
||||
<STRONG><A HREF="curs_window.3x.html">dow(3x)</A></STRONG>
|
||||
|
||||
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>clearok</STRONG>, <STRONG>idlok</STRONG>, <STRONG>idcok</STRONG>, <STRONG>immedok</STRONG>, <STRONG>leaveok</STRONG>, <STRONG>setscrreg</STRONG>,
|
||||
<STRONG>wsetscrreg</STRONG>, <STRONG>scrollok</STRONG>, <STRONG>nl</STRONG>, <STRONG>nonl</STRONG> - <STRONG>curses</STRONG> output options
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>clearok(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
|
||||
@ -67,16 +65,14 @@
|
||||
<STRONG>int</STRONG> <STRONG>nonl(void);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These routines set options that change the style of output
|
||||
within <STRONG>curses</STRONG>. All options are initially <STRONG>FALSE</STRONG>, unless
|
||||
otherwise stated. It is not necessary to turn these op-
|
||||
tions off before calling <STRONG>endwin</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-clearok">clearok</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-clearok">clearok</a></H3><PRE>
|
||||
If <STRONG>clearok</STRONG> is called with <STRONG>TRUE</STRONG> as argument, the next call
|
||||
to <STRONG>wrefresh</STRONG> with this window will clear the screen com-
|
||||
pletely and redraw the entire screen from scratch. This
|
||||
@ -87,8 +83,7 @@
|
||||
screen to be cleared and repainted from scratch.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-idlok">idlok</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-idlok">idlok</a></H3><PRE>
|
||||
If <STRONG>idlok</STRONG> is called with <STRONG>TRUE</STRONG> as second argument, <STRONG>curses</STRONG>
|
||||
considers using the hardware insert/delete line feature of
|
||||
terminals so equipped. Calling <STRONG>idlok</STRONG> with <STRONG>FALSE</STRONG> as second
|
||||
@ -102,8 +97,7 @@
|
||||
lines.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-idcok">idcok</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-idcok">idcok</a></H3><PRE>
|
||||
If <STRONG>idcok</STRONG> is called with <STRONG>FALSE</STRONG> as second argument, <STRONG>curses</STRONG>
|
||||
no longer considers using the hardware insert/delete char-
|
||||
acter feature of terminals so equipped. Use of character
|
||||
@ -112,8 +106,7 @@
|
||||
tion and deletion.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-immedok">immedok</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-immedok">immedok</a></H3><PRE>
|
||||
If <STRONG>immedok</STRONG> is called with <STRONG>TRUE</STRONG> <STRONG>as</STRONG> <STRONG>argument</STRONG>, any change in
|
||||
the window image, such as the ones caused by <STRONG>waddch,</STRONG> <STRONG>wclr-</STRONG>
|
||||
<STRONG>tobot,</STRONG> <STRONG>wscrl</STRONG>, etc., automatically cause a call to <STRONG>wre-</STRONG>
|
||||
@ -122,8 +115,7 @@
|
||||
fault.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-leaveok">leaveok</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-leaveok">leaveok</a></H3><PRE>
|
||||
Normally, the hardware cursor is left at the location of
|
||||
the window cursor being refreshed. The <STRONG>leaveok</STRONG> option al-
|
||||
lows the cursor to be left wherever the update happens to
|
||||
@ -131,8 +123,7 @@
|
||||
is not used, since it reduces the need for cursor motions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-setscrreg">setscrreg</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-setscrreg">setscrreg</a></H3><PRE>
|
||||
The <STRONG>setscrreg</STRONG> and <STRONG>wsetscrreg</STRONG> routines allow the applica-
|
||||
tion programmer to set a software scrolling region in a
|
||||
window. The <EM>top</EM> and <EM>bot</EM> parameters are the line numbers
|
||||
@ -149,8 +140,7 @@
|
||||
will probably be used by the output routines.)
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-scrollok">scrollok</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-scrollok">scrollok</a></H3><PRE>
|
||||
The <STRONG>scrollok</STRONG> option controls what happens when the cursor
|
||||
of a window is moved off the edge of the window or
|
||||
scrolling region, either as a result of a newline action
|
||||
@ -162,8 +152,7 @@
|
||||
call <STRONG>idlok</STRONG>).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-nl_-nonl">nl, nonl</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-nl_-nonl">nl, nonl</a></H3><PRE>
|
||||
The <STRONG>nl</STRONG> and <STRONG>nonl</STRONG> routines control whether the underlying
|
||||
display device translates the return key into newline on
|
||||
input, and whether it translates newline into return and
|
||||
@ -176,8 +165,7 @@
|
||||
the return key.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The functions <STRONG>setscrreg</STRONG> and <STRONG>wsetscrreg</STRONG> return <STRONG>OK</STRONG> upon suc-
|
||||
cess and <STRONG>ERR</STRONG> upon failure. All other routines that return
|
||||
an integer always return <STRONG>OK</STRONG>.
|
||||
@ -200,8 +188,7 @@
|
||||
mentation returns an error if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are described in the XSI Curses standard,
|
||||
Issue 4.
|
||||
|
||||
@ -230,8 +217,7 @@
|
||||
not. Use <STRONG>curs_set</STRONG> to make the cursor invisible.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>clearok</STRONG>, <STRONG>leaveok</STRONG>, <STRONG>scrollok</STRONG>, <STRONG>idcok</STRONG>, <STRONG>nl</STRONG>, <STRONG>nonl</STRONG> and
|
||||
<STRONG>setscrreg</STRONG> may be macros.
|
||||
|
||||
@ -239,8 +225,7 @@
|
||||
terminal emulators.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>, <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>,
|
||||
<STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>,
|
||||
<STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
|
||||
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>overlay</STRONG>, <STRONG>overwrite</STRONG>, <STRONG>copywin</STRONG> - overlay and manipulate
|
||||
overlapped <STRONG>curses</STRONG> windows
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>overlay(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>srcwin</EM><STRONG>,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>dstwin</EM><STRONG>);</STRONG>
|
||||
@ -63,11 +61,9 @@
|
||||
<STRONG>int</STRONG> <EM>dmaxcol</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>overlay</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-overlay_-overwrite">overlay, overwrite</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-overlay_-overwrite">overlay, overwrite</a></H3><PRE>
|
||||
The <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines overlay <EM>srcwin</EM> on top
|
||||
of <EM>dstwin</EM>. <EM>scrwin</EM> and <EM>dstwin</EM> are not required to be the
|
||||
same size; only text where the two windows overlap is
|
||||
@ -75,8 +71,7 @@
|
||||
(blanks are not copied) whereas <STRONG>overwrite</STRONG> is destructive.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-copywin">copywin</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-copywin">copywin</a></H3><PRE>
|
||||
The <STRONG>copywin</STRONG> routine provides a finer granularity of con-
|
||||
trol over the <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines. As in the
|
||||
<STRONG>prefresh</STRONG> routine, a rectangle is specified in the destina-
|
||||
@ -86,8 +81,7 @@
|
||||
then copying is non-destructive, as in <STRONG>overlay</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Routines that return an integer return <STRONG>ERR</STRONG> upon failure,
|
||||
and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than
|
||||
<STRONG>ERR</STRONG>") upon successful completion.
|
||||
@ -98,21 +92,18 @@
|
||||
the window would be placed off-screen.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The XSI Curses standard, Issue 4 describes these functions
|
||||
(adding the const qualifiers). It further specifies their
|
||||
behavior in the presence of characters with multibyte ren-
|
||||
ditions (not yet supported in this implementation).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>
|
||||
|
||||
|
||||
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>newpad</STRONG>, <STRONG>subpad</STRONG>, <STRONG>prefresh</STRONG>, <STRONG>pnoutrefresh</STRONG>, <STRONG>pechochar</STRONG>,
|
||||
<STRONG>pecho_wchar</STRONG> - create and display <STRONG>curses</STRONG> pads
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>WINDOW</STRONG> <STRONG>*newpad(int</STRONG> <EM>nlines</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>ncols</EM><STRONG>);</STRONG>
|
||||
@ -66,11 +64,9 @@
|
||||
<STRONG>int</STRONG> <STRONG>pecho_wchar(WINDOW</STRONG> <STRONG>*</STRONG><EM>pad</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-newpad">newpad</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-newpad">newpad</a></H3><PRE>
|
||||
The <STRONG>newpad</STRONG> routine creates and returns a pointer to a new
|
||||
pad data structure with the given number of lines, <EM>nlines</EM>,
|
||||
and columns, <EM>ncols</EM>. A pad is like a window, except that
|
||||
@ -87,8 +83,7 @@
|
||||
to be used for the display.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-subpad">subpad</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-subpad">subpad</a></H3><PRE>
|
||||
The <STRONG>subpad</STRONG> routine creates and returns a pointer to a sub-
|
||||
window within a pad with the given number of lines,
|
||||
<EM>nlines</EM>, and columns, <EM>ncols</EM>. Unlike <STRONG>subwin</STRONG>, which uses
|
||||
@ -100,8 +95,7 @@
|
||||
fore calling <STRONG>prefresh</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-prefresh_-pnoutrefresh">prefresh, pnoutrefresh</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-prefresh_-pnoutrefresh">prefresh, pnoutrefresh</a></H3><PRE>
|
||||
The <STRONG>prefresh</STRONG> and <STRONG>pnoutrefresh</STRONG> routines are analogous to
|
||||
<STRONG>wrefresh</STRONG> and <STRONG>wnoutrefresh</STRONG> except that they relate to pads
|
||||
instead of windows. The additional parameters are needed
|
||||
@ -118,8 +112,7 @@
|
||||
<EM>col</EM>, <EM>sminrow</EM>, or <EM>smincol</EM> are treated as if they were zero.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-pechochar">pechochar</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-pechochar">pechochar</a></H3><PRE>
|
||||
The <STRONG>pechochar</STRONG> routine is functionally equivalent to a call
|
||||
to <STRONG>addch</STRONG> followed by a call to <STRONG>refresh</STRONG>, a call to <STRONG>waddch</STRONG>
|
||||
followed by a call to <STRONG>wrefresh</STRONG>, or a call to <STRONG>waddch</STRONG> fol-
|
||||
@ -132,16 +125,14 @@
|
||||
arguments to <STRONG>prefresh</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-pecho_wchar">pecho_wchar</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-pecho_wchar">pecho_wchar</a></H3><PRE>
|
||||
The <STRONG>pecho_wchar</STRONG> function is the analogous wide-character
|
||||
form of <STRONG>pechochar</STRONG>. It outputs one character to a pad and
|
||||
immediately refreshes the pad. It does this by a call to
|
||||
<STRONG>wadd_wch</STRONG> followed by a call to <STRONG>prefresh</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Routines that return an integer return <STRONG>ERR</STRONG> upon failure
|
||||
and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than
|
||||
<STRONG>ERR</STRONG>") upon successful completion.
|
||||
@ -169,19 +160,16 @@
|
||||
turns an error.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>pechochar</STRONG> may be a macro.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The XSI Curses standard, Issue 4 describes these func-
|
||||
tions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG>, <STRONG>curs_add-</STRONG>
|
||||
<STRONG><A HREF="curs_addch.3x.html">ch(3x)</A></STRONG>.
|
||||
|
||||
|
||||
@ -45,20 +45,17 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>mcprint</STRONG> - ship binary data to printer
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>mcprint(char</STRONG> <STRONG>*data,</STRONG> <STRONG>int</STRONG> <STRONG>len);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
This function uses the <STRONG>mc5p</STRONG> or <STRONG>mc4</STRONG> and <STRONG>mc5</STRONG> capabilities,
|
||||
if they are present, to ship given data to a printer
|
||||
attached to the terminal.
|
||||
@ -73,8 +70,7 @@
|
||||
sleep for a second after shipping each 80-character line.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The <STRONG>mcprint</STRONG> function returns <STRONG>ERR</STRONG> if the write operation
|
||||
aborted for some reason. In this case, errno will contain
|
||||
either an error associated with <STRONG>write(2)</STRONG> or one of the
|
||||
@ -91,21 +87,18 @@
|
||||
actually sent to the printer.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The <STRONG>mcprint</STRONG> call was designed for <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, and is not
|
||||
found in SVr4 curses, 4.4BSD curses, or any other previous
|
||||
version of curses.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-BUGS">BUGS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-BUGS">BUGS</a></H2><PRE>
|
||||
Padding in the <STRONG>mc5p</STRONG>, <STRONG>mc4</STRONG> and <STRONG>mc5</STRONG> capabilities will not be
|
||||
interpreted.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
|
||||
|
||||
|
||||
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>printw</STRONG>, <STRONG>wprintw</STRONG>, <STRONG>mvprintw</STRONG>, <STRONG>mvwprintw</STRONG>, <STRONG>vwprintw</STRONG>, <STRONG>vw_printw</STRONG>
|
||||
- print formatted output in <STRONG>curses</STRONG> windows
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>printw(const</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG>
|
||||
@ -66,8 +64,7 @@
|
||||
<STRONG>glist);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <STRONG>printw</STRONG>, <STRONG>wprintw</STRONG>, <STRONG>mvprintw</STRONG> and <STRONG>mvwprintw</STRONG> routines are
|
||||
analogous to <STRONG>printf</STRONG> [see <STRONG>printf(3)</STRONG>]. In effect, the
|
||||
string that would be output by <STRONG>printf</STRONG> is output instead as
|
||||
@ -80,8 +77,7 @@
|
||||
<STRONG><stdarg.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Routines that return an integer return <STRONG>ERR</STRONG> upon failure
|
||||
and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than
|
||||
<STRONG>ERR</STRONG>") upon successful completion.
|
||||
@ -96,8 +92,7 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The XSI Curses standard, Issue 4 describes these func-
|
||||
tions. The function <STRONG>vwprintw</STRONG> is marked TO BE WITHDRAWN,
|
||||
and is to be replaced by a function <STRONG>vw_printw</STRONG> using the
|
||||
@ -109,8 +104,7 @@
|
||||
is included in <STRONG><curses.h</STRONG>>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG>printf(3)</STRONG>, <STRONG>vprintf(3)</STRONG>
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<!--
|
||||
****************************************************************************
|
||||
* Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. *
|
||||
* Copyright (c) 1998-2010,2016 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 *
|
||||
@ -26,7 +26,7 @@
|
||||
* sale, use or other dealings in this Software without prior written *
|
||||
* authorization. *
|
||||
****************************************************************************
|
||||
* @Id: curs_refresh.3x,v 1.15 2010/12/04 18:38:55 tom Exp @
|
||||
* @Id: curs_refresh.3x,v 1.16 2016/01/30 15:52:36 tom Exp @
|
||||
-->
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
|
||||
<HTML>
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>doupdate</STRONG>, <STRONG>redrawwin</STRONG>, <STRONG>refresh</STRONG>, <STRONG>wnoutrefresh</STRONG>, <STRONG>wredrawln</STRONG>,
|
||||
<STRONG>wrefresh</STRONG> - refresh <STRONG>curses</STRONG> windows and lines
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>refresh(void);</STRONG>
|
||||
@ -63,8 +61,9 @@
|
||||
<STRONG>int</STRONG> <STRONG>wredrawln(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>beg_line,</STRONG> <STRONG>int</STRONG> <STRONG>num_lines);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
|
||||
</PRE><H3><a name="h3-refresh_wrefresh">refresh/wrefresh</a></H3><PRE>
|
||||
The <STRONG>refresh</STRONG> and <STRONG>wrefresh</STRONG> routines (or <STRONG>wnoutrefresh</STRONG> and
|
||||
<STRONG>doupdate</STRONG>) must be called to get actual output to the ter-
|
||||
minal, as other routines merely manipulate data struc-
|
||||
@ -76,6 +75,8 @@
|
||||
minal is left at the location of the cursor for that win-
|
||||
dow.
|
||||
|
||||
|
||||
</PRE><H3><a name="h3-wnoutrefresh_doupdate">wnoutrefresh/doupdate</a></H3><PRE>
|
||||
The <STRONG>wnoutrefresh</STRONG> and <STRONG>doupdate</STRONG> routines allow multiple up-
|
||||
dates with more efficiency than <STRONG>wrefresh</STRONG> alone. In addi-
|
||||
tion to all the window structures, <STRONG>curses</STRONG> keeps two data
|
||||
@ -108,6 +109,8 @@
|
||||
see the section on <STRONG>PORTABILITY</STRONG> below for a warning about
|
||||
exploiting this behavior.)
|
||||
|
||||
|
||||
</PRE><H3><a name="h3-wredrawln_redrawwin">wredrawln/redrawwin</a></H3><PRE>
|
||||
The <STRONG>wredrawln</STRONG> routine indicates to <STRONG>curses</STRONG> that some screen
|
||||
lines are corrupted and should be thrown away before any-
|
||||
thing is written over them. It touches the indicated
|
||||
@ -115,8 +118,7 @@
|
||||
touches the entire window.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Routines that return an integer return <STRONG>ERR</STRONG> upon failure,
|
||||
and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than
|
||||
<STRONG>ERR</STRONG>") upon successful completion.
|
||||
@ -124,22 +126,20 @@
|
||||
X/Open does not define any error conditions. In this im-
|
||||
plementation
|
||||
|
||||
<STRONG>wnoutrefresh</STRONG>
|
||||
returns an error if the window pointer is
|
||||
null, or if the window is really a pad.
|
||||
<STRONG>wnoutrefresh</STRONG>
|
||||
returns an error if the window pointer is null, or
|
||||
if the window is really a pad.
|
||||
|
||||
<STRONG>wredrawln</STRONG>
|
||||
returns an error if the associated call to
|
||||
<STRONG>touchln</STRONG> returns an error.
|
||||
<STRONG>wredrawln</STRONG>
|
||||
returns an error if the associated call to <STRONG>touchln</STRONG>
|
||||
returns an error.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>refresh</STRONG> and <STRONG>redrawwin</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The XSI Curses standard, Issue 4 describes these func-
|
||||
tions.
|
||||
|
||||
@ -153,8 +153,7 @@
|
||||
antee an entire-contents copy anywhere.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
|
||||
|
||||
|
||||
@ -165,7 +164,13 @@
|
||||
<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-refresh_wrefresh">refresh/wrefresh</a></li>
|
||||
<li><a href="#h3-wnoutrefresh_doupdate">wnoutrefresh/doupdate</a></li>
|
||||
<li><a href="#h3-wredrawln_redrawwin">wredrawln/redrawwin</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
|
||||
<li><a href="#h2-NOTES">NOTES</a></li>
|
||||
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
|
||||
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>scanw</STRONG>, <STRONG>wscanw</STRONG>, <STRONG>mvscanw</STRONG>, <STRONG>mvwscanw</STRONG>, <STRONG>vwscanw</STRONG>, <STRONG>vw_scanw</STRONG> - con-
|
||||
vert formatted input from a <STRONG>curses</STRONG> window
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>scanw(char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG>
|
||||
@ -63,8 +61,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>vwscanw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>va_list</STRONG> <STRONG>varglist);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <STRONG>scanw</STRONG>, <STRONG>wscanw</STRONG> and <STRONG>mvscanw</STRONG> routines are analogous to
|
||||
<STRONG>scanf</STRONG> [see <STRONG>scanf(3)</STRONG>]. The effect of these routines is as
|
||||
though <STRONG>wgetstr</STRONG> were called on the window, and the result-
|
||||
@ -77,8 +74,7 @@
|
||||
ments, as defined in <STRONG><stdarg.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
<STRONG>vwscanw</STRONG> returns <STRONG>ERR</STRONG> on failure and an integer equal to the
|
||||
number of fields scanned on success.
|
||||
|
||||
@ -91,8 +87,7 @@
|
||||
outside the window, or if the window pointer is null.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The XSI Curses standard, Issue 4 describes these func-
|
||||
tions. The function <STRONG>vwscanw</STRONG> is marked TO BE WITHDRAWN,
|
||||
and is to be replaced by a function <STRONG>vw_scanw</STRONG> using the
|
||||
@ -116,8 +111,7 @@
|
||||
something was processed.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>, <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG>, <STRONG>scanf(3)</STRONG>
|
||||
|
||||
|
||||
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>scr_dump</STRONG>, <STRONG>scr_restore</STRONG>, <STRONG>scr_init</STRONG>, <STRONG>scr_set</STRONG> - read (write) a
|
||||
<STRONG>curses</STRONG> screen from (to) a file
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>scr_dump(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG>
|
||||
@ -61,8 +59,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>scr_set(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <STRONG>scr_dump</STRONG> routine dumps the current contents of the
|
||||
virtual screen to the file <EM>filename</EM>.
|
||||
|
||||
@ -93,8 +90,7 @@
|
||||
and <STRONG>putwin</STRONG> routines [see <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>].
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG>
|
||||
upon success.
|
||||
|
||||
@ -103,14 +99,12 @@
|
||||
opened.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>scr_init</STRONG>, <STRONG>scr_set</STRONG>, and <STRONG>scr_restore</STRONG> may be
|
||||
macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The XSI Curses standard, Issue 4, describes these func-
|
||||
tions (adding the const qualifiers).
|
||||
|
||||
@ -119,8 +113,7 @@
|
||||
is old" but do not define "old".
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></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_refresh.3x.html">curs_refresh(3x)</A></STRONG>,
|
||||
<STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG>system(3)</STRONG>
|
||||
|
||||
|
||||
@ -45,13 +45,11 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>scroll</STRONG>, <STRONG>scrl</STRONG>, <STRONG>wscrl</STRONG> - scroll a <STRONG>curses</STRONG> window
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>scroll(WINDOW</STRONG> <STRONG>*win);</STRONG>
|
||||
@ -59,8 +57,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>wscrl(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <STRONG>scroll</STRONG> routine scrolls the window up one line. This
|
||||
involves moving the lines in the window data structure.
|
||||
As an optimization, if the scrolling region of the window
|
||||
@ -77,8 +74,7 @@
|
||||
<STRONG>scrollok</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
These routines return <STRONG>ERR</STRONG> upon failure, and <STRONG>OK</STRONG> (SVr4 only
|
||||
specifies "an integer value other than <STRONG>ERR</STRONG>") upon success-
|
||||
ful completion.
|
||||
@ -90,8 +86,7 @@
|
||||
e.g., with <STRONG>scrollok</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>scrl</STRONG> and <STRONG>scroll</STRONG> may be macros.
|
||||
|
||||
The SVr4 documentation says that the optimization of phys-
|
||||
@ -108,14 +103,12 @@
|
||||
plementation it is.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The XSI Curses standard, Issue 4 describes these func-
|
||||
tions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
|
||||
|
||||
|
||||
|
||||
@ -45,8 +45,7 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>slk_init</STRONG>, <STRONG>slk_set</STRONG>, <STRONG>slk_wset</STRONG>, <STRONG>slk_refresh</STRONG>, <STRONG>slk_noutrefresh</STRONG>,
|
||||
<STRONG>slk_label</STRONG>, <STRONG>slk_clear</STRONG>, <STRONG>slk_restore</STRONG>, <STRONG>slk_touch</STRONG>, <STRONG>slk_attron</STRONG>,
|
||||
<STRONG>slk_attrset</STRONG>, <STRONG>slk_attroff</STRONG>, <STRONG>slk_attr_on</STRONG>, <STRONG>slk_attr_set</STRONG>,
|
||||
@ -54,8 +53,7 @@
|
||||
routines
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>slk_init(int</STRONG> <STRONG>fmt);</STRONG>
|
||||
@ -78,8 +76,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>slk_wset(int</STRONG> <STRONG>labnum,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*label,</STRONG> <STRONG>int</STRONG> <STRONG>fmt);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The slk* functions manipulate the set of soft function-key
|
||||
labels that exist on many terminals. For those terminals
|
||||
that do not have soft labels, <STRONG>curses</STRONG> takes over the bottom
|
||||
@ -153,8 +150,7 @@
|
||||
line of the screen.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
These routines return <STRONG>ERR</STRONG> upon failure and OK (SVr4 speci-
|
||||
fies only "an integer value other than <STRONG>ERR</STRONG>") upon success-
|
||||
ful completion.
|
||||
@ -201,14 +197,12 @@
|
||||
be allocated.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Most applications would use <STRONG>slk_noutrefresh</STRONG> because a <STRONG>wre-</STRONG>
|
||||
<STRONG>fresh</STRONG> is likely to follow soon.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The XSI Curses standard, Issue 4, describes these func-
|
||||
tions. It changes the argument type of the attribute-ma-
|
||||
nipulation functions <STRONG>slk_attron</STRONG>, <STRONG>slk_attroff</STRONG>, <STRONG>slk_attrset</STRONG>
|
||||
@ -217,8 +211,7 @@
|
||||
cific to ncurses.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG>curs_re-</STRONG>
|
||||
<STRONG><A HREF="curs_refresh.3x.html">fresh(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
|
||||
|
||||
|
||||
@ -48,13 +48,11 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
curs_sp_funcs - <STRONG>curses</STRONG> screen-pointer extension
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>assume_default_colors_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
|
||||
@ -187,8 +185,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>tputs_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>int,</STRONG> <STRONG>NCURSES_SP_OUTC);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
This implementation can be configured to provide a set of
|
||||
functions which improve the ability to manage multiple
|
||||
screens. This feature can be added to any of the configu-
|
||||
@ -196,8 +193,7 @@
|
||||
without changing the meaning of any of the existing ones.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-IMPROVED-FUNCTIONS">IMPROVED FUNCTIONS</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-IMPROVED-FUNCTIONS">IMPROVED FUNCTIONS</a></H3><PRE>
|
||||
Most of the functions are new versions of existing func-
|
||||
tions. A parameter is added at the front of the parameter
|
||||
list. It is a SCREEN pointer.
|
||||
@ -208,8 +204,7 @@
|
||||
which must be modified to update multiple screens.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-NEW-FUNCTIONS">NEW FUNCTIONS</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-NEW-FUNCTIONS">NEW FUNCTIONS</a></H3><PRE>
|
||||
Here are the new functions:
|
||||
|
||||
ceiling_panel
|
||||
@ -232,8 +227,7 @@
|
||||
initialization.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
This extension introduces some new names:
|
||||
|
||||
NCURSES_SP_FUNCS
|
||||
@ -262,16 +256,14 @@
|
||||
stream, e.g., <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines are specific to ncurses. They were not
|
||||
supported on Version 7, BSD or System V implementations.
|
||||
It is recommended that any code depending on ncurses ex-
|
||||
tensions be conditioned using <EM>NCURSES</EM><STRONG>_</STRONG><EM>SP</EM><STRONG>_</STRONG><EM>FUNCS</EM>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>, <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>.
|
||||
|
||||
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>baudrate</STRONG>, <STRONG>erasechar</STRONG>, <STRONG>erasewchar</STRONG>, <STRONG>has_ic</STRONG>, <STRONG>has_il</STRONG>, <STRONG>killchar</STRONG>,
|
||||
<STRONG>killwchar</STRONG>, <STRONG>longname</STRONG>, <STRONG>term_attrs</STRONG>, <STRONG>termattrs</STRONG>, <STRONG>termname</STRONG> -
|
||||
<STRONG>curses</STRONG> environment query routines
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>baudrate(void);</STRONG>
|
||||
@ -69,18 +67,15 @@
|
||||
<STRONG>char</STRONG> <STRONG>*termname(void);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-baudrate">baudrate</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-baudrate">baudrate</a></H3><PRE>
|
||||
The <STRONG>baudrate</STRONG> routine returns the output speed of the ter-
|
||||
minal. The number returned is in bits per second, for
|
||||
example <STRONG>9600</STRONG>, and is an integer.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-erasechar_-erasewchar">erasechar, erasewchar</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-erasechar_-erasewchar">erasechar, erasewchar</a></H3><PRE>
|
||||
The <STRONG>erasechar</STRONG> routine returns the user's current erase
|
||||
character.
|
||||
|
||||
@ -90,8 +85,7 @@
|
||||
erenced by <EM>ch</EM> is not changed.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-has_is_-has_il">has_is, has_il</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-has_is_-has_il">has_is, has_il</a></H3><PRE>
|
||||
The <STRONG>has_ic</STRONG> routine is true if the terminal has insert- and
|
||||
delete- character capabilities.
|
||||
|
||||
@ -102,8 +96,7 @@
|
||||
<STRONG>scrollok</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-killchar_-killwchar">killchar, killwchar</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-killchar_-killwchar">killchar, killwchar</a></H3><PRE>
|
||||
The <STRONG>killchar</STRONG> routine returns the user's current line kill
|
||||
character.
|
||||
|
||||
@ -113,8 +106,7 @@
|
||||
location referenced by <EM>ch</EM> is not changed.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-longname">longname</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-longname">longname</a></H3><PRE>
|
||||
The <STRONG>longname</STRONG> routine returns a pointer to a static area
|
||||
containing a verbose description of the current terminal.
|
||||
The maximum length of a verbose description is 128 charac-
|
||||
@ -125,8 +117,7 @@
|
||||
used with multiple terminals.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-termattrs_-term_attrs">termattrs, term_attrs</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-termattrs_-term_attrs">termattrs, term_attrs</a></H3><PRE>
|
||||
If a given terminal does not support a video attribute
|
||||
that an application program is trying to use, <STRONG>curses</STRONG> may
|
||||
substitute a different video attribute for it. The <STRONG>ter-</STRONG>
|
||||
@ -137,14 +128,12 @@
|
||||
appearance of the screen.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-termname">termname</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-termname">termname</a></H3><PRE>
|
||||
The <STRONG>termname</STRONG> routine returns the terminal name used by
|
||||
<STRONG>setupterm</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
<STRONG>longname</STRONG> and <STRONG>termname</STRONG> return <STRONG>NULL</STRONG> on error.
|
||||
|
||||
Routines that return an integer return <STRONG>ERR</STRONG> upon failure
|
||||
@ -152,21 +141,18 @@
|
||||
<STRONG>ERR</STRONG>") upon successful completion.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that <STRONG>termattrs</STRONG> may be a macro.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The XSI Curses standard, Issue 4 describes these func-
|
||||
tions. It changes the return type of <STRONG>termattrs</STRONG> to the new
|
||||
type <STRONG>attr_t</STRONG>. Most versions of curses truncate the result
|
||||
returned by <STRONG>termname</STRONG> to 14 characters.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></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_outopts.3x.html">curs_outopts(3x)</A></STRONG>
|
||||
|
||||
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>PC</STRONG>, <STRONG>UP</STRONG>, <STRONG>BC</STRONG>, <STRONG>ospeed</STRONG>, <STRONG>tgetent</STRONG>, <STRONG>tgetflag</STRONG>, <STRONG>tgetnum</STRONG>, <STRONG>tgetstr</STRONG>,
|
||||
<STRONG>tgoto</STRONG>, <STRONG>tputs</STRONG> - direct <STRONG>curses</STRONG> interface to the terminfo
|
||||
capability database
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
<STRONG>#include</STRONG> <STRONG><term.h></STRONG>
|
||||
|
||||
@ -70,8 +68,7 @@
|
||||
<STRONG>int</STRONG> <STRONG>tputs(const</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>affcnt,</STRONG> <STRONG>int</STRONG> <STRONG>(*putc)(int));</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These routines are included as a conversion aid for pro-
|
||||
grams that use the <EM>termcap</EM> library. Their parameters are
|
||||
the same and the routines are emulated using the <EM>terminfo</EM>
|
||||
@ -80,8 +77,7 @@
|
||||
compiled.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-INITIALIZATION">INITIALIZATION</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-INITIALIZATION">INITIALIZATION</a></H3><PRE>
|
||||
The <STRONG>tgetent</STRONG> routine loads the entry for <EM>name</EM>. It returns:
|
||||
|
||||
1 on success,
|
||||
@ -107,8 +103,7 @@
|
||||
terminal description has cursor-addressing.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-CAPABILITY-VALUES">CAPABILITY VALUES</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-CAPABILITY-VALUES">CAPABILITY VALUES</a></H3><PRE>
|
||||
The <STRONG>tgetflag</STRONG> routine gets the boolean entry for <EM>id</EM>, or ze-
|
||||
ro if it is not available.
|
||||
|
||||
@ -139,8 +134,7 @@
|
||||
<STRONG>flag</STRONG>, <STRONG>tgetnum</STRONG> and <STRONG>tgetstr</STRONG> are compared in lookups.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-FORMATTING-CAPABILITIES">FORMATTING CAPABILITIES</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-FORMATTING-CAPABILITIES">FORMATTING CAPABILITIES</a></H3><PRE>
|
||||
The <STRONG>tgoto</STRONG> routine instantiates the parameters into the
|
||||
given capability. The output from this routine is to be
|
||||
passed to <STRONG>tputs</STRONG>.
|
||||
@ -150,8 +144,7 @@
|
||||
cap or terminfo name.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-GLOBAL-VARIABLES">GLOBAL VARIABLES</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-GLOBAL-VARIABLES">GLOBAL VARIABLES</a></H3><PRE>
|
||||
The variables <STRONG>PC</STRONG>, <STRONG>UP</STRONG> and <STRONG>BC</STRONG> are set by <STRONG>tgetent</STRONG> to the ter-
|
||||
minfo entry's data for <STRONG>pad_char</STRONG>, <STRONG>cursor_up</STRONG> and
|
||||
<STRONG>backspace_if_not_bs</STRONG>, respectively. <STRONG>UP</STRONG> is not used by
|
||||
@ -161,8 +154,7 @@
|
||||
minal speed.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Except where explicitly noted, routines that return an in-
|
||||
teger return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 only specifies
|
||||
"an integer value other than <STRONG>ERR</STRONG>") upon successful comple-
|
||||
@ -171,8 +163,7 @@
|
||||
Routines that return pointers return <STRONG>NULL</STRONG> on error.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-BUGS">BUGS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-BUGS">BUGS</a></H2><PRE>
|
||||
If you call <STRONG>tgetstr</STRONG> to fetch <STRONG>ca</STRONG> or any other parameterized
|
||||
string, be aware that it will be returned in terminfo no-
|
||||
tation, not the older and not-quite-compatible termcap no-
|
||||
@ -197,8 +188,7 @@
|
||||
modate termcap's limitation in this respect.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The XSI Curses standard, Issue 4 describes these func-
|
||||
tions. However, they are marked TO BE WITHDRAWN and may
|
||||
be removed in future versions.
|
||||
@ -239,8 +229,7 @@
|
||||
longer than two characters.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>, <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>, <STRONG>putc(3)</STRONG>.
|
||||
|
||||
http://invisible-island.net/ncurses/tctest.html
|
||||
|
||||
@ -50,16 +50,14 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>del_curterm</STRONG>, <STRONG>mvcur</STRONG>, <STRONG>putp</STRONG>, <STRONG>restartterm</STRONG>, <STRONG>set_curterm</STRONG>,
|
||||
<STRONG>setterm</STRONG>, <STRONG>setupterm</STRONG>, <STRONG>tigetflag</STRONG>, <STRONG>tigetnum</STRONG>, <STRONG>tigetstr</STRONG>, <STRONG>tiparm</STRONG>,
|
||||
<STRONG>tparm</STRONG>, <STRONG>tputs</STRONG>, <STRONG>vid_attr</STRONG>, <STRONG>vid_puts</STRONG>, <STRONG>vidattr</STRONG>, <STRONG>vidputs</STRONG> -
|
||||
<STRONG>curses</STRONG> interfaces to terminfo database
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
<STRONG>#include</STRONG> <STRONG><term.h></STRONG>
|
||||
|
||||
@ -82,8 +80,7 @@
|
||||
<STRONG>char</STRONG> <STRONG>*tiparm(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>...);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These low-level routines must be called by programs that
|
||||
have to deal directly with the <STRONG>terminfo</STRONG> database to handle
|
||||
certain terminal capabilities, such as programming func-
|
||||
@ -91,8 +88,7 @@
|
||||
are more suitable and their use is recommended.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Initialization">Initialization</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Initialization">Initialization</a></H3><PRE>
|
||||
Initially, <STRONG>setupterm</STRONG> should be called. Note that <STRONG>se-</STRONG>
|
||||
<STRONG>tupterm</STRONG> is automatically called by <STRONG>initscr</STRONG> and <STRONG>newterm</STRONG>.
|
||||
This defines the set of terminal-dependent variables
|
||||
@ -181,8 +177,7 @@
|
||||
not recommended for new programs.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-The-Terminal-State">The Terminal State</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-The-Terminal-State">The Terminal State</a></H3><PRE>
|
||||
The <STRONG>setupterm</STRONG> routine stores its information about the
|
||||
terminal in a <STRONG>TERMINAL</STRONG> structure pointed to by the global
|
||||
variable <STRONG>cur_term</STRONG>. If it detects an error, or decides
|
||||
@ -219,8 +214,7 @@
|
||||
bits.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Formatting-Output">Formatting Output</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Formatting-Output">Formatting Output</a></H3><PRE>
|
||||
The <STRONG>tparm</STRONG> routine instantiates the string <EM>str</EM> with parame-
|
||||
ters <EM>pi</EM>. A pointer is returned to the result of <EM>str</EM> with
|
||||
the parameters applied.
|
||||
@ -230,8 +224,7 @@
|
||||
ters are integers (int) rather than longs.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Output-Functions">Output Functions</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Output-Functions">Output Functions</a></H3><PRE>
|
||||
The <STRONG>tputs</STRONG> routine applies padding information to the
|
||||
string <EM>str</EM> and outputs it. The <EM>str</EM> must be a terminfo
|
||||
string variable or the return value from <STRONG>tparm</STRONG>, <STRONG>tgetstr</STRONG>,
|
||||
@ -266,8 +259,7 @@
|
||||
fresh).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Terminal-Capability-Functions">Terminal Capability Functions</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Terminal-Capability-Functions">Terminal Capability Functions</a></H3><PRE>
|
||||
The <STRONG>tigetflag</STRONG>, <STRONG>tigetnum</STRONG> and <STRONG>tigetstr</STRONG> routines return the
|
||||
value of the capability corresponding to the <STRONG>terminfo</STRONG> <EM>cap-</EM>
|
||||
<EM>name</EM> passed to them, such as <STRONG>xenl</STRONG>. The <EM>capname</EM> for each
|
||||
@ -299,8 +291,7 @@
|
||||
scription.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Terminal-Capability-Names">Terminal Capability Names</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Terminal-Capability-Names">Terminal Capability Names</a></H3><PRE>
|
||||
These null-terminated arrays contain the short terminfo
|
||||
names ("codes"), the <STRONG>termcap</STRONG> names, and the long terminfo
|
||||
names ("fnames") for each of the predefined <STRONG>terminfo</STRONG> vari-
|
||||
@ -312,8 +303,7 @@
|
||||
<STRONG>char</STRONG> <STRONG>*strnames[]</STRONG>, <STRONG>*strcodes[]</STRONG>, <STRONG>*strfnames[]</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Routines that return an integer return <STRONG>ERR</STRONG> upon failure
|
||||
and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than
|
||||
<STRONG>ERR</STRONG>") upon successful completion, unless otherwise noted
|
||||
@ -347,8 +337,7 @@
|
||||
the output function <EM>putc</EM>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
X/Open notes that <STRONG>vidattr</STRONG> and <STRONG>vidputs</STRONG> may be macros.
|
||||
|
||||
The function <STRONG>setterm</STRONG> is not described by X/Open and must
|
||||
@ -425,8 +414,7 @@
|
||||
<STRONG>tic</STRONG> <STRONG>-x</STRONG>, are not stored in the arrays described here.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></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_kernel.3x.html">curs_kernel(3x)</A></STRONG>, <STRONG>curs_term-</STRONG>
|
||||
<STRONG><A HREF="curs_termcap.3x.html">cap(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>, <STRONG>putc(3)</STRONG>,
|
||||
<STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
|
||||
|
||||
@ -47,13 +47,11 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>curs_threads</STRONG> - <STRONG>curses</STRONG> thread support
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>typedef</STRONG> <STRONG>int</STRONG> <STRONG>(*NCURSES_WINDOW_CB)(WINDOW</STRONG> <STRONG>*,</STRONG> <STRONG>void</STRONG> <STRONG>*);</STRONG>
|
||||
@ -67,8 +65,7 @@
|
||||
<STRONG>*data);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
This implementation can be configured to provide rudimen-
|
||||
tary support for multi-threaded applications. This makes
|
||||
a different set of libraries, e.g., <EM>libncursest</EM> since the
|
||||
@ -109,8 +106,7 @@
|
||||
supplied function to the application.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-USAGE">USAGE</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-USAGE">USAGE</a></H3><PRE>
|
||||
All of the ncurses library functions assume that the lo-
|
||||
cale is not altered during operation. In addition, they
|
||||
use data which is maintained within a hierarchy of scopes.
|
||||
@ -602,26 +598,22 @@
|
||||
wvline_set window
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
These functions all return <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>, except as noted.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Both a macro and a function are provided for each name.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines are specific to ncurses. They were not
|
||||
supported on Version 7, BSD or System V implementations.
|
||||
It is recommended that any code depending on ncurses ex-
|
||||
tensions be conditioned using NCURSES_VERSION.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
|
||||
|
||||
|
||||
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>touchwin</STRONG>, <STRONG>touchline</STRONG>, <STRONG>untouchwin</STRONG>, <STRONG>wtouchln</STRONG>, <STRONG>is_linetouched</STRONG>,
|
||||
<STRONG>is_wintouched</STRONG> - <STRONG>curses</STRONG> refresh control routines
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
<STRONG>int</STRONG> <STRONG>touchwin(WINDOW</STRONG> <STRONG>*win);</STRONG>
|
||||
<STRONG>int</STRONG> <STRONG>touchline(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>start,</STRONG> <STRONG>int</STRONG> <STRONG>count);</STRONG>
|
||||
@ -62,8 +60,7 @@
|
||||
<STRONG>bool</STRONG> <STRONG>is_wintouched(WINDOW</STRONG> <STRONG>*win);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <STRONG>touchwin</STRONG> and <STRONG>touchline</STRONG> routines throw away all opti-
|
||||
mization information about which parts of the window have
|
||||
been touched, by pretending that the entire window has
|
||||
@ -88,8 +85,7 @@
|
||||
the given window.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
All routines return the integer <STRONG>ERR</STRONG> upon failure and an
|
||||
integer value other than <STRONG>ERR</STRONG> upon successful completion,
|
||||
unless otherwise noted in the preceding routine descrip-
|
||||
@ -111,8 +107,7 @@
|
||||
window.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The XSI Curses standard, Issue 4 describes these func-
|
||||
tions.
|
||||
|
||||
@ -122,13 +117,11 @@
|
||||
<STRONG>scr)</STRONG>. This will not work under ncurses.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Note that all routines except <STRONG>wtouchln</STRONG> may be macros.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
|
||||
|
||||
|
||||
|
||||
@ -45,16 +45,14 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>_tracef</STRONG>, <STRONG>_tracedump</STRONG>, <STRONG>_traceattr</STRONG>, <STRONG>_traceattr2</STRONG>,
|
||||
<STRONG>_nc_tracebits</STRONG>, <STRONG>_tracecchar_t</STRONG>, <STRONG>_tracecchar_t2</STRONG>, <STRONG>_tracechar</STRONG>,
|
||||
<STRONG>_tracechtype</STRONG>, <STRONG>_tracechtype2</STRONG>, <STRONG>_tracemouse</STRONG>, <STRONG>trace</STRONG> - <STRONG>curses</STRONG>
|
||||
debugging routines
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>void</STRONG> <STRONG>_tracef(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>format</EM><STRONG>,</STRONG> <STRONG>...);</STRONG>
|
||||
@ -71,8 +69,7 @@
|
||||
<STRONG>void</STRONG> <STRONG>trace(const</STRONG> <STRONG>unsigned</STRONG> <STRONG>int</STRONG> <EM>param</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <STRONG>trace</STRONG> routines are used for debugging the ncurses li-
|
||||
braries, as well as applications which use the ncurses li-
|
||||
braries. These functions are normally available only with
|
||||
@ -168,22 +165,19 @@
|
||||
tent, use_env, use_extended_names, use_tioctl
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Routines which return a value are designed to be used as
|
||||
parameters to the <STRONG>_tracef</STRONG> routine.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These functions are not part of the XSI interface. Some
|
||||
other curses implementations are known to have similar,
|
||||
undocumented features, but they are not compatible with
|
||||
ncurses.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
|
||||
|
||||
|
||||
|
||||
@ -46,15 +46,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>delay_output</STRONG>, <STRONG>filter</STRONG>, <STRONG>flushinp</STRONG>, <STRONG>getwin</STRONG>, <STRONG>key_name</STRONG>, <STRONG>keyname</STRONG>,
|
||||
<STRONG>nofilter</STRONG>, <STRONG>putwin</STRONG>, <STRONG>unctrl</STRONG>, <STRONG>use_env</STRONG>, <STRONG>use_tioctl</STRONG>, <STRONG>wunctrl</STRONG> -
|
||||
miscellaneous <STRONG>curses</STRONG> utility routines
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>char</STRONG> <STRONG>*unctrl(chtype</STRONG> <STRONG>c);</STRONG>
|
||||
@ -71,11 +69,9 @@
|
||||
<STRONG>int</STRONG> <STRONG>flushinp(void);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-unctrl">unctrl</a></H3><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-
|
||||
@ -84,8 +80,7 @@
|
||||
of a wide character.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-keyname_key_name">keyname/key_name</a></H3><PRE>
|
||||
</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>:
|
||||
|
||||
@ -118,8 +113,7 @@
|
||||
ter.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-filter_nofilter">filter/nofilter</a></H3><PRE>
|
||||
</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>,
|
||||
@ -133,8 +127,7 @@
|
||||
modifies the in-memory copy of the terminal information.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-use_env">use_env</a></H3><PRE>
|
||||
</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-
|
||||
@ -162,8 +155,7 @@
|
||||
environment variables,
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-use_tioctl">use_tioctl</a></H3><PRE>
|
||||
</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
|
||||
@ -202,8 +194,7 @@
|
||||
to determine size.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-putwin_getwin">putwin/getwin</a></H3><PRE>
|
||||
</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-
|
||||
@ -230,8 +221,7 @@
|
||||
will not be colored when the window is refreshed.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-delay_output">delay_output</a></H3><PRE>
|
||||
</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
|
||||
@ -239,15 +229,13 @@
|
||||
<STRONG>napms</STRONG> to perform the delay.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-flushinp">flushinp</a></H3><PRE>
|
||||
</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.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Except for <STRONG>flushinp</STRONG>, routines that return an integer re-
|
||||
turn <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 specifies only "an in-
|
||||
teger value other than <STRONG>ERR</STRONG>") upon successful completion.
|
||||
@ -269,19 +257,16 @@
|
||||
return an error.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-filter">filter</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-filter">filter</a></H3><PRE>
|
||||
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>
|
||||
<H3><a name="h3-keyname">keyname</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-keyname">keyname</a></H3><PRE>
|
||||
The <STRONG>keyname</STRONG> function may return the names of user-defined
|
||||
string capabilities which are defined in the terminfo en-
|
||||
try via the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG>. This implementation auto-
|
||||
@ -295,8 +280,7 @@
|
||||
brary.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-nofilter_use_tioctl">nofilter/use_tioctl</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-nofilter_use_tioctl">nofilter/use_tioctl</a></H3><PRE>
|
||||
The <STRONG>nofilter</STRONG> and <STRONG>use_tioctl</STRONG> routines are specific to
|
||||
ncurses. They were not supported on Version 7, BSD or
|
||||
System V implementations. It is recommended that any code
|
||||
@ -304,8 +288,7 @@
|
||||
NCURSES_VERSION.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-putwin_getwin">putwin/getwin</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-putwin_getwin">putwin/getwin</a></H3><PRE>
|
||||
The <STRONG>putwin</STRONG> and <STRONG>getwin</STRONG> functions have several issues with
|
||||
portability:
|
||||
|
||||
@ -339,8 +322,7 @@
|
||||
may not be successful.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-unctrl_wunctrl">unctrl/wunctrl</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-unctrl_wunctrl">unctrl/wunctrl</a></H3><PRE>
|
||||
The XSI Curses standard, Issue 4 describes these func-
|
||||
tions. It states that <STRONG>unctrl</STRONG> and <STRONG>wunctrl</STRONG> will return a
|
||||
null pointer if unsuccessful, but does not define any er-
|
||||
@ -387,8 +369,7 @@
|
||||
"M-^A", etc.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG>curs_ker-</STRONG>
|
||||
<STRONG><A HREF="curs_kernel.3x.html">nel(3x)</A></STRONG>, <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, <STRONG>lega-</STRONG>
|
||||
<STRONG><A HREF="legacy_coding.3x.html">cy_coding(3x)</A></STRONG>.
|
||||
|
||||
@ -45,14 +45,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>COLORS</STRONG>, <STRONG>COLOR_PAIRS</STRONG>, <STRONG>COLS</STRONG>, <STRONG>ESCDELAY</STRONG>, <STRONG>LINES</STRONG>, <STRONG>TABSIZE</STRONG>,
|
||||
<STRONG>curscr</STRONG>, <STRONG>newscr</STRONG>, <STRONG>stdscr</STRONG> - <STRONG>curses</STRONG> global variables
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>COLOR_PAIRS;</STRONG>
|
||||
@ -66,8 +64,7 @@
|
||||
<STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>stdscr;</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
This page summarizes variables provided by the <STRONG>curses</STRONG> li-
|
||||
brary. A more complete description is given in the <STRONG>curs-</STRONG>
|
||||
<STRONG><A HREF="ncurses.3x.html">es(3x)</A></STRONG> manual page.
|
||||
@ -79,8 +76,7 @@
|
||||
them as read-only to avoid confusing the library.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-COLOR_PAIRS">COLOR_PAIRS</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-COLOR_PAIRS">COLOR_PAIRS</a></H3><PRE>
|
||||
After initializing curses, this variable contains the num-
|
||||
ber of color pairs which the terminal can support. Usual-
|
||||
ly the number of color pairs will be the product <STRONG>COL-</STRONG>
|
||||
@ -94,20 +90,17 @@
|
||||
sented in a <EM>signed</EM> <EM>short</EM> value.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-COLORS">COLORS</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-COLORS">COLORS</a></H3><PRE>
|
||||
After initializing curses, this variable contains the num-
|
||||
ber of colors which the terminal can support.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-COLS">COLS</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-COLS">COLS</a></H3><PRE>
|
||||
After initializing curses, this variable contains the
|
||||
width of the screen, i.e., the number of columns.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-ESCDELAY">ESCDELAY</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-ESCDELAY">ESCDELAY</a></H3><PRE>
|
||||
This variable holds the number of milliseconds to wait af-
|
||||
ter reading an escape character, to distinguish between an
|
||||
individual escape character entered on the keyboard from
|
||||
@ -115,41 +108,35 @@
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-LINES">LINES</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-LINES">LINES</a></H3><PRE>
|
||||
After initializing curses, this variable contains the
|
||||
height of the screen, i.e., the number of lines.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-TABSIZE">TABSIZE</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-TABSIZE">TABSIZE</a></H3><PRE>
|
||||
This variable holds the number of columns used by the
|
||||
<EM>curses</EM> library when converting a tab character to spaces
|
||||
as it adds the tab to a window (see <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-The-Current-Screen">The Current Screen</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-The-Current-Screen">The Current Screen</a></H3><PRE>
|
||||
This implementation of curses uses a special window <STRONG>curscr</STRONG>
|
||||
to record its updates to the terminal screen.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-The-New-Screen">The New Screen</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-The-New-Screen">The New Screen</a></H3><PRE>
|
||||
This implementation of curses uses a special window <STRONG>newscr</STRONG>
|
||||
to hold updates to the terminal screen before applying
|
||||
them to <STRONG>curscr</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-The-Standard-Screen">The Standard Screen</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-The-Standard-Screen">The Standard Screen</a></H3><PRE>
|
||||
Upon initializing curses, a default window called <STRONG>stdscr</STRONG>,
|
||||
which is the size of the terminal screen, is created.
|
||||
Many curses functions use this window.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The curses library is initialized using either
|
||||
<STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, or <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>.
|
||||
|
||||
@ -158,8 +145,7 @@
|
||||
library.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
ESCDELAY and TABSIZE are extensions, not provided in most
|
||||
other implementations of curses.
|
||||
|
||||
@ -179,8 +165,7 @@
|
||||
ed to override the value, or rely upon its default value.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>, <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>,
|
||||
<STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>, <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
|
||||
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>newwin</STRONG>, <STRONG>delwin</STRONG>, <STRONG>mvwin</STRONG>, <STRONG>subwin</STRONG>, <STRONG>derwin</STRONG>, <STRONG>mvderwin</STRONG>, <STRONG>dupwin</STRONG>,
|
||||
<STRONG>wsyncup</STRONG>, <STRONG>syncok</STRONG>, <STRONG>wcursyncup</STRONG>, <STRONG>wsyncdown</STRONG> - create <STRONG>curses</STRONG>
|
||||
windows
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>WINDOW</STRONG> <STRONG>*newwin(</STRONG>
|
||||
@ -75,11 +73,9 @@
|
||||
<STRONG>void</STRONG> <STRONG>wsyncdown(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-newwin">newwin</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-newwin">newwin</a></H3><PRE>
|
||||
Calling <STRONG>newwin</STRONG> creates and returns a pointer to a new win-
|
||||
dow with the given number of lines and columns. The upper
|
||||
left-hand corner of the window is at
|
||||
@ -94,16 +90,14 @@
|
||||
<STRONG>newwin(0,0,0,0)</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-delwin">delwin</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-delwin">delwin</a></H3><PRE>
|
||||
Calling <STRONG>delwin</STRONG> deletes the named window, freeing all memo-
|
||||
ry associated with it (it does not actually erase the win-
|
||||
dow's screen image). Subwindows must be deleted before
|
||||
the main window can be deleted.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-mvwin">mvwin</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-mvwin">mvwin</a></H3><PRE>
|
||||
Calling <STRONG>mvwin</STRONG> moves the window so that the upper left-hand
|
||||
corner is at position (<EM>x</EM>, <EM>y</EM>). If the move would cause the
|
||||
window to be off the screen, it is an error and the window
|
||||
@ -111,8 +105,7 @@
|
||||
avoided.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-subwin">subwin</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-subwin">subwin</a></H3><PRE>
|
||||
Calling <STRONG>subwin</STRONG> creates and returns a pointer to a new win-
|
||||
dow with the given number of lines, <EM>nlines</EM>, and columns,
|
||||
<EM>ncols</EM>. The window is at position (<EM>begin</EM>_<EM>y</EM>, <EM>begin</EM>_<EM>x</EM>) on
|
||||
@ -123,8 +116,7 @@
|
||||
the subwindow.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-derwin">derwin</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-derwin">derwin</a></H3><PRE>
|
||||
Calling <STRONG>derwin</STRONG> is the same as calling <STRONG>subwin,</STRONG> except that
|
||||
<EM>begin</EM>_<EM>y</EM> and <EM>begin</EM>_<EM>x</EM> are relative to the origin of the win-
|
||||
dow <EM>orig</EM> rather than the screen. There is no difference
|
||||
@ -137,37 +129,32 @@
|
||||
physical position on the screen.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-dupwin">dupwin</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-dupwin">dupwin</a></H3><PRE>
|
||||
Calling <STRONG>dupwin</STRONG> creates an exact duplicate of the window
|
||||
<EM>win</EM>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-wsyncup">wsyncup</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-wsyncup">wsyncup</a></H3><PRE>
|
||||
Calling <STRONG>wsyncup</STRONG> touches all locations in ancestors of <EM>win</EM>
|
||||
that are changed in <EM>win</EM>. If <STRONG>syncok</STRONG> is called with second
|
||||
argument <STRONG>TRUE</STRONG> then <STRONG>wsyncup</STRONG> is called automatically whenev-
|
||||
er there is a change in the window.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-wsyncdown">wsyncdown</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-wsyncdown">wsyncdown</a></H3><PRE>
|
||||
The <STRONG>wsyncdown</STRONG> routine touches each location in <EM>win</EM> that
|
||||
has been touched in any of its ancestor windows. This
|
||||
routine is called by <STRONG>wrefresh</STRONG>, so it should almost never
|
||||
be necessary to call it manually.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-wcursyncup">wcursyncup</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-wcursyncup">wcursyncup</a></H3><PRE>
|
||||
The routine <STRONG>wcursyncup</STRONG> updates the current cursor position
|
||||
of all the ancestors of the window to reflect the current
|
||||
cursor position of the window.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Routines that return an integer return the integer <STRONG>ERR</STRONG> up-
|
||||
on failure and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value
|
||||
other than <STRONG>ERR</STRONG>") upon successful completion.
|
||||
@ -223,16 +210,14 @@
|
||||
been initialized, i.e., with <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
If many small changes are made to the window, the <STRONG>wsyncup</STRONG>
|
||||
option could degrade performance.
|
||||
|
||||
Note that <STRONG>syncok</STRONG> may be a macro.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-BUGS">BUGS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-BUGS">BUGS</a></H2><PRE>
|
||||
The subwindow functions (<EM>subwin</EM>, <EM>derwin</EM>, <EM>mvderwin</EM>, <STRONG>wsyn-</STRONG>
|
||||
<STRONG>cup</STRONG>, <STRONG>wsyncdown</STRONG>, <STRONG>wcursyncup</STRONG>, <STRONG>syncok</STRONG>) are flaky, incomplete-
|
||||
ly implemented, and not well tested.
|
||||
@ -246,14 +231,12 @@
|
||||
may result in slower updates.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The XSI Curses standard, Issue 4 describes these func-
|
||||
tions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG>, <STRONG>curs_vari-</STRONG>
|
||||
<STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG>
|
||||
|
||||
|
||||
@ -46,22 +46,19 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>use_default_colors</STRONG>, <STRONG>assume_default_colors</STRONG> - use terminal's
|
||||
default colors
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>use_default_colors(void);</STRONG>
|
||||
<STRONG>int</STRONG> <STRONG>assume_default_colors(int</STRONG> <STRONG>fg,</STRONG> <STRONG>int</STRONG> <STRONG>bg);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <EM>use</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors()</EM> and <EM>assume</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors()</EM> func-
|
||||
tions are extensions to the curses library. They are used
|
||||
with terminals that support ISO 6429 color, or equivalent.
|
||||
@ -110,8 +107,7 @@
|
||||
black background for color pair 0.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
These functions return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG>
|
||||
on success. They will fail if either the terminal does
|
||||
not support the <EM>orig</EM><STRONG>_</STRONG><EM>pair</EM> or <EM>orig</EM><STRONG>_</STRONG><EM>colors</EM> capability. If
|
||||
@ -119,8 +115,7 @@
|
||||
an error as well.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
Associated with this extension, the <STRONG>init_pair</STRONG> function
|
||||
accepts negative arguments to specify default foreground
|
||||
or background colors.
|
||||
@ -149,21 +144,18 @@
|
||||
setting specific values.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines are specific to ncurses. They were not
|
||||
supported on Version 7, BSD or System V implementations.
|
||||
It is recommended that any code depending on them be con-
|
||||
ditioned using NCURSES_VERSION.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>, <STRONG>ded(1)</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
Thomas Dickey (from an analysis of the requirements for
|
||||
color xterm for XFree86 3.1.2C, February 1996).
|
||||
|
||||
|
||||
@ -46,20 +46,17 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>define_key</STRONG> - define a keycode
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>define_key(const</STRONG> <STRONG>char</STRONG> <STRONG>*definition,</STRONG> <STRONG>int</STRONG> <STRONG>keycode);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
This is an extension to the curses library. It permits an
|
||||
application to define keycodes with their corresponding
|
||||
control strings, so that the ncurses library will inter-
|
||||
@ -72,8 +69,7 @@
|
||||
definition is removed.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The keycode must be greater than zero, and the string non-
|
||||
null, otherwise ERR is returned. ERR may also be returned
|
||||
if there is insufficient memory to allocate the data to
|
||||
@ -81,21 +77,18 @@
|
||||
returned.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines are specific to ncurses. They were not
|
||||
supported on Version 7, BSD or System V implementations.
|
||||
It is recommended that any code depending on them be con-
|
||||
ditioned using NCURSES_VERSION.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>, <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
Thomas Dickey.
|
||||
|
||||
|
||||
|
||||
@ -46,18 +46,15 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>form</STRONG> - curses extension for programming forms
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <STRONG>form</STRONG> library provides terminal-independent facilities
|
||||
for composing form screens on character-cell terminals.
|
||||
The library includes: field routines, which create and
|
||||
@ -78,8 +75,7 @@
|
||||
called before using any of these functions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Current-Default-Values-for-Field-Attributes">Current Default Values for Field Attributes</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Current-Default-Values-for-Field-Attributes">Current Default Values for Field Attributes</a></H3><PRE>
|
||||
The <STRONG>form</STRONG> library maintains a default value for field
|
||||
attributes. You can get or set this default by calling
|
||||
the appropriate <STRONG>set_</STRONG> or retrieval routine with a <STRONG>NULL</STRONG>
|
||||
@ -88,8 +84,7 @@
|
||||
rendering of fields already created.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Routine-Name-Index">Routine Name Index</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Routine-Name-Index">Routine Name Index</a></H3><PRE>
|
||||
The following table lists each <STRONG>form</STRONG> routine and the name
|
||||
of the manual page on which it is described.
|
||||
|
||||
@ -172,8 +167,7 @@
|
||||
unpost_form <STRONG><A HREF="form_post.3x.html">form_post(3x)</A></STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Routines that return pointers return <STRONG>NULL</STRONG> on error, and
|
||||
set errno to the corresponding error-code returned by
|
||||
functions returning an integer. Routines that return an
|
||||
@ -217,8 +211,7 @@
|
||||
The form driver code saw an unknown request code.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
files <STRONG><curses.h></STRONG> and <STRONG><eti.h></STRONG>.
|
||||
|
||||
@ -228,24 +221,21 @@
|
||||
using most linkers).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for ncurses
|
||||
by Eric S. Raymond.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
|
||||
detailed descriptions of the entry points.
|
||||
|
||||
This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20151205).
|
||||
This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20160130).
|
||||
|
||||
|
||||
|
||||
|
||||
@ -46,19 +46,16 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>pos_form_cursor</STRONG> - position a form window cursor
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
int pos_form_cursor(FORM *form);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>pos_form_cursor</STRONG> restores the cursor to the
|
||||
position required for the forms driver to continue pro-
|
||||
cessing requests. This is useful after <STRONG>curses</STRONG> routines
|
||||
@ -66,8 +63,7 @@
|
||||
form operation.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
This routine returns one of the following:
|
||||
|
||||
<STRONG>E_OK</STRONG> The routine succeeded.
|
||||
@ -83,25 +79,21 @@
|
||||
System error occurred (see <STRONG>errno</STRONG>).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,21 +46,18 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>data_ahead</STRONG>, <STRONG>data_behind</STRONG> - test for off-screen data in
|
||||
given forms
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
bool data_ahead(const FORM *form);
|
||||
bool data_behind(const FORM *form);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>data_ahead</STRONG> tests whether there is off-screen
|
||||
data ahead in the given form. It returns TRUE (1) or
|
||||
FALSE (0).
|
||||
@ -70,25 +67,21 @@
|
||||
FALSE (0).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -45,24 +45,20 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>form_driver</STRONG>, <STRONG>form_driver_w</STRONG> - command-processing loop of
|
||||
the form system
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
<STRONG>int</STRONG> <STRONG>form_driver(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>c</EM><STRONG>);</STRONG>
|
||||
<STRONG>int</STRONG> <STRONG>form_driver_w(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>c</EM><STRONG>,</STRONG> <STRONG>wchar_t</STRONG> <EM>wch</EM><STRONG>);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-form_driver">form_driver</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-form_driver">form_driver</a></H3><PRE>
|
||||
Once a form has been posted (displayed), you should funnel
|
||||
input events to it through <STRONG>form_driver</STRONG>. This routine has
|
||||
three major input cases:
|
||||
@ -80,8 +76,7 @@
|
||||
an mouse event.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-form_driver_w">form_driver_w</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-form_driver_w">form_driver_w</a></H3><PRE>
|
||||
This extension simplifies the use of the forms library
|
||||
using wide characters. The input is either a key code (a
|
||||
request) or a wide character returned by <STRONG><A HREF="get_wch.3x.html">get_wch(3x)</A></STRONG>. The
|
||||
@ -90,8 +85,7 @@
|
||||
request.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Form-driver-requests">Form-driver requests</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Form-driver-requests">Form-driver requests</a></H3><PRE>
|
||||
The form driver requests are as follows:
|
||||
|
||||
<EM>Name</EM> <EM>Description</EM>
|
||||
@ -162,8 +156,7 @@
|
||||
that request is executed.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Mouse-handling">Mouse handling</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Mouse-handling">Mouse handling</a></H3><PRE>
|
||||
If the second argument is the KEY_MOUSE special key, the
|
||||
associated mouse event is translated into one of the above
|
||||
pre-defined requests. Currently only clicks in the user
|
||||
@ -207,8 +200,7 @@
|
||||
<STRONG>E_REQUEST_DENIED</STRONG> is returned.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Application-defined-commands">Application-defined commands</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Application-defined-commands">Application-defined commands</a></H3><PRE>
|
||||
If the second argument is neither printable nor one of the
|
||||
above pre-defined form requests, the driver assumes it is
|
||||
an application-specific command and returns <STRONG>E_UNKNOWN_COM-</STRONG>
|
||||
@ -217,8 +209,7 @@
|
||||
defined requests.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
<STRONG>form_driver</STRONG> returns one of the following error codes:
|
||||
|
||||
<STRONG>E_OK</STRONG> The routine succeeded.
|
||||
@ -247,25 +238,21 @@
|
||||
The form driver code saw an unknown request code.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>, <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
files <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,14 +46,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>form_field</STRONG> - make and break connections between fields and
|
||||
forms
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
int set_form_fields(FORM *form, FIELD **fields);
|
||||
FIELD **form_fields(const FORM *form);
|
||||
@ -61,8 +59,7 @@
|
||||
int move_field(FIELD *field, int frow, int fcol);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>set_form_fields</STRONG> changes the field pointer
|
||||
array of the given <EM>form</EM>. The array must be terminated by
|
||||
a <STRONG>NULL</STRONG>.
|
||||
@ -77,8 +74,7 @@
|
||||
be disconnected) to a specified location on the screen.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The function <STRONG>form_fields</STRONG> returns a pointer (which may be
|
||||
<STRONG>NULL</STRONG>). It does not set errno.
|
||||
|
||||
@ -104,19 +100,16 @@
|
||||
System error occurred (see <STRONG>errno</STRONG>).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
@ -124,8 +117,7 @@
|
||||
<STRONG>field_count</STRONG> error value as -1 (which is the value of <STRONG>ERR</STRONG>).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,14 +46,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>form_field_attributes</STRONG> - color and attribute control for
|
||||
form fields
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
int set_field_fore(FIELD *field, chtype attr);
|
||||
chtype field_fore(const FIELD *field);
|
||||
@ -63,8 +61,7 @@
|
||||
int field_pad(const FIELD *field);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>set_field_fore</STRONG> sets the foreground attribute
|
||||
of <EM>field</EM>. This is the highlight used to display the field
|
||||
contents. The function <STRONG>field_fore</STRONG> returns the foreground
|
||||
@ -80,8 +77,7 @@
|
||||
form's pad character. The default is a blank.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
These routines return one of the following:
|
||||
|
||||
<STRONG>E_OK</STRONG> The routine succeeded.
|
||||
@ -94,26 +90,22 @@
|
||||
System error occurred (see <STRONG>errno</STRONG>).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
|
||||
detailed descriptions of the entry points.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,13 +46,11 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>form_field_buffer</STRONG> - field buffer control
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
|
||||
int set_field_buffer(FIELD *field, int buf, const char
|
||||
@ -63,8 +61,7 @@
|
||||
int set_max_field(FIELD *field, int max);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>set_field_buffer</STRONG> sets the numbered buffer of
|
||||
the given field to contain a given string:
|
||||
|
||||
@ -112,8 +109,7 @@
|
||||
size threshold for that field.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The <STRONG>field_buffer</STRONG> function returns NULL on error. It sets
|
||||
errno according to their success:
|
||||
|
||||
@ -137,14 +133,12 @@
|
||||
ment.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
|
||||
detailed descriptions of the entry points.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file
|
||||
|
||||
@ -155,14 +149,12 @@
|
||||
<STRONG>fer</STRONG> to return the same buffer. <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,14 +46,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>dynamic_field_info</STRONG>, <STRONG>field_info</STRONG> - retrieve field character-
|
||||
istics
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
int field_info(const FIELD *field, int *rows, int *cols,
|
||||
int *frow, int *fcol, int *nrow, int *nbuf);
|
||||
@ -61,8 +59,7 @@
|
||||
*cols, int *max);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>field_info</STRONG> returns the sizes and other
|
||||
attributes passed in to the field at its creation time.
|
||||
The attributes are: height, width, row of upper-left cor-
|
||||
@ -76,8 +73,7 @@
|
||||
turning off the <STRONG>O_STATIC</STRONG> option with <STRONG>field_opts_off</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
These routines return one of the following:
|
||||
|
||||
<STRONG>E_OK</STRONG> The routine succeeded.
|
||||
@ -90,20 +86,17 @@
|
||||
ment.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
|
||||
detailed descriptions of the entry points.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
@ -112,8 +105,7 @@
|
||||
allow this, e.g., Solaris 2.7 does not.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,29 +46,25 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>set_field_just</STRONG>, <STRONG>field_just</STRONG> - retrieve field characteris-
|
||||
tics
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
int set_field_just(FIELD *field, int justification);
|
||||
int field_just(const FIELD *field);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>set_field_just</STRONG> sets the justification
|
||||
attribute of a field; <STRONG>field_just</STRONG> returns a field's justi-
|
||||
fication attribute. The attribute may be one of NO_JUSTI-
|
||||
FICATION, JUSTIFY_RIGHT, JUSTIFY_LEFT, or JUSTIFY_CENTER.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The function <STRONG>field_just</STRONG> returns one of: NO_JUSTIFICATION,
|
||||
JUSTIFY_RIGHT, JUSTIFY_LEFT, or JUSTIFY_CENTER.
|
||||
|
||||
@ -84,26 +80,22 @@
|
||||
ment.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
|
||||
detailed descriptions of the entry points.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,14 +46,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>new_field</STRONG>, <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG>, <STRONG>free_field</STRONG> - create and
|
||||
destroy form fields
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
FIELD *new_field(int height, int width,
|
||||
int toprow, int leftcol,
|
||||
@ -63,8 +61,7 @@
|
||||
int free_field(FIELD *field);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>new_field</STRONG> allocates a new field and initial-
|
||||
izes it from the parameters given: height, width, row of
|
||||
upper-left corner, column of upper-left corner, number
|
||||
@ -85,8 +82,7 @@
|
||||
with a field.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The function, <STRONG>new_field</STRONG>, <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG> return <STRONG>NULL</STRONG>
|
||||
on error. They set errno according to their success:
|
||||
|
||||
@ -111,19 +107,16 @@
|
||||
field is connected.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
@ -133,8 +126,7 @@
|
||||
what does not.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,14 +46,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>set_field_opts</STRONG>, <STRONG>field_opts_on</STRONG>, <STRONG>field_opts_off</STRONG>, <STRONG>field_opts</STRONG>
|
||||
- set and get field options
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
int set_field_opts(FIELD *field, Field_Options opts);
|
||||
int field_opts_on(FIELD *field, Field_Options opts);
|
||||
@ -61,8 +59,7 @@
|
||||
Field_Options field_opts(const FIELD *field);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>set_field_opts</STRONG> sets all the given field's
|
||||
option bits (field option bits may be logically-OR'ed
|
||||
together).
|
||||
@ -128,8 +125,7 @@
|
||||
which is normally discarded.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Except for <STRONG>field_opts</STRONG>, each routine returns one of the
|
||||
following:
|
||||
|
||||
@ -146,25 +142,21 @@
|
||||
System error occurred (see <STRONG>errno</STRONG>).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. <STRONG><A HREF="form_field_just.3x.html">form_field_just(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,47 +46,40 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>set_field_userptr</STRONG>, <STRONG>field_userptr</STRONG> - associate application
|
||||
data with a form field
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
int set_field_userptr(FIELD *field, void*userptr);
|
||||
void *field_userptr(const FIELD *field);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
Every form field has a field that can be used to hold
|
||||
application-specific data (that is, the form-driver code
|
||||
leaves it alone). These functions get and set that field.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The function <STRONG>field_userptr</STRONG> returns a pointer (which may be
|
||||
<STRONG>NULL</STRONG>). It does not set errno.
|
||||
|
||||
The function <STRONG>set_field_userptr</STRONG> returns <STRONG>E_OK</STRONG> (success).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
@ -94,8 +87,7 @@
|
||||
it as a char pointer for SVr4 compatibility.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -45,13 +45,11 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>form_field_validation</STRONG> - data type validation for fields
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
int set_field_type(FIELD *field, FIELDTYPE *type, ...);
|
||||
FIELDTYPE *field_type(const FIELD *field);
|
||||
@ -66,8 +64,7 @@
|
||||
FIELDTYPE *TYPE_IPV4;
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>set_field_type</STRONG> declares a data type for a
|
||||
given form field. This is the type checked by validation
|
||||
functions. The predefined types are as follows:
|
||||
@ -148,8 +145,7 @@
|
||||
types. See the <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> manual page.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The functions <STRONG>field_type</STRONG> and <STRONG>field_arg</STRONG> return <STRONG>NULL</STRONG> on
|
||||
error. The function <STRONG>set_field_type</STRONG> returns one of the fol-
|
||||
lowing:
|
||||
@ -160,25 +156,21 @@
|
||||
System error occurred (see <STRONG>errno</STRONG>).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>, <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,13 +46,11 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>form_fieldtype</STRONG> - define validation-field types
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
FIELDTYPE *new_fieldtype(
|
||||
bool (* const field_check)(FIELD *, const void *),
|
||||
@ -71,8 +69,7 @@
|
||||
FIELDTYPE *type2);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>new_fieldtype</STRONG> creates a new field type usable
|
||||
for data validation. You supply it with <EM>field</EM><STRONG>_</STRONG><EM>check</EM>, a
|
||||
predicate to check the validity of an entered data string
|
||||
@ -118,8 +115,7 @@
|
||||
arguments.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The pointer-valued routines return NULL on error. They
|
||||
set errno according to their success:
|
||||
|
||||
@ -151,13 +147,11 @@
|
||||
System error occurred (see <STRONG>errno</STRONG>).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
@ -166,14 +160,12 @@
|
||||
for strict compatibility with System V.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,14 +46,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>form_hook</STRONG> - set hooks for automatic invocation by applica-
|
||||
tions
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
int set_field_init(FORM *form, Form_Hook func);
|
||||
Form_Hook field_init(const FORM *form);
|
||||
@ -65,8 +63,7 @@
|
||||
Form_Hook form_term(const FORM *form);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These functions make it possible to set hook functions to
|
||||
be called at various points in the automatic processing of
|
||||
input event codes by <STRONG>form_driver</STRONG>.
|
||||
@ -92,8 +89,7 @@
|
||||
any (<STRONG>NULL</STRONG> if there is no such hook).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Routines that return pointers return <STRONG>NULL</STRONG> on error. Other
|
||||
routines return one of the following:
|
||||
|
||||
@ -103,25 +99,21 @@
|
||||
System error occurred (see <STRONG>errno</STRONG>).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,20 +46,17 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>new_form</STRONG>, <STRONG>free_form</STRONG> - create and destroy forms
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
FORM *new_form(FIELD **fields);
|
||||
int free_form(FORM *form);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>new_form</STRONG> creates a new form connected to a
|
||||
specified field pointer array (which must be <STRONG>NULL</STRONG>-termi-
|
||||
nated).
|
||||
@ -68,8 +65,7 @@
|
||||
array and frees the storage allocated for the form.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The function <STRONG>new_form</STRONG> returns <STRONG>NULL</STRONG> on error. It sets
|
||||
errno according to the function's success:
|
||||
|
||||
@ -97,25 +93,21 @@
|
||||
The form has already been posted.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,20 +46,17 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>set_new_page</STRONG>, <STRONG>new_page</STRONG> - form pagination functions
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
int set_new_page(FIELD *field, bool new_page_flag);
|
||||
bool new_page(const FIELD *field);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>set_new_page</STRONG> sets or resets a flag marking
|
||||
the given field as the beginning of a new page on its
|
||||
form.
|
||||
@ -68,8 +65,7 @@
|
||||
given field marks a page beginning on its form.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The function <STRONG>new_page</STRONG> returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>.
|
||||
|
||||
The function <STRONG>set_new_page</STRONG> return one of the following:
|
||||
@ -83,26 +79,22 @@
|
||||
The given field is already connected to a form.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
|
||||
detailed descriptions of the entry points.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,14 +46,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>set_form_opts</STRONG>, <STRONG>form_opts_on</STRONG>, <STRONG>form_opts_off</STRONG>, <STRONG>form_opts</STRONG> -
|
||||
set and get form options
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
int set_form_opts(FORM *form, Field_Options opts);
|
||||
int form_opts_on(FORM *form, Field_Options opts);
|
||||
@ -61,8 +59,7 @@
|
||||
Field_Options form_opts(const FORM *form);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>set_form_opts</STRONG> sets all the given form's
|
||||
option bits (form option bits may be logically-OR'ed
|
||||
together).
|
||||
@ -89,8 +86,7 @@
|
||||
the previous field.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Except for <STRONG>form_opts</STRONG>, each routine returns one of the fol-
|
||||
lowing:
|
||||
|
||||
@ -100,25 +96,21 @@
|
||||
System error occurred (see <STRONG>errno</STRONG>).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,13 +46,11 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>form_page</STRONG> - set and get form page number
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
int set_current_field(FORM *form, FIELD *field);
|
||||
FIELD *current_field(const FORM *);
|
||||
@ -61,8 +59,7 @@
|
||||
int field_index(const FIELD *field);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>set_current</STRONG> <STRONG>field</STRONG> sets the current field of
|
||||
the given form; <STRONG>current_field</STRONG> returns the current field of
|
||||
the given form.
|
||||
@ -79,8 +76,7 @@
|
||||
not connected.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Except for <STRONG>form_page</STRONG>, each routine returns one of the fol-
|
||||
lowing:
|
||||
|
||||
@ -104,25 +100,21 @@
|
||||
System error occurred (see <STRONG>errno</STRONG>).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,21 +46,18 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>post_form</STRONG>, <STRONG>unpost_form</STRONG> - write or erase forms from associ-
|
||||
ated subwindows
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
int post_form(FORM *form);
|
||||
int unpost_form(FORM *form);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>post_form</STRONG> displays a form to its associated
|
||||
subwindow. To trigger physical display of the subwindow,
|
||||
use <STRONG>refresh</STRONG> or some equivalent <STRONG>curses</STRONG> routine (the
|
||||
@ -71,8 +68,7 @@
|
||||
subwindow.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
These routines return one of the following:
|
||||
|
||||
<STRONG>E_OK</STRONG> The routine succeeded.
|
||||
@ -101,25 +97,21 @@
|
||||
System error occurred (see <STRONG>errno</STRONG>).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,21 +46,18 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>form_request_by_name</STRONG>, <STRONG>form_request_name</STRONG> - handle printable
|
||||
form request names
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
const char *form_request_name(int request);
|
||||
int form_request_by_name(const char *name);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>form_request_name</STRONG> returns the printable name
|
||||
of a form request code.
|
||||
The function <STRONG>form_request_by_name</STRONG> searches in the name-ta-
|
||||
@ -68,35 +65,30 @@
|
||||
request code. Otherwise E_NO_MATCH is returned.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
<STRONG>form_request_name</STRONG> returns <STRONG>NULL</STRONG> on error and sets errno to
|
||||
<STRONG>E_BAD_ARGUMENT</STRONG>.
|
||||
<STRONG>form_request_by_name</STRONG> returns <STRONG>E_NO_MATCH</STRONG> on error. It does
|
||||
not set errno.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines are specific to ncurses. They were not
|
||||
supported on Version 7, BSD or System V implementations.
|
||||
It is recommended that any code depending on them be con-
|
||||
ditioned using NCURSES_VERSION.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,48 +46,41 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>set_form_userptr</STRONG>, <STRONG>form_userptr</STRONG> - associate application
|
||||
data with a form item
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
int set_form_userptr(FORM *form, void *userptr);
|
||||
void* form_userptr(const FORM *form);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
Every form and every form item has a field that can be
|
||||
used to hold application-specific data (that is, the form-
|
||||
driver code leaves it alone). These functions get and set
|
||||
the form user pointer field.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The function <STRONG>form_userptr</STRONG> returns a pointer (which may be
|
||||
<STRONG>NULL</STRONG>). It does not set errno.
|
||||
|
||||
The function <STRONG>set_form_userptr</STRONG> returns <STRONG>E_OK</STRONG> (success).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
@ -95,8 +88,7 @@
|
||||
it as a char pointer for SVr4 compatibility.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -45,15 +45,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>TYPE_ALNUM</STRONG>, <STRONG>TYPE_ALPHA</STRONG>, <STRONG>TYPE_ENUM</STRONG>, <STRONG>TYPE_INTEGER</STRONG>,
|
||||
<STRONG>TYPE_IPV4</STRONG>, <STRONG>TYPE_NUMERIC</STRONG>, <STRONG>TYPE_REGEXP</STRONG> - form system global
|
||||
variables
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
|
||||
<STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_ALNUM;</STRONG>
|
||||
@ -65,58 +63,48 @@
|
||||
<STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_REGEXP;</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
These are building blocks for the form library, defining
|
||||
fields that can be created using <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>. Each
|
||||
provides functions for field- and character-validation,
|
||||
according to the given datatype.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-TYPE_ALNUM">TYPE_ALNUM</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-TYPE_ALNUM">TYPE_ALNUM</a></H3><PRE>
|
||||
This holds alphanumeric data.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-TYPE_ALPHA">TYPE_ALPHA</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-TYPE_ALPHA">TYPE_ALPHA</a></H3><PRE>
|
||||
This holds alphabetic data.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-TYPE_ENUM">TYPE_ENUM</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-TYPE_ENUM">TYPE_ENUM</a></H3><PRE>
|
||||
This holds an enumerated type.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-TYPE_INTEGER">TYPE_INTEGER</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-TYPE_INTEGER">TYPE_INTEGER</a></H3><PRE>
|
||||
This holds a decimal integer.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-TYPE_IPV4">TYPE_IPV4</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-TYPE_IPV4">TYPE_IPV4</a></H3><PRE>
|
||||
This holds an IPv4 internet address, e.g., "127.0.0.1".
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-TYPE_NUMERIC">TYPE_NUMERIC</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-TYPE_NUMERIC">TYPE_NUMERIC</a></H3><PRE>
|
||||
This holds a decimal number, with optional sign and deci-
|
||||
mal point.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-TYPE_REGEXP">TYPE_REGEXP</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-TYPE_REGEXP">TYPE_REGEXP</a></H3><PRE>
|
||||
This holds a regular expression.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
The <STRONG>TYPE_IPV4</STRONG> variable is an extension not provided by
|
||||
older implementations of the form library.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
|
||||
|
||||
|
||||
|
||||
@ -46,14 +46,12 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>form_win</STRONG> - make and break form window and subwindow asso-
|
||||
ciations
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
||||
int set_form_win(FORM *form, WINDOW *win);
|
||||
WINDOW *form_win(const FORM *form);
|
||||
@ -62,8 +60,7 @@
|
||||
int scale_form(const FORM *form, int *rows, int *columns);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
Every form has an associated pair of <STRONG>curses</STRONG> windows. The
|
||||
form window displays any title and border associated with
|
||||
the window; the form subwindow displays the items of the
|
||||
@ -82,8 +79,7 @@
|
||||
for the subwindow of <EM>form</EM>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Routines that return pointers return <STRONG>NULL</STRONG> on error. Rou-
|
||||
tines that return an integer return one of the following
|
||||
error codes:
|
||||
@ -104,25 +100,21 @@
|
||||
No items are connected to the form.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><form.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V forms library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
@ -46,21 +46,18 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>infocmp</STRONG> - compare or print out <EM>terminfo</EM> descriptions
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>infocmp</STRONG> [<STRONG>-1CDEFGIKLTUVcdegilnpqrtux</STRONG>]
|
||||
[<STRONG>-v</STRONG> <EM>n</EM>] [<STRONG>-s</STRONG> <STRONG>d</STRONG>| <STRONG>i</STRONG>| <STRONG>l</STRONG>| <STRONG>c</STRONG>] [<STRONG>-Q</STRONG> <EM>n</EM>] [<STRONG>-R</STRONG> <STRONG>subset</STRONG>]
|
||||
[<STRONG>-w</STRONG> <EM>width</EM>] [<STRONG>-A</STRONG> <EM>directory</EM>] [<STRONG>-B</STRONG> <EM>directory</EM>]
|
||||
[<EM>termname</EM>...]
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
<STRONG>infocmp</STRONG> can be used to compare a binary <STRONG>terminfo</STRONG> entry
|
||||
with other terminfo entries, rewrite a <STRONG>terminfo</STRONG> descrip-
|
||||
tion to take advantage of the <STRONG>use=</STRONG> terminfo field, or
|
||||
@ -70,15 +67,13 @@
|
||||
fields, followed by the string fields.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Default-Options">Default Options</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Default-Options">Default Options</a></H3><PRE>
|
||||
If no options are specified and zero or one <EM>termnames</EM> are
|
||||
specified, the <STRONG>-I</STRONG> option will be assumed. If more than
|
||||
one <EM>termname</EM> is specified, the <STRONG>-d</STRONG> option will be assumed.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Comparison-Options-_-d_-_-c_-_-n_">Comparison Options [-d] [-c] [-n]</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Comparison-Options-_-d_-_-c_-_-n_">Comparison Options [-d] [-c] [-n]</a></H3><PRE>
|
||||
<STRONG>infocmp</STRONG> compares the <STRONG>terminfo</STRONG> description of the first
|
||||
terminal <EM>termname</EM> with each of the descriptions given by
|
||||
the entries for the other terminal's <EM>termnames</EM>. If a
|
||||
@ -104,8 +99,7 @@
|
||||
anything was left out of a description.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Source-Listing-Options-_-I_-_-L_-_-C_-_-r_">Source Listing Options [-I] [-L] [-C] [-r]</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Source-Listing-Options-_-I_-_-L_-_-C_-_-r_">Source Listing Options [-I] [-L] [-C] [-r]</a></H3><PRE>
|
||||
The <STRONG>-I</STRONG>, <STRONG>-L</STRONG>, and <STRONG>-C</STRONG> options will produce a source listing
|
||||
for each terminal named.
|
||||
|
||||
@ -175,8 +169,7 @@
|
||||
<STRONG>%p2</STRONG> is printed before <STRONG>%p1</STRONG> <STRONG>%r</STRONG> hp
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Use_-Option-_-u_">Use= Option [-u]</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Use_-Option-_-u_">Use= Option [-u]</a></H3><PRE>
|
||||
The <STRONG>-u</STRONG> option produces a <STRONG>terminfo</STRONG> source description of
|
||||
the first terminal <EM>termname</EM> which is relative to the sum
|
||||
of the descriptions given by the entries for the other
|
||||
@ -245,8 +238,7 @@
|
||||
ated by different people.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Other-Options">Other Options</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Other-Options">Other Options</a></H3><PRE>
|
||||
<STRONG>-0</STRONG> causes the fields to be printed on one line, without
|
||||
wrapping.
|
||||
|
||||
@ -457,14 +449,12 @@
|
||||
can be loaded using the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-FILES">FILES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
|
||||
/usr/share/terminfo Compiled terminal description data-
|
||||
base.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
|
||||
The <STRONG>-0</STRONG>, <STRONG>-1</STRONG>, <STRONG>-E</STRONG>, <STRONG>-F</STRONG>, <STRONG>-G</STRONG>, <STRONG>-R</STRONG>, <STRONG>-T</STRONG>, <STRONG>-V</STRONG>, <STRONG>-a</STRONG>, <STRONG>-e</STRONG>, <STRONG>-f</STRONG>, <STRONG>-g</STRONG>, <STRONG>-i</STRONG>,
|
||||
<STRONG>-l</STRONG>, <STRONG>-p</STRONG>, <STRONG>-q</STRONG> and <STRONG>-t</STRONG> options are not supported in SVr4
|
||||
curses.
|
||||
@ -475,23 +465,20 @@
|
||||
<STRONG>-RBSD</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-BUGS">BUGS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-BUGS">BUGS</a></H2><PRE>
|
||||
The <STRONG>-F</STRONG> option of <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG> should be a <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG> mode.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>, <STRONG><A HREF="infotocap.1m.html">infotocap(1m)</A></STRONG>, <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>,
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
|
||||
|
||||
http://invisible-island.net/ncurses/tctest.html
|
||||
|
||||
This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20151205).
|
||||
This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20160130).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
Eric S. Raymond <esr@snark.thyrsus.com> and
|
||||
Thomas E. Dickey <dickey@invisible-island.net>
|
||||
|
||||
|
||||
@ -46,19 +46,16 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>infotocap</STRONG> - convert a <EM>terminfo</EM> description into a <EM>termcap</EM>
|
||||
description
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>infotocap</STRONG> [<STRONG>-v</STRONG><EM>n</EM> <EM>width</EM>] [<STRONG>-V</STRONG>] [<STRONG>-1</STRONG>] [<STRONG>-w</STRONG> <EM>width</EM>] <EM>file</EM> . . .
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
<STRONG>infotocap</STRONG> looks in each given text <EM>file</EM> for <STRONG>terminfo</STRONG>
|
||||
descriptions. For each terminfo description found, an
|
||||
equivalent <STRONG>termcap</STRONG> description is written to standard out-
|
||||
@ -78,27 +75,23 @@
|
||||
<STRONG>-w</STRONG> change the output to <EM>width</EM> characters.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-FILES">FILES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
|
||||
/usr/share/terminfo Compiled terminal description data-
|
||||
base.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
This utility is actually a link to <EM>tic</EM>, running in <EM>-C</EM>
|
||||
mode. You can use other <EM>tic</EM> options such as <STRONG>-f</STRONG> and <STRONG>-x</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
|
||||
|
||||
This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20151205).
|
||||
This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20160130).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
Eric S. Raymond <esr@snark.thyrsus.com> and
|
||||
Thomas E. Dickey <dickey@invisible-island.net>
|
||||
|
||||
|
||||
@ -46,48 +46,41 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>key_defined</STRONG> - check if a keycode is defined
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>key_defined(const</STRONG> <STRONG>char</STRONG> <STRONG>*definition);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
This is an extension to the curses library. It permits an
|
||||
application to determine if a string is currently bound to
|
||||
any keycode.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
If the string is bound to a keycode, its value (greater
|
||||
than zero) is returned. If no keycode is bound, zero is
|
||||
returned. If the string conflicts with longer strings
|
||||
which are bound to keys, -1 is returned.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines are specific to ncurses. They were not
|
||||
supported on Version 7, BSD or System V implementations.
|
||||
It is recommended that any code depending on them be con-
|
||||
ditioned using NCURSES_VERSION.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
Thomas Dickey.
|
||||
|
||||
|
||||
|
||||
@ -46,27 +46,23 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>keybound</STRONG> - return definition of keycode
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>keybound(int</STRONG> <STRONG>keycode,</STRONG> <STRONG>int</STRONG> <STRONG>count);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
This is an extension to the curses library. It permits an
|
||||
application to determine the string which is defined in
|
||||
the terminfo for specific keycodes.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The <EM>keycode</EM> parameter must be greater than zero, else NULL
|
||||
is returned. If it does not correspond to a defined key,
|
||||
then NULL is returned. The <EM>count</EM> parameter is used to
|
||||
@ -75,21 +71,18 @@
|
||||
returns a string which must be freed by the caller.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines are specific to ncurses. They were not
|
||||
supported on Version 7, BSD or System V implementations.
|
||||
It is recommended that any code depending on them be con-
|
||||
ditioned using NCURSES_VERSION.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>, <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
Thomas Dickey.
|
||||
|
||||
|
||||
|
||||
@ -46,28 +46,24 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>keyok</STRONG> - enable or disable a keycode
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>keyok(int</STRONG> <STRONG>keycode,</STRONG> <STRONG>bool</STRONG> <STRONG>enable);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
This is an extension to the curses library. It permits an
|
||||
application to disable specific keycodes, rather than use
|
||||
the <EM>keypad</EM> function to disable all keycodes. Keys that
|
||||
have been disabled can be re-enabled.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
The keycode must be greater than zero, else ERR is
|
||||
returned. If it does not correspond to a defined key,
|
||||
then ERR is returned. If the <EM>enable</EM> parameter is true,
|
||||
@ -75,21 +71,18 @@
|
||||
Otherwise, the function returns OK.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines are specific to ncurses. They were not
|
||||
supported on Version 7, BSD or System V implementations.
|
||||
It is recommended that any code depending on them be con-
|
||||
ditioned using NCURSES_VERSION.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
Thomas Dickey.
|
||||
|
||||
|
||||
|
||||
@ -46,20 +46,17 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>use_legacy_coding</STRONG> - use terminal's default colors
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
||||
|
||||
<STRONG>int</STRONG> <STRONG>use_legacy_coding(int</STRONG> <STRONG>level);</STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <EM>use</EM><STRONG>_</STRONG><EM>legacy</EM><STRONG>_</STRONG><EM>coding()</EM> function is an extension to the
|
||||
curses library. It allows the caller to change the result
|
||||
of <STRONG>unctrl</STRONG>, and suppress related checks within the library
|
||||
@ -81,28 +78,24 @@
|
||||
is.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
If the screen has not been initialized, or the <EM>level</EM>
|
||||
parameter is out of range, the function returns <STRONG>ERR</STRONG>. Oth-
|
||||
erwise, it returns the previous level: <STRONG>0</STRONG>, <STRONG>1</STRONG> or <STRONG>2</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
This routine is specific to ncurses. It was not supported
|
||||
on Version 7, BSD or System V implementations. It is rec-
|
||||
ommended that any code depending on ncurses extensions be
|
||||
conditioned using NCURSES_VERSION.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG>unctrl</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
||||
Thomas Dickey (to support lynx's font-switching feature).
|
||||
|
||||
|
||||
|
||||
@ -46,18 +46,15 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>menu</STRONG> - curses extension for programming menus
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The <STRONG>menu</STRONG> library provides terminal-independent facilities
|
||||
for composing menu systems on character-cell terminals.
|
||||
The library includes: item routines, which create and mod-
|
||||
@ -71,8 +68,7 @@
|
||||
library, link with the options <STRONG>-lmenu</STRONG> <STRONG>-lcurses</STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Current-Default-Values-for-Item-Attributes">Current Default Values for Item Attributes</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Current-Default-Values-for-Item-Attributes">Current Default Values for Item Attributes</a></H3><PRE>
|
||||
The <STRONG>menu</STRONG> library maintains a default value for item
|
||||
attributes. You can get or set this default by calling
|
||||
the appropriate <STRONG>get_</STRONG> or <STRONG>set_</STRONG> routine with a <STRONG>NULL</STRONG> item
|
||||
@ -81,8 +77,7 @@
|
||||
rendering of items already created.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H3><a name="h3-Routine-Name-Index">Routine Name Index</a></H3><PRE>
|
||||
</PRE><H3><a name="h3-Routine-Name-Index">Routine Name Index</a></H3><PRE>
|
||||
The following table lists each <STRONG>menu</STRONG> routine and the name
|
||||
of the manual page on which it is described.
|
||||
|
||||
@ -155,8 +150,7 @@
|
||||
unpost_menu <STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG>
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
Routines that return pointers return <STRONG>NULL</STRONG> on error. Rou-
|
||||
tines that return an integer return one of the following
|
||||
error codes:
|
||||
@ -199,8 +193,7 @@
|
||||
The menu driver code saw an unknown request code.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><menu.h></STRONG> automatically includes the header
|
||||
files <STRONG><curses.h></STRONG> and <STRONG><eti.h></STRONG>.
|
||||
|
||||
@ -210,24 +203,21 @@
|
||||
error).
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V menu library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for ncurses
|
||||
by Eric S. Raymond.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "menu_" for
|
||||
detailed descriptions of the entry points.
|
||||
|
||||
This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20151205).
|
||||
This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20160130).
|
||||
|
||||
|
||||
|
||||
|
||||
@ -46,15 +46,13 @@
|
||||
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
||||
<STRONG>menu_back</STRONG>, <STRONG>menu_fore</STRONG>, <STRONG>menu_grey</STRONG>, <STRONG>menu_pad</STRONG>, <STRONG>set_menu_back</STRONG>,
|
||||
<STRONG>set_menu_fore</STRONG>, <STRONG>set_menu_grey</STRONG>, <STRONG>set_menu_pad</STRONG> - color and
|
||||
attribute control for menus
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
||||
<STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
|
||||
int set_menu_fore(MENU *menu, chtype attr);
|
||||
chtype menu_fore(const MENU *menu);
|
||||
@ -66,8 +64,7 @@
|
||||
int menu_pad(const MENU *menu);
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
||||
The function <STRONG>set_menu_fore</STRONG> sets the foreground attribute
|
||||
of <EM>menu</EM>. This is the highlight used for selected menu
|
||||
items. <STRONG>menu_fore</STRONG> returns the foreground attribute. The
|
||||
@ -91,8 +88,7 @@
|
||||
The default is a blank.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
||||
These routines return one of the following:
|
||||
|
||||
<STRONG>E_OK</STRONG> The routine succeeded.
|
||||
@ -105,26 +101,22 @@
|
||||
ment.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
||||
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "menu_" for
|
||||
detailed descriptions of the entry points.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
||||
The header file <STRONG><menu.h></STRONG> automatically includes the header
|
||||
file <STRONG><curses.h></STRONG>.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
||||
These routines emulate the System V menu library. They
|
||||
were not supported on Version 7 or BSD versions.
|
||||
|
||||
|
||||
</PRE>
|
||||
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
|
||||
Juergen Pfeifer. Manual pages and adaptation for new
|
||||
curses by Eric S. Raymond.
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user