+ regenerated html manpages.
+ minor fixes for symlinks to curs_legacy.3x and curs_slk.3x manpages.
+ add manpage for sp-funcs.
+ add sp-funcs to test/listused.sh, for documentation aids.
./doc/html/man/curs_scr_dump.3x.html
./doc/html/man/curs_scroll.3x.html
./doc/html/man/curs_slk.3x.html
+./doc/html/man/curs_sp_funcs.3x.html
./doc/html/man/curs_termattrs.3x.html
./doc/html/man/curs_termcap.3x.html
./doc/html/man/curs_terminfo.3x.html
./doc/html/man/curs_touch.3x.html
./doc/html/man/curs_trace.3x.html
./doc/html/man/curs_util.3x.html
+./doc/html/man/curs_variables.3x.html
./doc/html/man/curs_window.3x.html
./doc/html/man/default_colors.3x.html
./doc/html/man/define_key.3x.html
./doc/html/man/form_post.3x.html
./doc/html/man/form_requestname.3x.html
./doc/html/man/form_userptr.3x.html
+./doc/html/man/form_variables.3x.html
./doc/html/man/form_win.3x.html
./doc/html/man/index.html
./doc/html/man/infocmp.1m.html
./doc/html/man/tabs.1.html
./doc/html/man/term.5.html
./doc/html/man/term.7.html
+./doc/html/man/term_variables.3x.html
./doc/html/man/terminfo.5.html
./doc/html/man/tic.1m.html
./doc/html/man/toe.1m.html
./man/curs_scr_dump.3x
./man/curs_scroll.3x
./man/curs_slk.3x
+./man/curs_sp_funcs.3x
./man/curs_termattrs.3x
./man/curs_termcap.3x
./man/curs_terminfo.3x
-- sale, use or other dealings in this Software without prior written --
-- authorization. --
-------------------------------------------------------------------------------
--- $Id: NEWS,v 1.1590 2010/09/11 21:41:14 tom Exp $
+-- $Id: NEWS,v 1.1593 2010/09/18 22:53:08 tom Exp $
-------------------------------------------------------------------------------
This is a log of changes that ncurses has gone through since Zeyd started
Changes through 1.9.9e did not credit all contributions;
it is not possible to add this information.
+20100918
+ + regenerated html manpages.
+ + minor fixes for symlinks to curs_legacy.3x and curs_slk.3x manpages.
+ + add manpage for sp-funcs.
+ + add sp-funcs to test/listused.sh, for documentation aids.
+
20100911
+ add manpages for summarizing public variables of curses-, terminfo-
and form-libraries.
# use or other dealings in this Software without prior written #
# authorization. #
##############################################################################
-# $Id: dist.mk,v 1.773 2010/09/11 14:06:59 tom Exp $
+# $Id: dist.mk,v 1.774 2010/09/18 14:51:01 tom Exp $
# Makefile for creating ncurses distributions.
#
# This only needs to be used directly as a makefile by developers, but
# These define the major/minor/patch versions of ncurses.
NCURSES_MAJOR = 5
NCURSES_MINOR = 7
-NCURSES_PATCH = 20100911
+NCURSES_PATCH = 20100918
# We don't append the patch to the version, since this only applies to releases
VERSION = $(NCURSES_MAJOR).$(NCURSES_MINOR)
<H2>SEE ALSO</H2><PRE>
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
- This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100731).
+ This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100918).
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: captoinfo.1m,v 1.23 2010/07/31 16:12:01 tom Exp @
+ * @Id: captoinfo.1m,v 1.24 2010/08/28 19:36:31 tom Exp @
-->
<HTML>
<HEAD>
</PRE>
<H2>DESCRIPTION</H2><PRE>
- <STRONG>captoinfo</STRONG> looks in <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> capabilities are
- translated directly to terminfo <STRONG>use</STRONG> capabilities.
+ <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>
+ capabilities are translated directly to terminfo <STRONG>use</STRONG> capa-
+ bilities.
If no <EM>file</EM> is given, then the environment variable <STRONG>TERMCAP</STRONG>
- is used for the filename or entry. If <STRONG>TERMCAP</STRONG> is a full
+ is used for the filename or entry. If <STRONG>TERMCAP</STRONG> is a full
pathname to a file, only the terminal whose name is speci-
- fied in the environment variable <STRONG>TERM</STRONG> is extracted from
- that file. If the environment variable <STRONG>TERMCAP</STRONG> is not
+ fied in the environment variable <STRONG>TERM</STRONG> is extracted from
+ that file. If the environment variable <STRONG>TERMCAP</STRONG> is not
set, then the file <STRONG>/usr/share/terminfo</STRONG> is read.
- <STRONG>-v</STRONG> print out tracing information on standard error as
+ <STRONG>-v</STRONG> print out tracing information on standard error as
the program runs.
- <STRONG>-V</STRONG> print out the version of the program in use on stan-
+ <STRONG>-V</STRONG> print out the version of the program in use on stan-
dard error and exit.
- <STRONG>-1</STRONG> cause the fields to print out one to a line. Other-
+ <STRONG>-1</STRONG> cause the fields to print out one to a line. Other-
wise, the fields will be printed several to a line to
a maximum width of 60 characters.
</PRE>
<H2>TRANSLATIONS FROM NONSTANDARD CAPABILITIES</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-
- matic translations is done, the program will issue an
+ Some obsolete nonstandard capabilities will automatically
+ be translated into standard (SVr4/XSI Curses) terminfo
+ capabilities by <STRONG>captoinfo</STRONG>. Whenever one of these auto-
+ matic translations is done, the program will issue an
notification to stderr, inviting the user to check that it
- has not mistakenly translated a completely unknown and
+ has not mistakenly translated a completely unknown and
random capability and/or syntax error.
Nonstd Std From Terminfo
GE ae XENIX exit_alt_charset_mode
GS as XENIX enter_alt_charset_mode
HM kh XENIX key_home
- LD kL XENIX key_dl
+ LD kL XENIX key_dl
PD kN XENIX key_npage
PN po XENIX prtr_off
PS pf XENIX prtr_on
FC Sf Tek set_foreground
HS mh Iris enter_dim_mode
- XENIX termcap also used to have a set of extension capa-
- bilities for forms drawing, designed to take advantage of
+ XENIX termcap also used to have a set of extension capa-
+ bilities for forms drawing, designed to take advantage of
the IBM PC high-half graphics. They were as follows:
Cap Graphic
Gc intersection
GG acs magic cookie count
- If the single-line capabilities occur in an entry, they
- will automatically be composed into an <EM>acsc</EM> string. The
+ If the single-line capabilities occur in an entry, they
+ will automatically be composed into an <EM>acsc</EM> string. The
double-line capabilities and <STRONG>GG</STRONG> are discarded with a warn-
ing message.
IBM's AIX has a terminfo facility descended from SVr1 ter-
- minfo but incompatible with the SVr4 format. The following
- AIX extensions are automatically translated:
+ minfo but incompatible with the SVr4 format. The follow-
+ ing AIX extensions are automatically translated:
IBM XSI
-------------
font2 s2ds
font3 s3ds
- Additionally, the AIX <EM>box1</EM> capability will be automati-
+ Additionally, the AIX <EM>box1</EM> capability will be automati-
cally translated to an <EM>acsc</EM> string.
- Hewlett-Packard's terminfo library supports two nonstan-
- dard terminfo capabilities <EM>meml</EM> (memory lock) and <EM>memu</EM>
- (memory unlock). These will be discarded with a warning
+ Hewlett-Packard's terminfo library supports two nonstan-
+ dard terminfo capabilities <EM>meml</EM> (memory lock) and <EM>memu</EM>
+ (memory unlock). These will be discarded with a warning
message.
</PRE>
<H2>NOTES</H2><PRE>
- This utility is actually a link to <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, running in <EM>-I</EM>
+ 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>.
- The trace option is not identical to SVr4's. Under SVr4,
- instead of following the <STRONG>-v</STRONG> with a trace level n, you
+ The trace option is not identical to SVr4's. Under SVr4,
+ instead of following the <STRONG>-v</STRONG> with a trace level n, you
repeat it n times.
<H2>SEE ALSO</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 5.7 (patch 20100731).
+ This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100918).
</PRE>
<H2>AUTHOR</H2><PRE>
- Eric S. Raymond <esr@snark.thyrsus.com>
+ Eric S. Raymond <esr@snark.thyrsus.com> and
+ Thomas E. Dickey <dickey@invisible-island.net>
<H2>SEE ALSO</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 5.7 (patch 20100731).
+ This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100918).
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_add_wch.3x,v 1.7 2010/07/31 16:12:01 tom Exp @
+ * @Id: curs_add_wch.3x,v 1.9 2010/09/18 20:18:34 tom Exp @
-->
<HTML>
<HEAD>
perform wrapping and special-character processing as fol-
lows:
- - If <EM>wch</EM> refers to a spacing character, then any previ-
- ous character at that location is removed. A new
- character specified by <EM>wch</EM> is placed at that location
- with rendition specified by <EM>wch</EM>. The cursor then
- advances to the next spacing character on the screen.
+ <STRONG>o</STRONG> If <EM>wch</EM> refers to a spacing character, then any previ-
+ ous character at that location is removed. A new
+ character specified by <EM>wch</EM> is placed at that location
+ with rendition specified by <EM>wch</EM>. The cursor then
+ advances to the next spacing character on the screen.
- - If <EM>wch</EM> refers to a non-spacing character, all previ-
- ous characters at that location are preserved. The
- non-spacing characters of <EM>wch</EM> are added to the spac-
- ing complex character, and the rendition specified by
- <EM>wch</EM> is ignored.
+ <STRONG>o</STRONG> If <EM>wch</EM> refers to a non-spacing character, all previous
+ characters at that location are preserved. The non-
+ spacing characters of <EM>wch</EM> are added to the spacing
+ complex character, and the rendition specified by <EM>wch</EM>
+ is ignored.
- - If the character part of <EM>wch</EM> is a tab, newline,
- backspace or other control character, the window is
- updated and the cursor moves as if <STRONG>addch</STRONG> were called.
+ <STRONG>o</STRONG> If the character part of <EM>wch</EM> is a tab, newline,
+ backspace or other control character, the window is
+ updated and the cursor moves as if <STRONG>addch</STRONG> were called.
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,
All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on
success.
+ 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>NOTES</H2><PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_add_wchstr.3x,v 1.7 2010/07/31 16:12:01 tom Exp @
+ * @Id: curs_add_wchstr.3x,v 1.8 2010/08/14 23:29:16 tom Exp @
-->
<HTML>
<HEAD>
All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on
success.
+ 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>PORTABILITY</H2><PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_addch.3x,v 1.28 2010/07/31 16:12:01 tom Exp @
+ * @Id: curs_addch.3x,v 1.29 2010/08/14 23:29:16 tom Exp @
-->
<HTML>
<HEAD>
other than <STRONG>ERR</STRONG>") upon successful completion, unless other-
wise noted in the preceding routine descriptions.
+ 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>NOTES</H2><PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_addchstr.3x,v 1.13 2010/07/31 16:12:01 tom Exp @
+ * @Id: curs_addchstr.3x,v 1.14 2010/08/14 23:29:16 tom Exp @
-->
<HTML>
<HEAD>
X/Open does not define any error conditions. This imple-
mentation returns an error if the window pointer is null.
+ 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>NOTES</H2><PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_addstr.3x,v 1.14 2010/07/31 16:12:01 tom Exp @
+ * @Id: curs_addstr.3x,v 1.15 2010/08/14 23:29:16 tom Exp @
-->
<HTML>
<HEAD>
or if the string pointer is null or if the corresponding
calls to <STRONG>waddch</STRONG> return an error.
+ 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>NOTES</H2><PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_addwstr.3x,v 1.8 2010/07/31 16:12:01 tom Exp @
+ * @Id: curs_addwstr.3x,v 1.9 2010/08/14 23:29:16 tom Exp @
-->
<HTML>
<HEAD>
All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on
success.
+ 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>NOTES</H2><PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_attr.3x,v 1.33 2010/07/31 16:12:01 tom Exp @
+ * @Id: curs_attr.3x,v 1.34 2010/08/14 23:30:02 tom Exp @
-->
<HTML>
<HEAD>
OR_PAIRS-1. This implementation also provides <STRONG>getattrs</STRONG>
for compatibility with older versions of curses.
+ 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>SEE ALSO</H2><PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_border.3x,v 1.20 2010/07/31 16:12:01 tom Exp @
+ * @Id: curs_border.3x,v 1.21 2010/08/14 23:29:16 tom Exp @
-->
<HTML>
<HEAD>
X/Open does not define any error conditions. This imple-
mentation returns an error if the window pointer is null.
+ 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>NOTES</H2><PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_border_set.3x,v 1.7 2010/07/31 16:12:01 tom Exp @
+ * @Id: curs_border_set.3x,v 1.8 2010/08/14 23:29:16 tom Exp @
-->
<HTML>
<HEAD>
Functions using a window parameter return an error if it
is null.
+ 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>SEE ALSO</H2><PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_color.3x,v 1.30 2010/07/31 16:12:01 tom Exp @
+ * @Id: curs_color.3x,v 1.32 2010/09/18 20:27:38 tom Exp @
-->
<HTML>
<HEAD>
</PRE>
<H2>SYNOPSIS</H2><PRE>
<STRONG>#</STRONG> <STRONG>include</STRONG> <STRONG><curses.h></STRONG>
+
<STRONG>int</STRONG> <STRONG>start_color(void);</STRONG>
<STRONG>int</STRONG> <STRONG>init_pair(short</STRONG> <STRONG>pair,</STRONG> <STRONG>short</STRONG> <STRONG>f,</STRONG> <STRONG>short</STRONG> <STRONG>b);</STRONG>
<STRONG>int</STRONG> <STRONG>init_color(short</STRONG> <STRONG>color,</STRONG> <STRONG>short</STRONG> <STRONG>r,</STRONG> <STRONG>short</STRONG> <STRONG>g,</STRONG> <STRONG>short</STRONG> <STRONG>b);</STRONG>
pair to be changed, the foreground color number, and the
background color number. For portable applications:
- - The value of the first argument must be between <STRONG>1</STRONG> and
- <STRONG>COLOR_PAIRS-1</STRONG>, except that if default colors are used
- (see <STRONG>use_default_colors</STRONG>) the upper limit is adjusted
- to allow for extra pairs which use a default color in
- foreground and/or background.
+ <STRONG>o</STRONG> The value of the first argument must be between <STRONG>1</STRONG> and
+ <STRONG>COLOR_PAIRS-1</STRONG>, except that if default colors are used
+ (see <STRONG>use_default_colors</STRONG>) the upper limit is adjusted
+ to allow for extra pairs which use a default color in
+ foreground and/or background.
- - The value of the second and third arguments must be
- between 0 and <STRONG>COLORS</STRONG>. Color pair 0 is assumed to be
- white on black, but is actually whatever the terminal
- implements before color is initialized. It cannot be
- modified by the application.
+ <STRONG>o</STRONG> The value of the second and third arguments must be
+ between 0 and <STRONG>COLORS</STRONG>. Color pair 0 is assumed to be
+ white on black, but is actually whatever the terminal
+ implements before color is initialized. It cannot be
+ modified by the application.
If the color-pair was previously initialized, the screen
is refreshed and all occurrences of that color-pair are
turned from secondary functions such as <STRONG>init_pair</STRONG> if
<STRONG>start_color</STRONG> was not called.
- <STRONG>init_color</STRONG>
- returns an error if the terminal does not sup-
- port this feature, e.g., if the <EM>initial-</EM>
- <EM>ize</EM><STRONG>_</STRONG><EM>color</EM> capability is absent from the termi-
- nal description.
+ <STRONG>init_color</STRONG>
+ returns an error if the terminal does not support
+ this feature, e.g., if the <EM>initialize</EM><STRONG>_</STRONG><EM>color</EM> capa-
+ bility is absent from the terminal description.
- <STRONG>start_color</STRONG>
- returns an error If the color table cannot be
- allocated.
+ <STRONG>start_color</STRONG>
+ returns an error if the color table cannot be al-
+ located.
</PRE>
<H2>NOTES</H2><PRE>
- In the <EM>ncurses</EM> implementation, there is a separate color
+ 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;
- the <STRONG>start_color</STRONG> function only affects the current screen.
+ sociated COLORS and COLOR_PAIRS counts for each screen;
+ the <STRONG>start_color</STRONG> function only affects the current screen.
The SVr4/XSI interface is not really designed with this in
- mind, and historical implementations may use a single
+ mind, and historical implementations may use a single
shared color palette.
Note that setting an implicit background color via a color
- pair affects only character cells that a character write
- operation explicitly touches. To change the background
- color used when parts of a window are blanked by erasing
+ pair affects only character cells that a character write
+ operation explicitly touches. To change the background
+ color used when parts of a window are blanked by erasing
or scrolling operations, see <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>.
- Several caveats apply on 386 and 486 machines with VGA-
+ Several caveats apply on 386 and 486 machines with VGA-
compatible graphics:
- - COLOR_YELLOW is actually brown. To get yellow, use
- COLOR_YELLOW combined with the <STRONG>A_BOLD</STRONG> attribute.
+ <STRONG>o</STRONG> COLOR_YELLOW is actually brown. To get yellow, use
+ COLOR_YELLOW combined with the <STRONG>A_BOLD</STRONG> attribute.
- - The A_BLINK attribute should in theory cause the
- background to go bright. This often fails to work,
- and even some cards for which it mostly works (such
- as the Paradise and compatibles) do the wrong thing
- when you try to set a bright "yellow" background (you
- get a blinking yellow foreground instead).
+ <STRONG>o</STRONG> The A_BLINK attribute should in theory cause the back-
+ ground to go bright. This often fails to work, and
+ even some cards for which it mostly works (such as the
+ Paradise and compatibles) do the wrong thing when you
+ try to set a bright "yellow" background (you get a
+ blinking yellow foreground instead).
- - Color RGB values are not settable.
+ <STRONG>o</STRONG> Color RGB values are not settable.
</PRE>
<H2>PORTABILITY</H2><PRE>
- This implementation satisfies XSI Curses's minimum maxi-
+ This implementation satisfies XSI Curses's minimum maxi-
mums for <STRONG>COLORS</STRONG> and <STRONG>COLOR_PAIRS</STRONG>.
- The <STRONG>init_pair</STRONG> routine accepts negative values of fore-
- ground and background color to support the <STRONG>use_de-</STRONG>
- <STRONG>fault_colors</STRONG> extension, but only if that routine has been
+ The <STRONG>init_pair</STRONG> routine accepts negative values of fore-
+ ground and background color to support the <STRONG>use_de-</STRONG>
+ <STRONG>fault_colors</STRONG> extension, but only if that routine has been
first invoked.
- The assumption that <STRONG>COLOR_BLACK</STRONG> is the default background
- color for all terminals can be modified using the <STRONG>as-</STRONG>
+ The assumption that <STRONG>COLOR_BLACK</STRONG> is the default background
+ color for all terminals can be modified using the <STRONG>as-</STRONG>
<STRONG>sume_default_colors</STRONG> extension.
- This implementation checks the pointers, e.g., for the
- values returned by <STRONG>color_content</STRONG> and <STRONG>pair_content</STRONG>, and
+ This implementation checks the pointers, e.g., for the
+ values returned by <STRONG>color_content</STRONG> and <STRONG>pair_content</STRONG>, and
will treat those as optional parameters when null.
</PRE>
<H2>SEE ALSO</H2><PRE>
- <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG>default_col-</STRONG>
+ <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>default_col-</STRONG>
<STRONG><A HREF="default_colors.3x.html">ors(3x)</A></STRONG>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_delch.3x,v 1.9 2010/07/31 16:12:01 tom Exp @
+ * @Id: curs_delch.3x,v 1.10 2010/08/14 23:29:16 tom Exp @
-->
<HTML>
<HEAD>
(SVr4 specifies only "an integer value other than <STRONG>ERR</STRONG>")
upon successful completion.
+ 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>NOTES</H2><PRE>
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
****************************************************************************
- * Copyright (c) 2002-2003,2006 Free Software Foundation, Inc. *
+ * Copyright (c) 2002-2006,2010 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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_get_wch.3x,v 1.6 2006/02/25 21:47:06 tom Exp @
+ * @Id: curs_get_wch.3x,v 1.7 2010/08/14 23:31:42 tom Exp @
-->
<HTML>
<HEAD>
</PRE>
<H2>RETURN VALUES</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,
+ 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
- wide character, they return <STRONG>OK</STRONG>. Otherwise, they return
+ wide character, they return <STRONG>OK</STRONG>. Otherwise, they return
<STRONG>ERR</STRONG>.
- Upon successful completion, <STRONG>unget_wch</STRONG> returns <STRONG>OK</STRONG>. Other-
+ Upon successful completion, <STRONG>unget_wch</STRONG> returns <STRONG>OK</STRONG>. Other-
wise, the function returns <STRONG>ERR</STRONG>.
+ 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>SEE ALSO</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="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>
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
****************************************************************************
- * Copyright (c) 2002-2005,2006 Free Software Foundation, Inc. *
+ * Copyright (c) 2002-2006,2010 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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_get_wstr.3x,v 1.6 2006/02/25 21:49:19 tom Exp @
+ * @Id: curs_get_wstr.3x,v 1.7 2010/08/14 23:31:42 tom Exp @
-->
<HTML>
<HEAD>
returns an error if the associated call to
<STRONG>wget_wch</STRONG> failed.
+ 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>PORTABILITY</H2><PRE>
</PRE>
<H2>SEE ALSO</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>.
+ 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>.
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_getcchar.3x,v 1.13 2010/07/31 16:12:01 tom Exp @
+ * @Id: curs_getcchar.3x,v 1.14 2010/09/18 20:26:21 tom Exp @
-->
<HTML>
<HEAD>
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:
- - Extracts information from a <STRONG>cchar_t</STRONG> value <EM>wcval</EM>
+ <STRONG>o</STRONG> Extracts information from a <STRONG>cchar_t</STRONG> value <EM>wcval</EM>
- - Stores the character attributes in the location
- pointed to by <EM>attrs</EM>
+ <STRONG>o</STRONG> Stores the character attributes in the location
+ pointed to by <EM>attrs</EM>
- - Stores the color-pair in the location pointed to by
- <EM>color</EM><STRONG>_</STRONG><EM>pair</EM>
+ <STRONG>o</STRONG> Stores the color-pair in the location pointed to by
+ <EM>color</EM><STRONG>_</STRONG><EM>pair</EM>
- - Stores the wide-character string, characters refer-
- enced by <EM>wcval</EM>, into the array pointed to by <EM>wch</EM>.
+ <STRONG>o</STRONG> Stores the wide-character string, characters refer-
+ enced by <EM>wcval</EM>, into the array pointed to by <EM>wch</EM>.
When <EM>wch</EM> is a null pointer, the <STRONG>getcchar</STRONG> function does the
following:
- - Obtains the number of wide characters pointed to by
- <EM>wcval</EM>
+ <STRONG>o</STRONG> Obtains the number of wide characters pointed to by
+ <EM>wcval</EM>
- - Does not change the data referenced by <EM>attrs</EM> or
- <EM>color</EM><STRONG>_</STRONG><EM>pair</EM>
+ <STRONG>o</STRONG> Does not change the data referenced by <EM>attrs</EM> or
+ <EM>color</EM><STRONG>_</STRONG><EM>pair</EM>
The <STRONG>setcchar</STRONG> function initializes the location pointed to
by <EM>wcval</EM> by using:
- - The character attributes in <EM>attrs</EM>
+ <STRONG>o</STRONG> The character attributes in <EM>attrs</EM>
- - The color pair in <EM>color</EM><STRONG>_</STRONG><EM>pair</EM>
+ <STRONG>o</STRONG> The color pair in <EM>color</EM><STRONG>_</STRONG><EM>pair</EM>
- - The wide-character string pointed to by <EM>wch</EM>. The
- string must be L'\0' terminated, contain at most one
- spacing character, which must be the first.
+ <STRONG>o</STRONG> The wide-character string pointed to by <EM>wch</EM>. The
+ string must be L'\0' terminated, contain at most one
+ spacing character, which must be the first.
- Up to <STRONG>CCHARW_MAX</STRONG>-1 nonspacing characters may follow.
- Additional nonspacing characters are ignored.
+ Up to <STRONG>CCHARW_MAX</STRONG>-1 nonspacing characters may follow.
+ Additional nonspacing characters are ignored.
- The string may contain a single control character
- instead. In that case, no nonspacing characters are
- allowed.
+ The string may contain a single control character
+ instead. In that case, no nonspacing characters are
+ allowed.
</PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_getch.3x,v 1.31 2010/01/30 21:29:04 tom Exp @
+ * @Id: curs_getch.3x,v 1.32 2010/08/14 23:29:16 tom Exp @
-->
<HTML>
<HEAD>
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
+ outside the window, or if the window pointer is null.
+
</PRE>
<H2>NOTES</H2><PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_getstr.3x,v 1.16 2010/07/31 16:12:01 tom Exp @
+ * @Id: curs_getstr.3x,v 1.17 2010/08/14 23:29:16 tom Exp @
-->
<HTML>
<HEAD>
SIGWINCH interrupts the function, it will return <STRONG>KEY_RE-</STRONG>
<STRONG>SIZE</STRONG> rather than <STRONG>OK</STRONG> or <STRONG>ERR</STRONG>.
+ 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>NOTES</H2><PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_in_wch.3x,v 1.3 2010/07/31 16:10:55 tom Exp @
+ * @Id: curs_in_wch.3x,v 1.4 2010/08/14 23:29:16 tom Exp @
-->
<HTML>
<HEAD>
the cursor, returning ERR in that case. Otherwise they
return OK
+ 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>NOTES</H2><PRE>
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
****************************************************************************
- * Copyright (c) 2002-2005,2006 Free Software Foundation, Inc. *
+ * Copyright (c) 2002-2006,2010 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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_in_wchstr.3x,v 1.6 2006/12/02 17:03:07 tom Exp @
+ * @Id: curs_in_wchstr.3x,v 1.7 2010/08/14 23:31:42 tom Exp @
-->
<HTML>
<HEAD>
Upon successful completion, these functions return <STRONG>OK</STRONG>.
Otherwise, they return <STRONG>ERR</STRONG>.
+ 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>PORTABILITY</H2><PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_inch.3x,v 1.14 2010/07/31 16:11:27 tom Exp @
+ * @Id: curs_inch.3x,v 1.16 2010/08/14 23:35:36 tom Exp @
-->
<HTML>
<HEAD>
<STRONG>A_COLOR</STRONG> Bit-mask to extract color-pair field information
+</PRE>
+<H2>RETURN VALUE</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>NOTES</H2><PRE>
Note that all of these routines may be macros.
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_inchstr.3x,v 1.13 2010/07/31 16:08:48 tom Exp @
+ * @Id: curs_inchstr.3x,v 1.14 2010/08/14 23:29:16 tom Exp @
-->
<HTML>
<HEAD>
is null, no data is returned, and the return value is ze-
ro.
+ 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>NOTES</H2><PRE>
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
****************************************************************************
- * Copyright (c) 2002,2006 Free Software Foundation, Inc. *
+ * Copyright (c) 2002-2006,2010 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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_ins_wch.3x,v 1.3 2006/02/25 21:42:22 tom Exp @
+ * @Id: curs_ins_wch.3x,v 1.4 2010/08/14 23:31:42 tom Exp @
-->
<HTML>
<HEAD>
If successful, these functions return OK. If not, they
return ERR.
+ 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>ERRORS</H2><PRE>
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
****************************************************************************
- * Copyright (c) 2002,2005 Free Software Foundation, Inc. *
+ * Copyright (c) 2002-2005,2010 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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_ins_wstr.3x,v 1.4 2005/05/15 17:02:54 tom Exp @
+ * @Id: curs_ins_wstr.3x,v 1.5 2010/08/14 23:31:42 tom Exp @
-->
<HTML>
<HEAD>
Upon successful completion, these functions return OK.
Otherwise, they return ERR.
+ 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>SEE ALSO</H2><PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_insch.3x,v 1.11 2010/07/31 16:11:27 tom Exp @
+ * @Id: curs_insch.3x,v 1.12 2010/08/14 23:29:16 tom Exp @
-->
<HTML>
<HEAD>
than <STRONG>ERR</STRONG>") upon successful completion, unless otherwise
noted in the preceding routine descriptions.
+ 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>NOTES</H2><PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_insstr.3x,v 1.19 2010/07/31 16:11:27 tom Exp @
+ * @Id: curs_insstr.3x,v 1.20 2010/08/14 23:29:16 tom Exp @
-->
<HTML>
<HEAD>
tion, if the window parameter is null or the str parameter
is null, an error is returned.
+ 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>NOTES</H2><PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_instr.3x,v 1.14 2010/07/31 16:11:27 tom Exp @
+ * @Id: curs_instr.3x,v 1.15 2010/08/14 23:29:16 tom Exp @
-->
<HTML>
<HEAD>
tion, if the window parameter is null or the str parameter
is null, a zero is returned.
+ 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>NOTES</H2><PRE>
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
****************************************************************************
- * Copyright (c) 2002-2005,2006 Free Software Foundation, Inc. *
+ * Copyright (c) 2002-2006,2010 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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_inwstr.3x,v 1.5 2006/02/25 21:20:20 tom Exp @
+ * @Id: curs_inwstr.3x,v 1.6 2010/08/14 23:31:42 tom Exp @
-->
<HTML>
<HEAD>
routines return the number of characters read into the
string.
+ 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>SEE ALSO</H2><PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_kernel.3x,v 1.16 2010/07/31 16:11:27 tom Exp @
+ * @Id: curs_kernel.3x,v 1.17 2010/08/14 23:12:36 Tim.van.der.Molen Exp @
-->
<HTML>
<HEAD>
<STRONG>ripoffline</STRONG> can be called up to five times before calling
<STRONG>initscr</STRONG> or <STRONG>newterm</STRONG>.
- The <STRONG>curs_set</STRONG> routine sets the cursor state is set to in-
- visible, 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> requested, the previous <EM>cursor</EM> state is re-
- turned; otherwise, <STRONG>ERR</STRONG> is returned.
+ 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-
+ quested, the previous <EM>cursor</EM> state is returned; otherwise,
+ <STRONG>ERR</STRONG> is returned.
The <STRONG>napms</STRONG> routine is used to sleep for <EM>ms</EM> milliseconds.
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_legacy.3x,v 1.2 2010/07/31 16:11:27 tom Exp @
+ * @Id: curs_legacy.3x,v 1.3 2010/09/11 22:21:52 tom Exp @
-->
<HTML>
<HEAD>
</PRE>
<H2>NAME</H2><PRE>
- <STRONG>getbegx</STRONG>, <STRONG>getbegy</STRONG>, <STRONG>getcurx</STRONG>, <STRONG>getcury</STRONG>, <STRONG>getmaxx</STRONG>, <STRONG>getmaxy</STRONG>, <STRONG>get-</STRONG>
- <STRONG>parx</STRONG>, <STRONG>getpary</STRONG> - get <STRONG>curses</STRONG> cursor and window coordinates
+ get <STRONG>curses</STRONG> cursor and window coordinates, attributes
</PRE>
<H2>SYNOPSIS</H2><PRE>
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
+ <STRONG>int</STRONG> <STRONG>getattrs(WINDOW</STRONG> <STRONG>*win);</STRONG>
<STRONG>int</STRONG> <STRONG>getbegx(WINDOW</STRONG> <STRONG>*win);</STRONG>
<STRONG>int</STRONG> <STRONG>getbegy(WINDOW</STRONG> <STRONG>*win);</STRONG>
<STRONG>int</STRONG> <STRONG>getcurx(WINDOW</STRONG> <STRONG>*win);</STRONG>
</PRE>
<H2>DESCRIPTION</H2><PRE>
- The <STRONG>getbegy</STRONG> and <STRONG>getbegx</STRONG> functions return the same data as
+ The <STRONG>getbegy</STRONG> and <STRONG>getbegx</STRONG> functions return the same data as
<STRONG>getbegyx</STRONG>.
- The <STRONG>getcury</STRONG> and <STRONG>getcurx</STRONG> functions return the same data as
+ The <STRONG>getcury</STRONG> and <STRONG>getcurx</STRONG> functions return the same data as
<STRONG>getyx</STRONG>.
- The <STRONG>getmaxy</STRONG> and <STRONG>getmaxx</STRONG> functions return the same data as
+ The <STRONG>getmaxy</STRONG> and <STRONG>getmaxx</STRONG> functions return the same data as
<STRONG>getmaxyx</STRONG>.
- The <STRONG>getpary</STRONG> and <STRONG>getparx</STRONG> functions return the same data as
+ The <STRONG>getpary</STRONG> and <STRONG>getparx</STRONG> functions return the same data as
<STRONG>getparyx</STRONG>.
</PRE>
<H2>RETURN VALUE</H2><PRE>
- These functions return an integer, or ERR if the window
+ These functions return an integer, or ERR if the window
parameter is null.
</PRE>
<H2>NOTES</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
+ 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
forms such as <STRONG>getyx</STRONG> must be implemented as macros, and (in
this implementation) are defined in terms of the functions
- described here, to avoid reliance on internal details of
+ described here, to avoid reliance on internal details of
the WINDOW structure.
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_printw.3x,v 1.18 2010/07/31 16:10:55 tom Exp @
+ * @Id: curs_printw.3x,v 1.19 2010/08/14 23:29:16 tom Exp @
-->
<HTML>
<HEAD>
enough memory for the buffer used to format the results.
It will return an error if the window pointer is null.
+ 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>PORTABILITY</H2><PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_scanw.3x,v 1.15 2010/07/31 16:10:55 tom Exp @
+ * @Id: curs_scanw.3x,v 1.16 2010/08/14 23:29:16 tom Exp @
-->
<HTML>
<HEAD>
<STRONG>wscanw</STRONG>, <STRONG>mvscanw</STRONG> and <STRONG>mvwscanw</STRONG> routines to determine the
number of fields which were mapped in the call.
+ 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>PORTABILITY</H2><PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_slk.3x,v 1.18 2010/07/31 14:43:29 tom Exp @
+ * @Id: curs_slk.3x,v 1.19 2010/09/11 22:35:11 tom Exp @
-->
<HTML>
<HEAD>
</PRE>
<H2>NAME</H2><PRE>
- <STRONG>slk_init</STRONG>, <STRONG>slk_set</STRONG>, <STRONG>slk_refresh</STRONG>, <STRONG>slk_noutrefresh</STRONG>,
+ <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>,
<STRONG>slk_attr_off</STRONG>, <STRONG>slk_attr</STRONG>, <STRONG>slk_color</STRONG> - <STRONG>curses</STRONG> soft label
<STRONG>short</STRONG> <STRONG>color_pair_number,</STRONG> <STRONG>void*</STRONG> <STRONG>opts);</STRONG>
<STRONG>attr_t</STRONG> <STRONG>slk_attr(void);</STRONG>
<STRONG>int</STRONG> <STRONG>slk_color(short</STRONG> <STRONG>color_pair_number);</STRONG>
+ <STRONG>int</STRONG> <STRONG>slk_wset</STRONG> <STRONG>(int</STRONG> <STRONG>labnum,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*label,</STRONG> <STRONG>int</STRONG> <STRONG>fmt);</STRONG>
</PRE>
an index line is generated, helping the user to
identify the key numbers easily.
- The <STRONG>slk_set</STRONG> routine has three parameters:
+ The <STRONG>slk_set</STRONG> routine (and the <STRONG>slk_wset</STRONG> routine for the
+ wide-character library) has three parameters:
<EM>labnum</EM>
- is the label number, from <STRONG>1</STRONG> to <STRONG>8</STRONG> (12 for <EM>fmt</EM>
+ is the label number, from <STRONG>1</STRONG> to <STRONG>8</STRONG> (12 for <EM>fmt</EM>
in <STRONG>slk_init</STRONG> is <STRONG>2</STRONG> or <STRONG>3</STRONG>);
<EM>label</EM>
- is be the string to put on the label, up to
- eight (five for <EM>fmt</EM> in <STRONG>slk_init</STRONG> is <STRONG>2</STRONG> or <STRONG>3</STRONG>)
+ is be the string to put on the label, up to
+ eight (five for <EM>fmt</EM> in <STRONG>slk_init</STRONG> is <STRONG>2</STRONG> or <STRONG>3</STRONG>)
characters in length. A null string or a null
pointer sets up a blank label.
- <EM>fmt</EM> is either <STRONG>0</STRONG>, <STRONG>1</STRONG>, or <STRONG>2</STRONG>, indicating whether the
- label is to be left-justified, centered, or
- right-justified, respectively, within the la-
+ <EM>fmt</EM> is either <STRONG>0</STRONG>, <STRONG>1</STRONG>, or <STRONG>2</STRONG>, indicating whether the
+ label is to be left-justified, centered, or
+ right-justified, respectively, within the la-
bel.
The <STRONG>slk_refresh</STRONG> and <STRONG>slk_noutrefresh</STRONG> routines correspond to
the <STRONG>wrefresh</STRONG> and <STRONG>wnoutrefresh</STRONG> routines.
- The <STRONG>slk_label</STRONG> routine returns the current label for label
+ The <STRONG>slk_label</STRONG> routine returns the current label for label
number <EM>labnum</EM>, with leading and trailing blanks stripped.
- The <STRONG>slk_clear</STRONG> routine clears the soft labels from the
+ The <STRONG>slk_clear</STRONG> routine clears the soft labels from the
screen.
- The <STRONG>slk_restore</STRONG> routine restores the soft labels to the
+ The <STRONG>slk_restore</STRONG> routine restores the soft labels to the
screen after a <STRONG>slk_clear</STRONG> has been performed.
- The <STRONG>slk_touch</STRONG> routine forces all the soft labels to be
+ The <STRONG>slk_touch</STRONG> routine forces all the soft labels to be
output the next time a <STRONG>slk_noutrefresh</STRONG> is performed.
The <STRONG>slk_attron</STRONG>, <STRONG>slk_attrset</STRONG>, <STRONG>slk_attroff</STRONG> and <STRONG>slk_attr</STRONG> rou-
tines correspond to <STRONG>attron</STRONG>, <STRONG>attrset</STRONG>, <STRONG>attroff</STRONG> and <STRONG>attr_get</STRONG>.
- They have an effect only if soft labels are simulated on
- the bottom line of the screen. The default highlight for
+ They have an effect only if soft labels are simulated on
+ the bottom line of the screen. The default highlight for
soft keys is A_STANDOUT (as in System V curses, which does
not document this fact).
The <STRONG>slk_color</STRONG> routine corresponds to <STRONG>color_set</STRONG>. It has an
- effect only if soft labels are simulated on the bottom
+ effect only if soft labels are simulated on the bottom
line of the screen.
fies only "an integer value other than <STRONG>ERR</STRONG>") upon success-
ful completion.
- X/Open defines no error conditions. In this implementa-
+ X/Open defines no error conditions. In this implementa-
tion
<STRONG>slk_attr</STRONG>
<STRONG>slk_attroff</STRONG>, <STRONG>slk_attron</STRONG>, <STRONG>slk_clear</STRONG>,
<STRONG>slk_noutrefresh</STRONG>, <STRONG>slk_refresh</STRONG>, <STRONG>slk_touch</STRONG>
- return an error if the terminal or the soft-
+ return an error if the terminal or the soft-
keys were not initialized.
<STRONG>slk_attrset</STRONG>
- returns an error if the terminal or the soft-
+ returns an error if the terminal or the soft-
keys were not initialized.
<STRONG>slk_attr_set</STRONG>
- returns an error if the terminal or the soft-
- keys were not initialized, or the color pair
+ returns an error if the terminal or the soft-
+ keys were not initialized, or the color pair
is outside the range 0..COLOR_PAIRS-1, or opts
is not null.
<STRONG>slk_color</STRONG>
- returns an error if the terminal or the soft-
- keys were not initialized, or the color pair
+ returns an error if the terminal or the soft-
+ keys were not initialized, or the color pair
is outside the range 0..COLOR_PAIRS-1.
<STRONG>slk_init</STRONG>
- returns an error if the format parameter is
+ returns an error if the format parameter is
outside the range 0..3.
<STRONG>slk_label</STRONG>
returns <STRONG>NULL</STRONG> on error.
<STRONG>slk_set</STRONG>
- returns an error if the terminal or the soft-
- keys were not initialized, or the <EM>labnum</EM> pa-
- rameter is outside the range of label counts,
- or if the format parameter is outside the
+ returns an error if the terminal or the soft-
+ keys were not initialized, or the <EM>labnum</EM> pa-
+ rameter is outside the range of label counts,
+ or if the format parameter is outside the
range 0..2, or if memory for the labels cannot
be allocated.
</PRE>
<H2>PORTABILITY</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>
+ 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>
to be <STRONG>attr_t</STRONG>, and adds <STRONG>const</STRONG> qualifiers. The format codes
- <STRONG>2</STRONG> and <STRONG>3</STRONG> for <STRONG>slk_init()</STRONG> and the function <STRONG>slk_attr</STRONG> are spe-
+ <STRONG>2</STRONG> and <STRONG>3</STRONG> for <STRONG>slk_init()</STRONG> and the function <STRONG>slk_attr</STRONG> are spe-
cific to ncurses.
</PRE>
<H2>SEE ALSO</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="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>
--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<!--
+ ****************************************************************************
+ * Copyright (c) 2010 Free Software Foundation, Inc. *
+ * *
+ * Permission is hereby granted, free of charge, to any person obtaining a *
+ * copy of this software and associated documentation files (the *
+ * "Software"), to deal in the Software without restriction, including *
+ * without limitation the rights to use, copy, modify, merge, publish, *
+ * distribute, distribute with modifications, sublicense, and/or sell *
+ * copies of the Software, and to permit persons to whom the Software is *
+ * furnished to do so, subject to the following conditions: *
+ * *
+ * The above copyright notice and this permission notice shall be included *
+ * in all copies or substantial portions of the Software. *
+ * *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+ * *
+ * Except as contained in this notice, the name(s) of the above copyright *
+ * holders shall not be used in advertising or otherwise to promote the *
+ * sale, use or other dealings in this Software without prior written *
+ * authorization. *
+ ****************************************************************************
+ * @Id: curs_sp_funcs.3x,v 1.4 2010/09/18 20:07:36 tom Exp @
+ * ***************************************************************************
+ * ***************************************************************************
+ * ***************************************************************************
+-->
+<HTML>
+<HEAD>
+<TITLE>curs_sp_funcs 3x</TITLE>
+<link rev=made href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
+<BODY>
+<H1>curs_sp_funcs 3x</H1>
+<HR>
+<PRE>
+<!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="curs_sp_funcs.3x.html">curs_sp_funcs(3x)</A></STRONG> <STRONG><A HREF="curs_sp_funcs.3x.html">curs_sp_funcs(3x)</A></STRONG>
+
+
+
+
+</PRE>
+<H2>NAME</H2><PRE>
+ new_prescr - <STRONG>curses</STRONG> screen-pointer extension
+
+
+</PRE>
+<H2>SYNOPSIS</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>
+ <STRONG>int</STRONG> <STRONG>baudrate_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>beep_sp(SCREEN*);</STRONG>
+ <STRONG>bool</STRONG> <STRONG>can_change_color_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>cbreak_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>color_content_sp(SCREEN*,</STRONG> <STRONG>short,</STRONG> <STRONG>short*,</STRONG> <STRONG>short*,</STRONG> <STRONG>short*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>curs_set_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>int</STRONG> <STRONG>define_key_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>int</STRONG> <STRONG>def_prog_mode_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>def_shell_mode_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>delay_output_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>int</STRONG> <STRONG>doupdate_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>echo_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>endwin_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>erasechar_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>filter_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>flash_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>flushinp_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>get_escdelay_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>getmouse_sp(SCREEN*,</STRONG> <STRONG>MEVENT*);</STRONG>
+ <STRONG>WINDOW*</STRONG> <STRONG>getwin_sp(SCREEN*,</STRONG> <STRONG>FILE*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>halfdelay_sp(SCREEN*);</STRONG>
+ <STRONG>bool</STRONG> <STRONG>has_colors_sp(SCREEN*);</STRONG>
+ <STRONG>bool</STRONG> <STRONG>has_ic_sp(SCREEN*);</STRONG>
+ <STRONG>bool</STRONG> <STRONG>has_il_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>has_key_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>bool</STRONG> <STRONG>has_mouse_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>init_color_sp(SCREEN*,</STRONG> <STRONG>short,</STRONG> <STRONG>short,</STRONG> <STRONG>short,</STRONG> <STRONG>short);</STRONG>
+ <STRONG>int</STRONG> <STRONG>init_pair_sp(SCREEN*,</STRONG> <STRONG>short,</STRONG> <STRONG>short,</STRONG> <STRONG>short);</STRONG>
+ <STRONG>int</STRONG> <STRONG>intrflush_sp(SCREEN*,</STRONG> <STRONG>WINDOW*,</STRONG> <STRONG>bool);</STRONG>
+ <STRONG>bool</STRONG> <STRONG>isendwin_sp(SCREEN*);</STRONG>
+ <STRONG>bool</STRONG> <STRONG>is_term_resized_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>char*</STRONG> <STRONG>keybound_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>int</STRONG> <STRONG>key_defined_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>keyname_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>int</STRONG> <STRONG>keyok_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>bool);</STRONG>
+ <STRONG>char</STRONG> <STRONG>killchar_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>mcprint_sp(SCREEN*,</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>int</STRONG> <STRONG>mouseinterval_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>mmask_t</STRONG> <STRONG>mousemask_sp(SCREEN*,</STRONG> <STRONG>mmask_t,</STRONG> <STRONG>mmask_t</STRONG> <STRONG>*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>mvcur_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>int</STRONG> <STRONG>napms_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>WINDOW*</STRONG> <STRONG>newpad_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>SCREEN*</STRONG> <STRONG>new_prescr(void);</STRONG>
+ <STRONG>SCREEN*</STRONG> <STRONG>newterm_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>FILE</STRONG> <STRONG>*,</STRONG> <STRONG>FILE</STRONG> <STRONG>*);</STRONG>
+ <STRONG>WINDOW*</STRONG> <STRONG>newwin_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>int</STRONG> <STRONG>nl_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>nocbreak_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>noecho_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>nofilter_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>nonl_sp(SCREEN*);</STRONG>
+ <STRONG>void</STRONG> <STRONG>noqiflush_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>noraw_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>pair_content_sp(SCREEN*,</STRONG> <STRONG>short,</STRONG> <STRONG>short*,</STRONG> <STRONG>short*);</STRONG>
+ <STRONG>void</STRONG> <STRONG>qiflush_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>raw_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>reset_prog_mode_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>reset_shell_mode_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>resetty_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>resize_term_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>int</STRONG> <STRONG>resizeterm_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>int</STRONG> <STRONG>restartterm_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char*,</STRONG> <STRONG>int,</STRONG> <STRONG>int</STRONG> <STRONG>*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>ripoffline_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int</STRONG> <STRONG>(*)(WINDOW*,</STRONG> <STRONG>int));</STRONG>
+ <STRONG>int</STRONG> <STRONG>savetty_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>scr_init_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>scr_restore_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>scr_set_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
+ <STRONG>TERMINAL*</STRONG> <STRONG>set_curterm_sp(SCREEN*,</STRONG> <STRONG>TERMINAL*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>set_escdelay_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>int</STRONG> <STRONG>set_tabsize_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>int</STRONG> <STRONG>slk_attroff_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>chtype);</STRONG>
+ <STRONG>int</STRONG> <STRONG>slk_attron_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>chtype);</STRONG>
+ <STRONG>int</STRONG> <STRONG>slk_attr_set_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>attr_t,</STRONG> <STRONG>short,</STRONG> <STRONG>void*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>slk_attrset_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>chtype);</STRONG>
+ <STRONG>int</STRONG> <STRONG>slk_attr_sp((SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>slk_clear_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>slk_color_sp(SCREEN*,</STRONG> <STRONG>short);</STRONG>
+ <STRONG>int</STRONG> <STRONG>slk_init_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>int</STRONG> <STRONG>slk_label_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>int</STRONG> <STRONG>slk_noutrefresh_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>slk_refresh_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>slk_restore_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>slk_set_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>int</STRONG> <STRONG>slk_touch_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>start_color_sp(SCREEN*);</STRONG>
+ <STRONG>attr_t</STRONG> <STRONG>term_attrs_sp(SCREEN*);</STRONG>
+ <STRONG>chtype</STRONG> <STRONG>termattrs_sp(SCREEN*);</STRONG>
+ <STRONG>char*</STRONG> <STRONG>termname_sp(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>typeahead_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char*</STRONG> <STRONG>unctrl_sp(SCREEN*,</STRONG> <STRONG>chtype);</STRONG>
+ <STRONG>int</STRONG> <STRONG>ungetch_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>int</STRONG> <STRONG>ungetmouse_sp(SCREEN*,MEVENT</STRONG> <STRONG>*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>unget_wch_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t);</STRONG>
+ <STRONG>int</STRONG> <STRONG>use_default_colors_sp(SCREEN*);</STRONG>
+ <STRONG>void</STRONG> <STRONG>use_env_sp(SCREEN*,</STRONG> <STRONG>bool);</STRONG>
+ <STRONG>int</STRONG> <STRONG>use_legacy_coding_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG>
+ <STRONG>int</STRONG> <STRONG>vid_attr_sp(SCREEN*,</STRONG> <STRONG>attr_t,</STRONG> <STRONG>short,</STRONG> <STRONG>void</STRONG> <STRONG>*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>vidattr_sp(SCREEN*,</STRONG> <STRONG>chtype);</STRONG>
+ <STRONG>int</STRONG> <STRONG>vid_puts_sp(SCREEN*,</STRONG> <STRONG>attr_t,</STRONG> <STRONG>short,</STRONG> <STRONG>void</STRONG> <STRONG>*,</STRONG> <STRONG>NCURSES_SP_OUTC);</STRONG>
+ <STRONG>int</STRONG> <STRONG>vidputs_sp(SCREEN*,</STRONG> <STRONG>chtype,</STRONG> <STRONG>NCURSES_SP_OUTC);</STRONG>
+ <STRONG>wchar_t*</STRONG> <STRONG>wunctrl_sp(SCREEN*,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*);</STRONG>
+
+ <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
+
+ <STRONG>int</STRONG> <STRONG>new_form_sp(SCREEN*,</STRONG> <STRONG>FIELD</STRONG> <STRONG>**);</STRONG>
+
+ <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
+
+ <STRONG>int</STRONG> <STRONG>new_menu_sp(SCREEN*,</STRONG> <STRONG>ITEM</STRONG> <STRONG>**);</STRONG>
+
+ <STRONG>#include</STRONG> <STRONG><panel.h></STRONG>
+
+ <STRONG>int</STRONG> <STRONG>ceiling_panel(SCREEN*);</STRONG>
+ <STRONG>PANEL*</STRONG> <STRONG>ground_panel(SCREEN*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>update_panels_sp(SCREEN*);</STRONG>
+
+ <STRONG>#include</STRONG> <STRONG><term.h></STRONG>
+
+ <STRONG>int</STRONG> <STRONG>del_curterm_sp(SCREEN*,</STRONG> <STRONG>TERMINAL</STRONG> <STRONG>*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>putp_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>tgetflag_sp(SCREEN*,</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>tgetent_sp(SCREEN*,</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>tgetnum_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
+ <STRONG>char*</STRONG> <STRONG>tgetstr_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>char</STRONG> <STRONG>**);</STRONG>
+ <STRONG>int</STRONG> <STRONG>tigetflag_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>tigetnum_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
+ <STRONG>char*</STRONG> <STRONG>tigetstr_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG>
+ <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>DESCRIPTION</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-
+ rations supported by ncurses; it adds new entrypoints
+ without changing the meaning of any of the existing ones.
+
+ <STRONG>IMPROVED</STRONG> <STRONG>FUNCTIONS</STRONG>
+ 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.
+
+ The existing functions all use the current screen, which
+ is a static variable. The extended functions use the
+ specified screen, thereby reducing the number of variables
+ which must be modified to update multiple screens.
+
+ <STRONG>NEW</STRONG> <STRONG>FUNCTIONS</STRONG>
+ Here are the new functions:
+
+ ceiling_panel
+ this returns a pointer to the topmost panel in the
+ given screen.
+
+ ground_panel
+ this returns a pointer to the lowest panel in the
+ given screen.
+
+ new_prescr
+ when creating a new screen, the library uses static
+ variables which have been preset, e.g., by
+ <STRONG><A HREF="use_env.3x.html">use_env(3x)</A></STRONG>, <STRONG><A HREF="filter.3x.html">filter(3x)</A></STRONG>, etc. With the screen-point-
+ er extension, there are situations where it must cre-
+ ate a current screen before the unextended library
+ does. The <STRONG>new_prescr</STRONG> function is used internally to
+ handle these cases. It is also provided as an entry-
+ point to allow applications to customize the library
+ initialization.
+
+
+</PRE>
+<H2>NOTES</H2><PRE>
+ This extension introduces some new names:
+
+ NCURSES_SP_FUNCS
+ This is set to the library patch-level number. In
+ the unextended library, this is zero (0), to make it
+ useful for checking if the extension is provided.
+
+ NCURSES_SP_NAME
+ The new functions are named using the macro <EM>NCURS-</EM>
+ <EM>ES</EM><STRONG>_</STRONG><EM>SP</EM><STRONG>_</STRONG><EM>NAME</EM>, which hides the actual implementation.
+ Currently this adds a "_sp" suffix to the name of the
+ unextended function. This manual page indexes the
+ extensions showing the full name. However the proper
+ usage of these functions uses the macro, to provide
+ for the possibility of changing the naming convention
+ for specific library configurations.
+
+ NCURSES_SP_OUTC
+ This is a new function-pointer type to use in the
+ screen-pointer functions where an <EM>NCURSES</EM><STRONG>_</STRONG><EM>OUTC</EM> is
+ used in the unextended library.
+
+ NCURSES_OUTC
+ This is a function-pointer type used for the cases
+ where a function passes characters to the output
+ stream, e.g., <STRONG><A HREF="vidputs.3x.html">vidputs(3x)</A></STRONG>.
+
+
+</PRE>
+<H2>PORTABILITY</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>SEE ALSO</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>.
+
+
+
+ <STRONG><A HREF="curs_sp_funcs.3x.html">curs_sp_funcs(3x)</A></STRONG>
+</PRE>
+<HR>
+<ADDRESS>
+Man(1) output converted with
+<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
+</ADDRESS>
+</BODY>
+</HTML>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_termcap.3x,v 1.23 2010/07/31 16:10:55 tom Exp @
+ * @Id: curs_termcap.3x,v 1.24 2010/09/11 19:59:32 tom Exp @
-->
<HTML>
<HEAD>
</PRE>
<H2>NAME</H2><PRE>
- <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
+ <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>
</PRE>
<H2>DESCRIPTION</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>
- database. Thus, they can only be used to query the capa-
- bilities of entries for which a terminfo entry has been
+ 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>
+ database. Thus, they can only be used to query the capa-
+ bilities of entries for which a terminfo entry has been
compiled.
- The <STRONG>tgetent</STRONG> routine loads the entry for <EM>name</EM>. It returns
- 1 on success, 0 if there is no such entry, and -1 if the
- terminfo database could not be found. The emulation
- ignores the buffer pointer <EM>bp</EM>.
+ The <STRONG>tgetent</STRONG> routine loads the entry for <EM>name</EM>. It returns
+ 1 on success, 0 if there is no such entry, and -1 if the
+ terminfo database could not be found. The emulation ig-
+ nores the buffer pointer <EM>bp</EM>.
- The <STRONG>tgetflag</STRONG> routine gets the boolean entry for <EM>id</EM>, or
- zero if it is not available.
+ The <STRONG>tgetflag</STRONG> routine gets the boolean entry for <EM>id</EM>, or ze-
+ ro if it is not available.
- The <STRONG>tgetnum</STRONG> routine gets the numeric entry for <EM>id</EM>, or -1
+ The <STRONG>tgetnum</STRONG> routine gets the numeric entry for <EM>id</EM>, or -1
if it is not available.
- The <STRONG>tgetstr</STRONG> routine returns the string entry for <EM>id</EM>, or
- zero if it is not available. Use <STRONG>tputs</STRONG> to output the
- returned string. The return value will also be copied to
- the buffer pointed to by <EM>area</EM>, and the <EM>area</EM> value will be
+ The <STRONG>tgetstr</STRONG> routine returns the string entry for <EM>id</EM>, or
+ zero if it is not available. Use <STRONG>tputs</STRONG> to output the re-
+ turned string. The return value will also be copied to
+ the buffer pointed to by <EM>area</EM>, and the <EM>area</EM> value will be
updated to point past the null ending this value.
Only the first two characters of the <STRONG>id</STRONG> parameter of <STRONG>tget-</STRONG>
<STRONG>flag</STRONG>, <STRONG>tgetnum</STRONG> and <STRONG>tgetstr</STRONG> are compared in lookups.
- The <STRONG>tgoto</STRONG> routine instantiates the parameters into the
- given capability. The output from this routine is to be
+ 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>.
- The
<STRONG>tputs</STRONG> routine is described on the <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
+ The
<STRONG>tputs</STRONG> routine is described on the <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
manual page. It can retrieve capabilities by either term-
cap or terminfo name.
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
+ <STRONG>backspace_if_not_bs</STRONG>, respectively. <STRONG>UP</STRONG> is not used by
ncurses. <STRONG>PC</STRONG> is used in the <STRONG>tdelay_output</STRONG> function. <STRONG>BC</STRONG> is
- used in the <STRONG>tgoto</STRONG> emulation. The variable <STRONG>ospeed</STRONG> is set
+ used in the <STRONG>tgoto</STRONG> emulation. The variable <STRONG>ospeed</STRONG> is set
by ncurses in a system-specific coding to reflect the ter-
minal speed.
</PRE>
<H2>RETURN VALUE</H2><PRE>
- Except where explicitly noted, routines that return an
- integer return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 only speci-
- fies "an integer value other than <STRONG>ERR</STRONG>") upon successful
- completion.
+ 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-
+ tion.
Routines that return pointers return <STRONG>NULL</STRONG> on error.
</PRE>
<H2>BUGS</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
- notation, not the older and not-quite-compatible termcap
- notation. This will not cause problems if all you do with
- it is call <STRONG>tgoto</STRONG> or <STRONG>tparm</STRONG>, which both expand terminfo-
- style strings as terminfo. (The <STRONG>tgoto</STRONG> function, if con-
- figured to support termcap, will check if the string is
- indeed terminfo-style by looking for "%p" parameters or
- "$<..>" delays, and invoke a termcap-style parser if the
+ string, be aware that it will be returned in terminfo no-
+ tation, not the older and not-quite-compatible termcap no-
+ tation. This will not cause problems if all you do with
+ it is call <STRONG>tgoto</STRONG> or <STRONG>tparm</STRONG>, which both expand terminfo-
+ style strings as terminfo. (The <STRONG>tgoto</STRONG> function, if con-
+ figured to support termcap, will check if the string is
+ indeed terminfo-style by looking for "%p" parameters or
+ "$<..>" delays, and invoke a termcap-style parser if the
string does not appear to be terminfo).
- Because terminfo conventions for representing padding in
- string capabilities differ from termcap's, <STRONG>tputs("50");</STRONG>
- will put out a literal "50" rather than busy-waiting for
+ Because terminfo conventions for representing padding in
+ string capabilities differ from termcap's, <STRONG>tputs("50");</STRONG>
+ will put out a literal "50" rather than busy-waiting for
50 milliseconds. Cope with it.
- Note that termcap has nothing analogous to terminfo's <STRONG>sgr</STRONG>
- string. One consequence of this is that termcap applica-
- tions assume me (terminfo <STRONG>sgr0</STRONG>) does not reset the alter-
- nate character set. This implementation checks for, and
+ Note that termcap has nothing analogous to terminfo's <STRONG>sgr</STRONG>
+ string. One consequence of this is that termcap applica-
+ tions assume me (terminfo <STRONG>sgr0</STRONG>) does not reset the alter-
+ nate character set. This implementation checks for, and
modifies the data shown to the termcap interface to accom-
modate termcap's limitation in this respect.
</PRE>
<H2>PORTABILITY</H2><PRE>
- The XSI Curses standard, Issue 4 describes these func-
- tions. However, they are marked TO BE WITHDRAWN and may
+ The XSI Curses standard, Issue 4 describes these func-
+ tions. However, they are marked TO BE WITHDRAWN and may
be removed in future versions.
- Neither the XSI Curses standard nor the SVr4 man pages
- documented the return values of <STRONG>tgetent</STRONG> correctly, though
- all three were in fact returned ever since SVr1. In par-
- ticular, an omission in the XSI Curses documentation has
- been misinterpreted to mean that <STRONG>tgetent</STRONG> returns <STRONG>OK</STRONG> or
+ Neither the XSI Curses standard nor the SVr4 man pages
+ documented the return values of <STRONG>tgetent</STRONG> correctly, though
+ all three were in fact returned ever since SVr1. In par-
+ ticular, an omission in the XSI Curses documentation has
+ been misinterpreted to mean that <STRONG>tgetent</STRONG> returns <STRONG>OK</STRONG> or
<STRONG>ERR</STRONG>. Because the purpose of these functions is to provide
- compatibility with the <EM>termcap</EM> library, that is a defect
+ compatibility with the <EM>termcap</EM> library, that is a defect
in XCurses, Issue 4, Version 2 rather than in ncurses.
- External variables are provided for support of certain
- termcap applications. However, termcap applications' use
+ External variables are provided for support of certain
+ termcap applications. However, termcap applications' use
of those variables is poorly documented, e.g., not distin-
- guishing between input and output. In particular, some
+ guishing between input and output. In particular, some
applications are reported to declare and/or modify <STRONG>ospeed</STRONG>.
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_threads.3x,v 1.13 2010/07/31 16:10:55 tom Exp @
+ * @Id: curs_threads.3x,v 1.16 2010/09/18 20:25:32 tom Exp @
* ***************************************************************************
* ***************************************************************************
-->
<H2>SYNOPSIS</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> <STRONG>type-</STRONG>
- <STRONG>def</STRONG> <STRONG>int</STRONG> <STRONG>(*NCURSES_SCREEN_CB)(SCREEN</STRONG> <STRONG>*,</STRONG> <STRONG>void</STRONG> <STRONG>*);</STRONG>
+ <STRONG>typedef</STRONG> <STRONG>int</STRONG> <STRONG>(*NCURSES_WINDOW_CB)(WINDOW</STRONG> <STRONG>*,</STRONG> <STRONG>void</STRONG> <STRONG>*);</STRONG>
+ <STRONG>typedef</STRONG> <STRONG>int</STRONG> <STRONG>(*NCURSES_SCREEN_CB)(SCREEN</STRONG> <STRONG>*,</STRONG> <STRONG>void</STRONG> <STRONG>*);</STRONG>
+ <STRONG>int</STRONG> <STRONG>get_escdelay(void);</STRONG>
<STRONG>int</STRONG> <STRONG>set_escdelay(int</STRONG> <STRONG>size);</STRONG>
<STRONG>int</STRONG> <STRONG>set_tabsize(int</STRONG> <STRONG>size);</STRONG>
- <STRONG>int</STRONG> <STRONG>use_screen(SCREEN</STRONG> <STRONG>*scr,</STRONG> <STRONG>NCURSES_WINDOW_CB</STRONG> <STRONG>func,</STRONG> <STRONG>void</STRONG>
+ <STRONG>int</STRONG> <STRONG>use_screen(SCREEN</STRONG> <STRONG>*scr,</STRONG> <STRONG>NCURSES_WINDOW_CB</STRONG> <STRONG>func,</STRONG> <STRONG>void</STRONG>
<STRONG>*data);</STRONG>
- <STRONG>int</STRONG> <STRONG>use_window(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>NCURSES_SCREEN_CB</STRONG> <STRONG>func,</STRONG> <STRONG>void</STRONG>
+ <STRONG>int</STRONG> <STRONG>use_window(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>NCURSES_SCREEN_CB</STRONG> <STRONG>func,</STRONG> <STRONG>void</STRONG>
<STRONG>*data);</STRONG>
</PRE>
<H2>DESCRIPTION</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
+ 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
binary interfaces are different.
- Rather than modify the interfaces to pass a thread speci-
- fier to each function, it adds a few functions which can
+ Rather than modify the interfaces to pass a thread speci-
+ fier to each function, it adds a few functions which can
be used in any configuration which hide the mutex's needed
- to prevent concurrent use of the global variables when
+ to prevent concurrent use of the global variables when
configured for threading.
- In addition to forcing access to members of the <STRONG>WINDOW</STRONG>
- structure to be via functions (see <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>), it
+ In addition to forcing access to members of the <STRONG>WINDOW</STRONG>
+ structure to be via functions (see <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>), it
makes functions of the common global variables, e.g., COL-
- ORS, COLOR_PAIRS, COLS, ESCDELAY, LINES, TABSIZE curscr,
- newscr and ttytype. Those variables are maintained as
+ ORS, COLOR_PAIRS, COLS, ESCDELAY, LINES, TABSIZE curscr,
+ newscr and ttytype. Those variables are maintained as
read-only values, stored in the <STRONG>SCREEN</STRONG> structure.
- Even this is not enough to make a thread-safe application
- using curses. A multi-threaded application would be ex-
- pected to have threads updating separate windows (within
+ Even this is not enough to make a thread-safe application
+ using curses. A multi-threaded application would be ex-
+ pected to have threads updating separate windows (within
the same device), or updating on separate screens (on dif-
- ferent devices). Also, a few of the global variables are
- considered writable by some applications. The functions
+ ferent devices). Also, a few of the global variables are
+ considered writable by some applications. The functions
described here address these special situations.
- The ESCDELAY and TABSIZE global variables are modified by
- some applications. To modify them in any configuration,
- use the <STRONG>set_escdelay</STRONG> or <STRONG>set_tabsize</STRONG> functions. Other
+ The ESCDELAY and TABSIZE global variables are modified by
+ some applications. To modify them in any configuration,
+ use the <STRONG>set_escdelay</STRONG> or <STRONG>set_tabsize</STRONG> functions. Other
global variables are not modifiable.
- The <STRONG>use_window</STRONG> and <STRONG>use_screen</STRONG> functions provide coarse
+ The <STRONG>get_escdelay</STRONG> function returns the value for ESCDELAY.
+
+ The <STRONG>use_window</STRONG> and <STRONG>use_screen</STRONG> functions provide coarse
granularity mutexes for their respective <STRONG>WINDOW</STRONG> and <STRONG>SCREEN</STRONG>
- parameters, and call a user-supplied function, passing it
- a <EM>data</EM> parameter, and returning the value from the user-
+ parameters, and call a user-supplied function, passing it
+ a <EM>data</EM> parameter, and returning the value from the user-
supplied function to the application.
<STRONG>USAGE</STRONG>
- All of the ncurses library functions assume that the lo-
- cale is not altered during operation. In addition, they
+ 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.
- - global data, e.g., used in the low-level termin-
- fo or termcap interfaces.
+ <STRONG>o</STRONG> global data, e.g., used in the low-level terminfo
+ or termcap interfaces.
- - terminal data, e.g., associated with a call to
- <EM>set</EM><STRONG>_</STRONG><EM>curterm</EM>. The terminal data are initialized
- when screens are created.
+ <STRONG>o</STRONG> terminal data, e.g., associated with a call to
+ <EM>set</EM><STRONG>_</STRONG><EM>curterm</EM>. The terminal data are initialized
+ when screens are created.
- - screen data, e.g., associated with a call to
- <EM>newterm</EM> or <EM>initscr</EM>.
+ <STRONG>o</STRONG> screen data, e.g., associated with a call to
+ <EM>newterm</EM> or <EM>initscr</EM>.
- - window data, e.g., associated with a call to
- <EM>newwin</EM> or <EM>subwin</EM>. Windows are associated with
- screens. Pads are not necessarily associated
- with a particular screen.
+ <STRONG>o</STRONG> window data, e.g., associated with a call to <EM>newwin</EM>
+ or <EM>subwin</EM>. Windows are associated with screens.
+ Pads are not necessarily associated with a particu-
+ lar screen.
- Most curses applications operate on one or more
- windows within a single screen.
+ Most curses applications operate on one or more
+ windows within a single screen.
- - reentrant, i.e., it uses only the data passed as
- parameters.
+ <STRONG>o</STRONG> reentrant, i.e., it uses only the data passed as
+ parameters.
This table lists the scope of data used for each symbol in
- the ncurses library when it is configured to support
+ the ncurses library when it is configured to support
threading:
Symbol Scope
boolfnames global (readonly)
boolnames global (readonly)
border window (stdscr)
+
border_set window (stdscr)
box window (stdscr)
box_set window (stdscr)
-
can_change_color terminal
cbreak screen
chgat window (stdscr)
has_key screen
hline window (stdscr)
hline_set window (stdscr)
+
idcok window
idlok window
immedok window
-
in_wch window (stdscr)
in_wchnstr window (stdscr)
in_wchstr window (stdscr)
mvaddstr window (stdscr)
mvaddwstr window (stdscr)
mvchgat window (stdscr)
+
mvcur screen
mvdelch window (stdscr)
mvderwin window (stdscr)
-
mvget_wch screen (input-operation)
mvget_wstr screen (input-operation)
mvgetch screen (input-operation)
mvwinsch window
mvwinsnstr window
mvwinsstr window
+
mvwinstr window
mvwinwstr window
mvwprintw window
-
mvwscanw screen
mvwvline window
mvwvline_set window
slk_attr_on screen
slk_attr_set screen
slk_attroff screen
+
slk_attron screen
slk_attrset screen
slk_clear screen
-
slk_color screen
slk_init screen
slk_label screen
wadd_wchnstr window
wadd_wchstr window
waddch window
+
waddchnstr window
waddchstr window
waddnstr window
-
waddnwstr window
waddstr window
waddwstr window
wprintw window
wredrawln window
wrefresh screen
+
wresize window locks(windowlist)
wscanw screen
wscrl window
-
wsetscrreg window
wstandend window
wstandout window
</PRE>
<H2>PORTABILITY</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-
+ 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.
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_util.3x,v 1.28 2010/07/31 16:10:55 tom Exp @
+ * @Id: curs_util.3x,v 1.30 2010/09/18 20:24:41 tom Exp @
-->
<HTML>
<HEAD>
tributes. Control characters are displayed in the <STRONG>^</STRONG><EM>X</EM> no-
tation. Printing characters are displayed as is. The
corresponding <STRONG>wunctrl</STRONG> returns a printable representation
- of a wide-character.
+ of a wide character.
The <STRONG>keyname</STRONG> routine returns a character string correspond-
ing to the key <EM>c</EM>:
- - Printable characters are displayed as themselves,
- e.g., a one-character string containing the key.
+ <STRONG>o</STRONG> Printable characters are displayed as themselves,
+ e.g., a one-character string containing the key.
- - Control characters are displayed in the <STRONG>^</STRONG><EM>X</EM> notation.
+ <STRONG>o</STRONG> Control characters are displayed in the <STRONG>^</STRONG><EM>X</EM> nota-
+ tion.
- - DEL (character 127) is displayed as <STRONG>^?</STRONG>.
+ <STRONG>o</STRONG> DEL (character 127) is displayed as <STRONG>^?</STRONG>.
- - Values above 128 are either meta characters (if the
- screen has not been initialized, or if <STRONG>meta</STRONG> has been
- called with a TRUE parameter), shown in the <STRONG>M-</STRONG><EM>X</EM> no-
- tation, or are displayed as themselves. In the lat-
- ter case, the values may not be printable; this fol-
- lows the X/Open specification.
+ <STRONG>o</STRONG> Values above 128 are either meta characters (if the
+ screen has not been initialized, or if <STRONG>meta</STRONG> has
+ been called with a TRUE parameter), shown in the
+ <STRONG>M-</STRONG><EM>X</EM> notation, or are displayed as themselves. In
+ the latter case, the values may not be printable;
+ this follows the X/Open specification.
- - Values above 256 may be the names of the names of
- function keys.
+ <STRONG>o</STRONG> Values above 256 may be the names of the names of
+ function keys.
- - Otherwise (if there is no corresponding name) the
- function returns null, to denote an error. X/Open
- also lists an "UNKNOWN KEY" return value, which some
- implementations return rather than null.
+ <STRONG>o</STRONG> Otherwise (if there is no corresponding name) the
+ function returns null, to denote an error. X/Open
+ also lists an "UNKNOWN KEY" return value, which
+ some implementations return rather than null.
The corresponding <STRONG>key_name</STRONG> returns a character string cor-
- responding to the wide-character value <EM>w</EM>. The two func-
- tions do not return the same set of strings; the latter
+ responding to the wide-character value <EM>w</EM>. The two func-
+ tions do not return the same set of strings; the latter
returns null where the former would display a meta charac-
ter.
The <STRONG>filter</STRONG> routine, if used, must be called before <STRONG>initscr</STRONG>
- or <STRONG>newterm</STRONG> are called. The effect is that, during those
- calls, <STRONG>LINES</STRONG> is set to 1; the capabilities <STRONG>clear</STRONG>, <STRONG>cup</STRONG>,
- <STRONG>cud</STRONG>, <STRONG>cud1</STRONG>, <STRONG>cuu1</STRONG>, <STRONG>cuu</STRONG>, <STRONG>vpa</STRONG> are disabled; and the <STRONG>home</STRONG>
+ or <STRONG>newterm</STRONG> are called. The effect is that, during those
+ calls, <STRONG>LINES</STRONG> is set to 1; the capabilities <STRONG>clear</STRONG>, <STRONG>cup</STRONG>,
+ <STRONG>cud</STRONG>, <STRONG>cud1</STRONG>, <STRONG>cuu1</STRONG>, <STRONG>cuu</STRONG>, <STRONG>vpa</STRONG> are disabled; and the <STRONG>home</STRONG>
string is set to the value of <STRONG>cr</STRONG>.
- The <STRONG>nofilter</STRONG> routine cancels the effect of a preceding
- <STRONG>filter</STRONG> call. That allows the caller to initialize a
- screen on a different device, using a different value of
- <STRONG>$TERM</STRONG>. The limitation arises because the <STRONG>filter</STRONG> routine
+ The <STRONG>nofilter</STRONG> routine cancels the effect of a preceding
+ <STRONG>filter</STRONG> call. That allows the caller to initialize a
+ screen on a different device, using a different value of
+ <STRONG>$TERM</STRONG>. The limitation arises because the <STRONG>filter</STRONG> routine
modifies the in-memory copy of the terminal information.
- The <STRONG>use_env</STRONG> routine, if used, is called before <STRONG>initscr</STRONG> or
- <STRONG>newterm</STRONG> are called. When called with <STRONG>FALSE</STRONG> as an argu-
- ment, the values of <STRONG>lines</STRONG> and <STRONG>columns</STRONG> specified in the
- <EM>terminfo</EM> database will be used, even if environment vari-
- ables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> (used by default) are set, or if
- <STRONG>curses</STRONG> is running in a window (in which case default be-
- havior would be to use the window size if <STRONG>LINES</STRONG> and <STRONG>COL-</STRONG>
- <STRONG>UMNS</STRONG> are not set). Note that setting <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG>
- overrides the corresponding size which may be obtained
+ The <STRONG>use_env</STRONG> routine, if used, is called before <STRONG>initscr</STRONG> or
+ <STRONG>newterm</STRONG> are called. When called with <STRONG>FALSE</STRONG> as an argu-
+ ment, the values of <STRONG>lines</STRONG> and <STRONG>columns</STRONG> specified in the
+ <EM>terminfo</EM> database will be used, even if environment vari-
+ ables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> (used by default) are set, or if
+ <STRONG>curses</STRONG> is running in a window (in which case default be-
+ havior would be to use the window size if <STRONG>LINES</STRONG> and <STRONG>COL-</STRONG>
+ <STRONG>UMNS</STRONG> are not set). Note that setting <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG>
+ overrides the corresponding size which may be obtained
from the operating system.
- The <STRONG>putwin</STRONG> routine writes all data associated with window
+ The <STRONG>putwin</STRONG> routine writes all data associated with window
<EM>win</EM> into the file to which <EM>filep</EM> points. This information
can be later retrieved using the <STRONG>getwin</STRONG> function.
The <STRONG>getwin</STRONG> routine reads window related data stored in the
- file by <STRONG>putwin</STRONG>. The routine then creates and initializes
+ file by <STRONG>putwin</STRONG>. The routine then creates and initializes
a new window using that data. It returns a pointer to the
new window.
- The <STRONG>delay_output</STRONG> routine inserts an <EM>ms</EM> millisecond pause
- in output. This routine should not be used extensively
- because padding characters are used rather than a CPU
- pause. If no padding character is specified, this uses
+ The <STRONG>delay_output</STRONG> routine inserts an <EM>ms</EM> millisecond pause
+ in output. This routine should not be used extensively
+ because padding characters are used rather than a CPU
+ pause. If no padding character is specified, this uses
<STRONG>napms</STRONG> to perform the delay.
- The <STRONG>flushinp</STRONG> routine throws away any typeahead that has
- been typed by the user and has not yet been read by the
+ The <STRONG>flushinp</STRONG> routine throws away any typeahead that has
+ been typed by the user and has not yet been read by the
program.
</PRE>
<H2>RETURN VALUE</H2><PRE>
- Except for <STRONG>flushinp</STRONG>, routines that return an integer re-
- turn <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 specifies only "an in-
+ 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.
Routines that return pointers return <STRONG>NULL</STRONG> on error.
- X/Open does not define any error conditions. In this im-
+ X/Open does not define any error conditions. In this im-
plementation
<STRONG>flushinp</STRONG>
- returns an error if the terminal was not initial-
+ returns an error if the terminal was not initial-
ized.
- <STRONG>meta</STRONG> returns an error if the terminal was not initial-
+ <STRONG>meta</STRONG> returns an error if the terminal was not initial-
ized.
<STRONG>putwin</STRONG>
- returns an error if the associated <STRONG>fwrite</STRONG> calls
+ returns an error if the associated <STRONG>fwrite</STRONG> calls
return an error.
</PRE>
<H2>PORTABILITY</H2><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-
+ 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-
ror conditions. This implementation checks for three cas-
es:
- - the parameter is a 7-bit US-ASCII code. This
- is the case that X/Open Curses documented.
+ <STRONG>o</STRONG> the parameter is a 7-bit US-ASCII code. This is
+ the case that X/Open Curses documented.
- - the parameter is in the range 128-159, i.e., a
- C1 control code. If <STRONG>use_legacy_coding</STRONG> has
- been called with a <STRONG>2</STRONG> parameter, <STRONG>unctrl</STRONG> returns
- the parameter, i.e., a one-character string
- with the parameter as the first character.
- Otherwise, it returns ``~@'', ``~A'', etc.,
- analogous to ``^@'', ``^A'', C0 controls.
+ <STRONG>o</STRONG> the parameter is in the range 128-159, i.e., a C1
+ control code. If <STRONG>use_legacy_coding</STRONG> has been called
+ with a <STRONG>2</STRONG> parameter, <STRONG>unctrl</STRONG> returns the parameter,
+ i.e., a one-character string with the parameter as
+ the first character. Otherwise, it returns ``~@'',
+ ``~A'', etc., analogous to ``^@'', ``^A'', C0 con-
+ trols.
- X/Open Curses does not document whether <STRONG>unctrl</STRONG>
- can be called before initializing curses.
- This implementation permits that, and returns
- the ``~@'', etc., values in that case.
+ X/Open Curses does not document whether <STRONG>unctrl</STRONG> can
+ be called before initializing curses. This imple-
+ mentation permits that, and returns the ``~@'',
+ etc., values in that case.
- - parameter values outside the 0 to 255 range.
- <STRONG>unctrl</STRONG> returns a null pointer.
+ <STRONG>o</STRONG> parameter values outside the 0 to 255 range. <STRONG>unc-</STRONG>
+ <STRONG>trl</STRONG> returns a null pointer.
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
+ 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>).
- The strings returned by <STRONG>unctrl</STRONG> in this implementation are
- determined at compile time, showing C1 controls from the
- upper-128 codes with a `~' prefix rather than `^'. Other
- implementations have different conventions. For example,
- they may show both sets of control characters with `^',
- and strip the parameter to 7 bits. Or they may ignore C1
- controls and treat all of the upper-128 codes as print-
+ The strings returned by <STRONG>unctrl</STRONG> in this implementation are
+ determined at compile time, showing C1 controls from the
+ upper-128 codes with a `~' prefix rather than `^'. Other
+ implementations have different conventions. For example,
+ they may show both sets of control characters with `^',
+ and strip the parameter to 7 bits. Or they may ignore C1
+ controls and treat all of the upper-128 codes as print-
able. This implementation uses 8 bits but does not modify
the string to reflect locale. The <STRONG>use_legacy_coding</STRONG> func-
tion allows the caller to change the output of <STRONG>unctrl</STRONG>.
- Likewise, the <STRONG>meta</STRONG> function allows the caller to change
- the output of <STRONG>keyname</STRONG>, i.e., it determines whether to use
- the `M-' prefix for ``meta'' keys (codes in the range 128
+ Likewise, the <STRONG>meta</STRONG> function allows the caller to change
+ the output of <STRONG>keyname</STRONG>, i.e., it determines whether to use
+ the `M-' prefix for ``meta'' keys (codes in the range 128
to 255). Both <STRONG>use_legacy_coding</STRONG> and <STRONG>meta</STRONG> succeed only af-
- ter curses is initialized. X/Open Curses does not docu-
- ment the treatment of codes 128 to 159. When treating
+ ter curses is initialized. X/Open Curses does not docu-
+ ment the treatment of codes 128 to 159. When treating
them as ``meta'' keys (or if <STRONG>keyname</STRONG> is called before ini-
- tializing curses), this implementation returns strings
+ tializing curses), this implementation returns strings
``M-^@'', ``M-^A'', etc.
- 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-
- matically assigns at run-time keycodes to user-defined
- strings which begin with "k". The keycodes start at
- KEY_MAX, but are not guaranteed to be the same value for
- different runs because user-defined codes are merged from
- all terminal descriptions which have been loaded. The
- <STRONG>use_extended_names</STRONG> function controls whether this data is
- loaded when the terminal description is read by the li-
+ 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-
+ matically assigns at run-time keycodes to user-defined
+ strings which begin with "k". The keycodes start at
+ KEY_MAX, but are not guaranteed to be the same value for
+ different runs because user-defined codes are merged from
+ all terminal descriptions which have been loaded. The
+ <STRONG>use_extended_names</STRONG> function controls whether this data is
+ loaded when the terminal description is read by the li-
brary.
- The <STRONG>nofilter</STRONG> routine is specific to ncurses. It was not
- supported on Version 7, BSD or System V implementations.
- It is recommended that any code depending on ncurses ex-
+ The <STRONG>nofilter</STRONG> routine is specific to ncurses. It was 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.
--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<!--
+ ****************************************************************************
+ * Copyright (c) 2010 Free Software Foundation, Inc. *
+ * *
+ * Permission is hereby granted, free of charge, to any person obtaining a *
+ * copy of this software and associated documentation files (the *
+ * "Software"), to deal in the Software without restriction, including *
+ * without limitation the rights to use, copy, modify, merge, publish, *
+ * distribute, distribute with modifications, sublicense, and/or sell *
+ * copies of the Software, and to permit persons to whom the Software is *
+ * furnished to do so, subject to the following conditions: *
+ * *
+ * The above copyright notice and this permission notice shall be included *
+ * in all copies or substantial portions of the Software. *
+ * *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+ * *
+ * Except as contained in this notice, the name(s) of the above copyright *
+ * holders shall not be used in advertising or otherwise to promote the *
+ * sale, use or other dealings in this Software without prior written *
+ * authorization. *
+ ****************************************************************************
+ * @Id: curs_variables.3x,v 1.3 2010/09/11 20:16:49 tom Exp @
+-->
+<HTML>
+<HEAD>
+<TITLE>curs_variables 3x</TITLE>
+<link rev=made href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
+<BODY>
+<H1>curs_variables 3x</H1>
+<HR>
+<PRE>
+<!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG> <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
+
+
+
+
+</PRE>
+<H2>NAME</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>SYNOPSIS</H2><PRE>
+ <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
+
+ <STRONG>int</STRONG> <STRONG>COLOR_PAIRS;</STRONG>
+ <STRONG>int</STRONG> <STRONG>COLORS;</STRONG>
+ <STRONG>int</STRONG> <STRONG>COLS;</STRONG>
+ <STRONG>int</STRONG> <STRONG>ESCDELAY;</STRONG>
+ <STRONG>int</STRONG> <STRONG>LINES;</STRONG>
+ <STRONG>int</STRONG> <STRONG>TABSIZE;</STRONG>
+ <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>curscr;</STRONG>
+ <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>newscr;</STRONG>
+ <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>stdscr;</STRONG>
+
+
+</PRE>
+<H2>DESCRIPTION</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.
+
+ Depending on the configuration, these may be actual vari-
+ ables, or macros (see <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>) which provide
+ read-only access to <EM>curses</EM>'s state. In either case, ap-
+ plications should treat them as read-only to avoid confus-
+ ing the library.
+
+ <STRONG>COLOR_PAIRS</STRONG>
+ 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>
+ <STRONG>ORS</STRONG>*<STRONG>COLORS</STRONG>, however this is not always true:
+
+ <STRONG>o</STRONG> a few terminals use HLS colors, which do not follow
+ this rule
+
+ <STRONG>o</STRONG> terminals supporting a large number of colors are lim-
+ ited by the number of color pairs that can be repre-
+ sented in a <EM>signed</EM> <EM>short</EM> value.
+
+ <STRONG>COLORS</STRONG>
+ After initializing curses, this variable contains the num-
+ ber of colors which the terminal can support.
+
+ <STRONG>COLS</STRONG>
+ After initializing curses, this variable contains the
+ width of the screen, i.e., the number of columns.
+
+ <STRONG>ESCDELAY</STRONG>
+ 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
+ escape sequences sent by cursor- and function-keys (see
+ <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
+
+ <STRONG>LINES</STRONG>
+ After initializing curses, this variable contains the
+ height of the screen, i.e., the number of lines.
+
+ <STRONG>TABSIZE</STRONG>
+ 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>.
+
+ <STRONG>The</STRONG> <STRONG>Current</STRONG> <STRONG>Screen</STRONG>
+ This implementation of curses uses a special window <STRONG>curscr</STRONG>
+ to record its updates to the terminal screen.
+
+ <STRONG>The</STRONG> <STRONG>New</STRONG> <STRONG>Screen</STRONG>
+ 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>.
+
+ <STRONG>The</STRONG> <STRONG>Standard</STRONG> <STRONG>Screen</STRONG>
+ 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>NOTES</H2><PRE>
+ The curses library is initialized using either
+ <STRONG><A HREF="initscr.3x.html">initscr(3x)</A></STRONG>, or <STRONG><A HREF="newterm.3x.html">newterm(3x)</A></STRONG>.
+
+ If <STRONG>curses</STRONG> is configured to use separate curses/terminfo
+ libraries, most of these variables reside in the curses
+ library.
+
+
+</PRE>
+<H2>PORTABILITY</H2><PRE>
+ ESCDELAY and TABSIZE are extensions, not provided in most
+ other implementations of curses.
+
+
+</PRE>
+<H2>SEE ALSO</H2><PRE>
+ <STRONG><A HREF="ncurses.3x.html">curses(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>termin-</STRONG>
+ <STRONG><A HREF="terminfo.3x.html">fo(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
+
+
+
+ <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
+</PRE>
+<HR>
+<ADDRESS>
+Man(1) output converted with
+<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
+</ADDRESS>
+</BODY>
+</HTML>
</PRE>
<H2>SEE ALSO</H2><PRE>
- This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100731).
+ This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100918).
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: form_driver.3x,v 1.18 2010/07/31 14:49:44 tom Exp @
+ * @Id: form_driver.3x,v 1.19 2010/09/18 20:23:02 tom Exp @
-->
<HTML>
<HEAD>
input events to it through <STRONG>form_driver</STRONG>. This routine has
three major input cases:
- - The input is a form navigation request. Navigation
- request codes are constants defined in <STRONG><form.h></STRONG>, which
- are distinct from the key- and character codes returned
- by <STRONG>wgetch</STRONG>.
+ <STRONG>o</STRONG> The input is a form navigation request. Navigation
+ request codes are constants defined in <STRONG><form.h></STRONG>, which
+ are distinct from the key- and character codes
+ returned by <STRONG>wgetch</STRONG>.
- - The input is a printable character. Printable charac-
- ters (which must be positive, less than 256) are
- checked according to the program's locale settings.
+ <STRONG>o</STRONG> The input is a printable character. Printable charac-
+ ters (which must be positive, less than 256) are
+ checked according to the program's locale settings.
- - The input is the KEY_MOUSE special key associated with
- an mouse event.
+ <STRONG>o</STRONG> The input is the KEY_MOUSE special key associated with
+ an mouse event.
The form driver requests are as follows:
If you click above the display region of the form:
- a REQ_PREV_FIELD is generated for a single click,
+ a REQ_PREV_FIELD is generated for a single click,
- a REQ_PREV_PAGE is generated for a double-click and
+ a REQ_PREV_PAGE is generated for a double-click and
- a REQ_FIRST_FIELD is generated for a triple-click.
+ a REQ_FIRST_FIELD is generated for a triple-click.
If you click below the display region of the form:
- a REQ_NEXT_FIELD is generated for a single click,
+ a REQ_NEXT_FIELD is generated for a single click,
- a REQ_NEXT_PAGE is generated for a double-click and
+ a REQ_NEXT_PAGE is generated for a double-click and
- a REQ_LAST_FIELD is generated for a triple-click.
+ a REQ_LAST_FIELD is generated for a triple-click.
If you click at an field inside the display area of the
form:
- - the form cursor is positioned to that field.
+ <STRONG>o</STRONG> the form cursor is positioned to that field.
- - If you double-click a field, the form cursor is
- positioned to that field and <STRONG>E_UNKNOWN_COMMAND</STRONG>
- is returned. This return value makes sense,
- because a double click usually means that an
- field-specific action should be returned. It is
- exactly the purpose of this return value to sig-
- nal that an application specific command should
- be executed.
+ <STRONG>o</STRONG> If you double-click a field, the form cursor is
+ positioned to that field and <STRONG>E_UNKNOWN_COMMAND</STRONG> is
+ returned. This return value makes sense, because a
+ double click usually means that an field-specific
+ action should be returned. It is exactly the pur-
+ pose of this return value to signal that an appli-
+ cation specific command should be executed.
- - If a translation into a request was done,
- <STRONG>form_driver</STRONG> returns the result of this request.
+ <STRONG>o</STRONG> If a translation into a request was done,
+ <STRONG>form_driver</STRONG> returns the result of this request.
- If you clicked outside the user window or the mouse event
- could not be translated into a form request an
+ If you clicked outside the user window or the mouse event
+ could not be translated into a form request an
<STRONG>E_REQUEST_DENIED</STRONG> is returned.
<STRONG>APPLICATION-DEFINED</STRONG> <STRONG>COMMANDS</STRONG>
If the second argument is neither printable nor one of the
- above pre-defined form requests, the driver assumes it is
+ above pre-defined form requests, the driver assumes it is
an application-specific command and returns <STRONG>E_UNKNOWN_COM-</STRONG>
<STRONG>MAND</STRONG>. Application-defined commands should be defined rel-
- ative to <STRONG>MAX_COMMAND</STRONG>, the maximum value of these pre-
+ ative to <STRONG>MAX_COMMAND</STRONG>, the maximum value of these pre-
defined requests.
<STRONG>E_OK</STRONG> The routine succeeded.
<STRONG>E_BAD_ARGUMENT</STRONG>
- Routine detected an incorrect or out-of-range argu-
+ Routine detected an incorrect or out-of-range argu-
ment.
<STRONG>E_BAD_STATE</STRONG>
</PRE>
<H2>PORTABILITY</H2><PRE>
- These routines emulate the System V forms library. They
+ These routines emulate the System V forms library. They
were not supported on Version 7 or BSD versions.
</PRE>
<H2>AUTHORS</H2><PRE>
- Juergen Pfeifer. Manual pages and adaptation for new
+ Juergen Pfeifer. Manual pages and adaptation for new
curses by Eric S. Raymond.
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: form_field_buffer.3x,v 1.16 2010/07/31 16:09:36 tom Exp @
+ * @Id: form_field_buffer.3x,v 1.18 2010/09/18 20:22:01 tom Exp @
-->
<HTML>
<HEAD>
</PRE>
<H2>SYNOPSIS</H2><PRE>
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
+
int set_field_buffer(FIELD *field, int buf, const char
*value);
char *field_buffer(const FIELD *field, int buffer);
The function <STRONG>set_field_buffer</STRONG> sets the numbered buffer of
the given field to contain a given string:
- - Buffer 0 is the displayed value of the field.
+ <STRONG>o</STRONG> Buffer 0 is the displayed value of the field.
- - Other numbered buffers may be allocated by applica-
- tions through the <STRONG>nbuf</STRONG> argument of (see
- <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>) but are not manipulated by the
- forms library.
+ <STRONG>o</STRONG> Other numbered buffers may be allocated by applica-
+ tions through the <STRONG>nbuf</STRONG> argument of (see
+ <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>) but are not manipulated by the
+ forms library.
The function <STRONG>field_buffer</STRONG> returns a pointer to the con-
tents of the given numbered buffer:
- - The buffer contents always have the same length, and
- are padded with trailing spaces as needed to ensure
- this length is the same.
+ <STRONG>o</STRONG> The buffer contents always have the same length,
+ and are padded with trailing spaces as needed to
+ ensure this length is the same.
- - The buffer may contain leading spaces, depending on
- how it was set.
+ <STRONG>o</STRONG> The buffer may contain leading spaces, depending on
+ how it was set.
- - The buffer contents are set with <STRONG>set_field_buffer</STRONG>,
- or as a side effect of any editing operations on the
- corresponding field.
+ <STRONG>o</STRONG> The buffer contents are set with <STRONG>set_field_buffer</STRONG>,
+ or as a side effect of any editing operations on
+ the corresponding field.
- - Editing operations are based on the <EM>window</EM> which
- displays the field, rather than a <EM>string</EM>. The win-
- dow contains only printable characters, and is
- filled with blanks. If you want the raw data, you
- must write your own routine that copies the value
- out of the buffer and removes the leading and trail-
- ing spaces.
+ <STRONG>o</STRONG> Editing operations are based on the <EM>window</EM> which
+ displays the field, rather than a <EM>string</EM>. The win-
+ dow contains only printable characters, and is
+ filled with blanks. If you want the raw data, you
+ must write your own routine that copies the value
+ out of the buffer and removes the leading and
+ trailing spaces.
- - Because editing operations change the content of the
- buffer to correspond to the window, you should not
- rely on using buffers for long-term storage of form
- data.
+ <STRONG>o</STRONG> Because editing operations change the content of
+ the buffer to correspond to the window, you should
+ not rely on using buffers for long-term storage of
+ form data.
The function <STRONG>set_field_status</STRONG> sets the associated status
flag of <EM>field</EM>; <STRONG>field_status</STRONG> gets the current value. The
The header file <STRONG><form.h></STRONG> automatically includes the header
file
- When configured for wide-characters, <STRONG>field_buffer</STRONG> returns
+ When configured for wide characters, <STRONG>field_buffer</STRONG> returns
a pointer to temporary storage (allocated and freed by the
library). The application should not attempt to modify
the data. It will be freed on the next call to <STRONG>field_buf-</STRONG>
--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<!--
+ ****************************************************************************
+ * Copyright (c) 2010 Free Software Foundation, Inc. *
+ * *
+ * Permission is hereby granted, free of charge, to any person obtaining a *
+ * copy of this software and associated documentation files (the *
+ * "Software"), to deal in the Software without restriction, including *
+ * without limitation the rights to use, copy, modify, merge, publish, *
+ * distribute, distribute with modifications, sublicense, and/or sell *
+ * copies of the Software, and to permit persons to whom the Software is *
+ * furnished to do so, subject to the following conditions: *
+ * *
+ * The above copyright notice and this permission notice shall be included *
+ * in all copies or substantial portions of the Software. *
+ * *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+ * *
+ * Except as contained in this notice, the name(s) of the above copyright *
+ * holders shall not be used in advertising or otherwise to promote the *
+ * sale, use or other dealings in this Software without prior written *
+ * authorization. *
+ ****************************************************************************
+ * @Id: form_variables.3x,v 1.1 2010/09/11 21:39:48 tom Exp @
+-->
+<HTML>
+<HEAD>
+<TITLE>form_variables 3x</TITLE>
+<link rev=made href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
+<BODY>
+<H1>form_variables 3x</H1>
+<HR>
+<PRE>
+<!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG> <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG>
+
+
+
+
+</PRE>
+<H2>NAME</H2><PRE>
+ TYPE_ALNUM TYPE_ALPHA TYPE_ENUM TYPE_INTEGER TYPE_IPV4
+ TYPE_NUMERIC TYPE_REGEXP - form system global variables
+
+
+</PRE>
+<H2>SYNOPSIS</H2><PRE>
+ <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
+
+ <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_ALNUM;</STRONG>
+ <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_ALPHA;</STRONG>
+ <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_ENUM;</STRONG>
+ <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_INTEGER;</STRONG>
+ <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_IPV4;</STRONG>
+ <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_NUMERIC;</STRONG>
+ <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_REGEXP;</STRONG>
+
+
+</PRE>
+<H2>DESCRIPTION</H2><PRE>
+ These are building blocks for the form library, defining
+ fields that can be created using <STRONG><A HREF="set_fieldtype.3x.html">set_fieldtype(3x)</A></STRONG>. Each
+ provides functions for field- and character-validation,
+ according to the given datatype.
+
+ <STRONG>TYPE_ALNUM</STRONG>
+ This holds alphanumeric data.
+
+ <STRONG>TYPE_ALPHA</STRONG>
+ This holds alphabetic data.
+
+ <STRONG>TYPE_ENUM</STRONG>
+ This holds an enumerated type.
+
+ <STRONG>TYPE_INTEGER</STRONG>
+ This holds a decimal integer.
+
+ <STRONG>TYPE_IPV4</STRONG>
+ This holds an IPv4 internet address, e.g., "127.0.0.1".
+
+ <STRONG>TYPE_NUMERIC</STRONG>
+ This holds a decimal number, with optional sign and deci-
+ mal point.
+
+ <STRONG>TYPE_REGEXP</STRONG>
+ This holds a regular expression.
+
+
+</PRE>
+<H2>PORTABILITY</H2><PRE>
+ The <STRONG>TYPE_IPV4</STRONG> variable is an extension not provided by
+ older implementations of the form library.
+
+
+</PRE>
+<H2>SEE ALSO</H2><PRE>
+ <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
+
+
+
+ <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG>
+</PRE>
+<HR>
+<ADDRESS>
+Man(1) output converted with
+<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
+</ADDRESS>
+</BODY>
+</HTML>
<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>.
- This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100731).
+ This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100918).
</PRE>
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: infotocap.1m,v 1.9 2010/07/31 16:08:48 tom Exp @
+ * @Id: infotocap.1m,v 1.10 2010/08/28 19:40:02 tom Exp @
-->
<HTML>
<HEAD>
</PRE>
<H2>DESCRIPTION</H2><PRE>
- <STRONG>infotocap</STRONG> looks in <EM>file</EM> for <STRONG>terminfo</STRONG> descriptions. For
- each one found, an equivalent <STRONG>termcap</STRONG> description is writ-
- ten to standard output. Terminfo <STRONG>use</STRONG> capabilities are
- translated directly to termcap <STRONG>tc</STRONG> capabilities.
+ <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-
+ put. Terminfo <STRONG>use</STRONG> capabilities are translated directly to
+ termcap <STRONG>tc</STRONG> capabilities.
- <STRONG>-v</STRONG> print out tracing information on standard error as
+ <STRONG>-v</STRONG> print out tracing information on standard error as
the program runs.
- <STRONG>-V</STRONG> print out the version of the program in use on stan-
+ <STRONG>-V</STRONG> print out the version of the program in use on stan-
dard error and exit.
- <STRONG>-1</STRONG> cause the fields to print out one to a line. Other-
+ <STRONG>-1</STRONG> cause the fields to print out one to a line. Other-
wise, the fields will be printed several to a line to
a maximum width of 60 characters.
</PRE>
<H2>NOTES</H2><PRE>
- This utility is actually a link to <EM>tic</EM>, running in <EM>-C</EM>
+ 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>.
<H2>SEE ALSO</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 5.7 (patch 20100731).
+ This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100918).
+
+
+</PRE>
+<H2>AUTHOR</H2><PRE>
+ Eric S. Raymond <esr@snark.thyrsus.com> and
+ Thomas E. Dickey <dickey@invisible-island.net>
</PRE>
<H2>SEE ALSO</H2><PRE>
- This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100731).
+ This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100918).
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: menu_driver.3x,v 1.17 2010/07/31 15:16:18 tom Exp @
+ * @Id: menu_driver.3x,v 1.18 2010/09/18 20:20:39 tom Exp @
-->
<HTML>
<HEAD>
input events to it through <STRONG>menu_driver</STRONG>. This routine has
three major input cases:
- - The input is a form navigation request. Navigation
- request codes are constants defined in <STRONG><form.h></STRONG>, which
- are distinct from the key- and character codes returned
- by <STRONG>wgetch</STRONG>.
+ <STRONG>o</STRONG> The input is a form navigation request. Navigation
+ request codes are constants defined in <STRONG><form.h></STRONG>, which
+ are distinct from the key- and character codes
+ returned by <STRONG>wgetch</STRONG>.
- - The input is a printable character. Printable charac-
- ters (which must be positive, less than 256) are
- checked according to the program's locale settings.
+ <STRONG>o</STRONG> The input is a printable character. Printable charac-
+ ters (which must be positive, less than 256) are
+ checked according to the program's locale settings.
- - The input is the KEY_MOUSE special key associated with
- an mouse event.
+ <STRONG>o</STRONG> The input is the KEY_MOUSE special key associated with
+ an mouse event.
The menu driver requests are as follows:
If you click above the display region of the menu:
- a REQ_SCR_ULINE is generated for a single click,
+ <STRONG>o</STRONG> a REQ_SCR_ULINE is generated for a single click,
- a REQ_SCR_UPAGE is generated for a double-click and
+ <STRONG>o</STRONG> a REQ_SCR_UPAGE is generated for a double-click and
- a REQ_FIRST_ITEM is generated for a triple-click.
+ <STRONG>o</STRONG> a REQ_FIRST_ITEM is generated for a triple-click.
If you click below the display region of the menu:
- a REQ_SCR_DLINE is generated for a single click,
+ <STRONG>o</STRONG> a REQ_SCR_DLINE is generated for a single click,
- a REQ_SCR_DPAGE is generated for a double-click and
+ <STRONG>o</STRONG> a REQ_SCR_DPAGE is generated for a double-click and
- a REQ_LAST_ITEM is generated for a triple-click.
+ <STRONG>o</STRONG> a REQ_LAST_ITEM is generated for a triple-click.
If you click at an item inside the display area of the
menu:
- - the menu cursor is positioned to that item.
+ <STRONG>o</STRONG> the menu cursor is positioned to that item.
- - If you double-click an item a REQ_TOGGLE_ITEM is
- generated and <STRONG>E_UNKNOWN_COMMAND</STRONG> is returned.
- This return value makes sense, because a double
- click usually means that an item-specific action
- should be returned. It is exactly the purpose
- of this return value to signal that an applica-
- tion specific command should be executed.
+ <STRONG>o</STRONG> If you double-click an item a REQ_TOGGLE_ITEM is gen-
+ erated and <STRONG>E_UNKNOWN_COMMAND</STRONG> is returned. This return
+ value makes sense, because a double click usually
+ means that an item-specific action should be returned.
+ It is exactly the purpose of this return value to sig-
+ nal that an application specific command should be
+ executed.
- - If a translation into a request was done,
- <STRONG>menu_driver</STRONG> returns the result of this request.
+ <STRONG>o</STRONG> If a translation into a request was done, <STRONG>menu_driver</STRONG>
+ returns the result of this request.
If you clicked outside the user window or the mouse event
could not be translated into a menu request an
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: ncurses.3x,v 1.96 2010/07/31 15:55:04 tom Exp @
+ * @Id: ncurses.3x,v 1.98 2010/09/18 20:17:20 tom Exp @
-->
<HTML>
<HEAD>
sonable optimization. This implementation is ``new
curses'' (ncurses) and is the approved replacement for
4.4BSD classic curses, which has been discontinued. This
- describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100731).
+ describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100918).
The <STRONG>ncurses</STRONG> library emulates the curses library of System
V Release 4 UNIX, and XPG4 (X/Open Portability Guide)
ncursesw
the so-called "wide" library, which handles
- multibyte characters (See the section on
+ multibyte characters (see the section on
<STRONG>ALTERNATE</STRONG> <STRONG>CONFIGURATIONS</STRONG>). The "wide" library
includes all of the calls from the "normal"
library. It adds about one third more calls
not the only way to change the list of directories.
The complete list of directories in order follows:
- - the last directory to which <STRONG>ncurses</STRONG> wrote, if any,
- is searched first
+ <STRONG>o</STRONG> the last directory to which <STRONG>ncurses</STRONG> wrote, if
+ any, is searched first
- - the directory specified by the TERMINFO symbol
+ <STRONG>o</STRONG> the directory specified by the TERMINFO symbol
- - $HOME/.terminfo
+ <STRONG>o</STRONG> $HOME/.terminfo
- - directories listed in the TERMINFO_DIRS symbol
+ <STRONG>o</STRONG> directories listed in the TERMINFO_DIRS symbol
- - one or more directories whose names are configured
- and compiled into the ncurses library, e.g.,
- /usr/share/terminfo
+ <STRONG>o</STRONG> one or more directories whose names are config-
+ ured and compiled into the ncurses library, e.g.,
+ /usr/share/terminfo
TERMINFO_DIRS
Specifies a list of directories to search for termi-
<H2>SEE ALSO</H2><PRE>
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
- This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100731).
+ This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100918).
<H2>SEE ALSO</H2><PRE>
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
- This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100731).
+ This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100918).
</PRE>
<H2>SEE ALSO</H2><PRE>
<STRONG><A HREF="tset.1.html">tset(1)</A></STRONG>, <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 5.7 (patch 20100731).
+ This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100918).
--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<!--
+ ****************************************************************************
+ * Copyright (c) 2010 Free Software Foundation, Inc. *
+ * *
+ * Permission is hereby granted, free of charge, to any person obtaining a *
+ * copy of this software and associated documentation files (the *
+ * "Software"), to deal in the Software without restriction, including *
+ * without limitation the rights to use, copy, modify, merge, publish, *
+ * distribute, distribute with modifications, sublicense, and/or sell *
+ * copies of the Software, and to permit persons to whom the Software is *
+ * furnished to do so, subject to the following conditions: *
+ * *
+ * The above copyright notice and this permission notice shall be included *
+ * in all copies or substantial portions of the Software. *
+ * *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+ * *
+ * Except as contained in this notice, the name(s) of the above copyright *
+ * holders shall not be used in advertising or otherwise to promote the *
+ * sale, use or other dealings in this Software without prior written *
+ * authorization. *
+ ****************************************************************************
+ * @Id: term_variables.3x,v 1.1 2010/09/11 21:01:44 tom Exp @
+-->
+<HTML>
+<HEAD>
+<TITLE>term_variables 3x</TITLE>
+<link rev=made href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
+<BODY>
+<H1>term_variables 3x</H1>
+<HR>
+<PRE>
+<!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG> <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>
+
+
+
+
+</PRE>
+<H2>NAME</H2><PRE>
+ <STRONG>SP</STRONG>, <STRONG>acs_map</STRONG>, <STRONG>boolcodes</STRONG>, <STRONG>boolfnames</STRONG>, <STRONG>boolnames</STRONG>, <STRONG>cur_term</STRONG>,
+ <STRONG>numcodes</STRONG>, <STRONG>numfnames</STRONG>, <STRONG>numnames</STRONG>, <STRONG>strcodes</STRONG>, <STRONG>strfnames</STRONG>,
+ <STRONG>strnames</STRONG>, <STRONG>ttytype</STRONG> - <STRONG>curses</STRONG> terminfo global variables
+
+
+</PRE>
+<H2>SYNOPSIS</H2><PRE>
+ <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
+ <STRONG>#include</STRONG> <STRONG><term.h></STRONG>
+
+ <STRONG>chtype</STRONG> <STRONG>acs_map[];</STRONG>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>boolcodes;</STRONG>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>boolfnames;</STRONG>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>boolnames;</STRONG>
+ <STRONG>TERMINAL</STRONG> <STRONG>*</STRONG> <STRONG>cur_term;</STRONG>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>numcodes;</STRONG>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>numfnames;</STRONG>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>numnames;</STRONG>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>strcodes;</STRONG>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>strfnames;</STRONG>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>strnames;</STRONG>
+ <STRONG>char</STRONG> <STRONG>ttytype[];</STRONG>
+
+
+</PRE>
+<H2>DESCRIPTION</H2><PRE>
+ This page summarizes variables provided by the <STRONG>curses</STRONG> li-
+ brary's low-level terminfo interface. A more complete de-
+ scription is given in the <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> manual page.
+
+ Depending on the configuration, these may be actual vari-
+ ables, or macros (see <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>) which provide
+ read-only access to <EM>curses</EM>'s state. In either case, ap-
+ plications should treat them as read-only to avoid confus-
+ ing the library.
+
+ <STRONG>Alternate</STRONG> <STRONG>Character</STRONG> <STRONG>Set</STRONG> <STRONG>Mapping</STRONG>
+ After initializing the curses or terminfo interfaces, the
+ <STRONG>acs_map</STRONG> array holds information used to translate cells
+ with the <STRONG>A_ALTCHARSET</STRONG> video attribute into line-drawing
+ characters.
+
+ The encoding of the information in this array has changed
+ periodically. Application developers need only know that
+ it is used for the "ACS_" constants in <curses.h>.
+
+ The comparable data for the wide-character library is a
+ private variable.
+
+ <STRONG>Current</STRONG> <STRONG>Terminal</STRONG> <STRONG>Data</STRONG>
+ After initializing the curses or terminfo interfaces, the
+ <STRONG>cur_term</STRONG> contains data describing the current terminal.
+ This variable is also set as a side-effect of <STRONG><A HREF="set_term.3x.html">set_term(3x)</A></STRONG>
+ and <STRONG><A HREF="delscreen.3x.html">delscreen(3x)</A></STRONG>.
+
+ It is possible to save a value of <STRONG>cur_term</STRONG> for subsequent
+ use as a parameter to <STRONG>set_term</STRONG>, for switching between
+ screens. Alternatively, one can save the return value
+ from <STRONG>newterm</STRONG> or <STRONG>setupterm</STRONG> to reuse in <STRONG>set_term</STRONG>.
+
+ <STRONG>Terminfo</STRONG> <STRONG>Names</STRONG>
+ The <STRONG><A HREF="tic.1.html">tic(1)</A></STRONG> and <STRONG><A HREF="infocmp.1.html">infocmp(1)</A></STRONG> programs use lookup tables for
+ the long and short names of terminfo capabilities, as well
+ as the corresponding names for termcap capabilities.
+ These are available to other applications, though the
+ hash-tables are not available.
+
+ The long terminfo capability names use a "l" (ell) in
+ their names: boolfnames numfnames strfnames
+
+ These are the short names for terminfo capabilities: bool-
+ names, numnames, and strnames.
+
+ These are the corresponding names used for termcap de-
+ scriptions: boolcodes, numcodes, and strcodes.
+
+ <STRONG>Terminal</STRONG> <STRONG>Type</STRONG>
+ On initialization of the curses or terminfo interfaces,
+ <STRONG>setupterm</STRONG> copies the terminal name to the array <STRONG>ttytype</STRONG>.
+
+
+</PRE>
+<H2>NOTES</H2><PRE>
+ The low-level terminfo interface is initialized using <STRONG>se-</STRONG>
+ <STRONG><A HREF="setupterm.3x.html">tupterm(3x)</A></STRONG>. The upper-level curses interface uses the
+ low-level terminfo interface, internally.
+
+
+</PRE>
+<H2>PORTABILITY</H2><PRE>
+ X/Open Curses does not describe any of these except for
+ <STRONG>cur_term</STRONG>. (The inclusion of <STRONG>cur_term</STRONG> appears to be an
+ oversight, since other comparable low-level information is
+ omitted by X/Open).
+
+ Other implementations may have comparable variables. Some
+ implementations provide the variables in their libraries,
+ but omit them from the header files.
+
+
+</PRE>
+<H2>SEE ALSO</H2><PRE>
+ <STRONG><A HREF="ncurses.3x.html">curses(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>termin-</STRONG>
+ <STRONG><A HREF="terminfo.3x.html">fo(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>
+</PRE>
+<HR>
+<ADDRESS>
+Man(1) output converted with
+<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
+</ADDRESS>
+</BODY>
+</HTML>
nals by giving a set of capabilities which they have, by
specifying how to perform screen operations, and by speci-
fying padding requirements and initialization sequences.
- This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100731).
+ This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100918).
Entries in <EM>terminfo</EM> consist of a sequence of `,' separated
fields (embedded commas may be escaped with a backslash or
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: tic.1m,v 1.45 2010/07/31 16:08:48 tom Exp @
+ * @Id: tic.1m,v 1.46 2010/08/28 19:41:09 tom Exp @
-->
<HTML>
<HEAD>
<STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>, <STRONG><A HREF="infotocap.1m.html">infotocap(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>.
- This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100731).
+ This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100918).
+
+
+</PRE>
+<H2>AUTHOR</H2><PRE>
+ Eric S. Raymond <esr@snark.thyrsus.com> and
+ Thomas E. Dickey <dickey@invisible-island.net>
<STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>, <STRONG><A HREF="infotocap.1m.html">infotocap(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 5.7 (patch 20100731).
+ This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100918).
<H2>SEE ALSO</H2><PRE>
<STRONG><A HREF="clear.1.html">clear(1)</A></STRONG>, <STRONG><A HREF="stty.1.html">stty(1)</A></STRONG>, <STRONG><A HREF="tabs.1.html">tabs(1)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
- This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100731).
+ This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100918).
<STRONG><A HREF="csh.1.html">csh(1)</A></STRONG>, <STRONG><A HREF="sh.1.html">sh(1)</A></STRONG>, <STRONG><A HREF="stty.1.html">stty(1)</A></STRONG>, <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>, <STRONG><A HREF="tty.4.html">tty(4)</A></STRONG>, ter-
<STRONG><A HREF="minfo.5.html">minfo(5)</A></STRONG>, <STRONG><A HREF="ttys.5.html">ttys(5)</A></STRONG>, <STRONG><A HREF="environ.7.html">environ(7)</A></STRONG>
- This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100731).
+ This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100918).
* authorization. *
****************************************************************************
* Author: Thomas E. Dickey 1996
- * @Id: wresize.3x,v 1.11 2010/07/31 15:30:32 tom Exp @
+ * @Id: wresize.3x,v 1.12 2010/08/14 23:12:04 Tim.van.der.Molen Exp @
-->
<HTML>
<HEAD>
</PRE>
<H2>DESCRIPTION</H2><PRE>
- The <STRONG>wresize</STRONG> function reallocates storage for an <STRONG>ncurses</STRONG>
- window to adjust its dimensions to the specified values.
- If either dimension is larger than the current values, the
- window's data is filled with blanks that have the current
- background rendition (as set by <STRONG>wbkgdset</STRONG>) merged into
- them.
+ This is an extension to the curses library. It reallo-
+ cates storage for an <STRONG>ncurses</STRONG> window to adjust its dimen-
+ sions to the specified values. If either dimension is
+ larger than the current values, the window's data is
+ filled with blanks that have the current background rendi-
+ tion (as set by <STRONG>wbkgdset</STRONG>) merged into them.
</PRE>
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_add_wch.3x,v 1.8 2010/08/14 23:29:16 tom Exp $
+.\" $Id: curs_add_wch.3x,v 1.9 2010/09/18 20:18:34 tom Exp $
.TH curs_add_wch 3X ""
+.de bP
+.IP \(bu 4
+..
.SH NAME
\fBadd_wch\fP,
\fBwadd_wch\fP,
which is then advanced.
These functions perform
wrapping and special-character processing as follows:
-.TP 5
-\-
+.bP
If \fIwch\fP refers to a spacing character,
then any previous character at that location is removed.
A new character specified by \fIwch\fP is
placed at that location with rendition specified by \fIwch\fP.
The cursor then advances to
the next spacing character on the screen.
-.TP 5
-\-
+.bP
If \fIwch\fP refers to a non-spacing character,
all previous characters at that location are preserved.
The non-spacing characters of \fIwch\fP
are added to the spacing complex character,
and the rendition specified by \fIwch\fP is ignored.
-.TP 5
-\-
+.bP
If the character part of \fIwch\fP is
a tab, newline, backspace or other control character,
the window is updated and the cursor moves as if \fBaddch\fR were called.
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_color.3x,v 1.31 2010/08/14 23:11:23 Tim.van.der.Molen Exp $
+.\" $Id: curs_color.3x,v 1.32 2010/09/18 20:27:38 tom Exp $
.TH curs_color 3X ""
+.de bP
+.IP \(bu 4
+..
.na
.hy 0
.SH NAME
.hy
.SH SYNOPSIS
\fB# include <curses.h>\fR
-.br
+.sp
\fBint start_color(void);\fR
.br
\fBint init_pair(short pair, short f, short b);\fR
three arguments: the number of the color-pair to be changed, the foreground
color number, and the background color number.
For portable applications:
-.TP 5
-\-
+.bP
The value of the first argument
must be between \fB1\fR and \fBCOLOR_PAIRS\-1\fR,
except that if default colors are used (see \fBuse_default_colors\fP)
the upper limit is adjusted to allow for extra pairs which use
a default color in foreground and/or background.
-.TP 5
-\-
+.bP
The value of the second and
third arguments must be between 0 and \fBCOLORS\fR.
Color pair 0 is assumed to be white on black,
if the terminal has not been initialized.
An error is returned from secondary functions such as \fBinit_pair\fP
if \fBstart_color\fP was not called.
-.RS
+.RS 3
.TP 5
\fBinit_color\fP
returns an error if the terminal does not support
scrolling operations, see \fBcurs_bkgd\fR(3X).
.PP
Several caveats apply on 386 and 486 machines with VGA-compatible graphics:
-.TP 5
-\-
+.bP
COLOR_YELLOW is actually brown. To get yellow, use COLOR_YELLOW combined with
the \fBA_BOLD\fR attribute.
-.TP 5
-\-
+.bP
The A_BLINK attribute should in theory cause the background to go bright. This
often fails to work, and even some cards for which it mostly works (such as the
Paradise and compatibles) do the wrong thing when you try to set a bright
"yellow" background (you get a blinking yellow foreground instead).
-.TP 5
-\-
+.bP
Color RGB values are not settable.
.SH PORTABILITY
This implementation satisfies XSI Curses's minimum maximums
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_getcchar.3x,v 1.13 2010/07/31 16:12:01 tom Exp $
+.\" $Id: curs_getcchar.3x,v 1.14 2010/09/18 20:26:21 tom Exp $
.TH curs_getcchar 3X ""
+.de bP
+.IP \(bu 4
+..
.SH NAME
\fBgetcchar\fP,
\fBsetcchar\fP \- Get a wide character string and rendition from a \fBcchar_t\fP or set a \fBcchar_t\fP from a wide-character string
and rendition from a \fBcchar_t\fP argument.
When \fIwch\fP is not a null pointer,
the \fBgetcchar\fP function does the following:
-.TP 5
-\-
+.bP
Extracts information from a \fBcchar_t\fP value \fIwcval\fP
-.TP 5
-\-
+.bP
Stores the character attributes in the location pointed to by \fIattrs\fP
-.TP 5
-\-
+.bP
Stores the color-pair in the location pointed to by \fIcolor_pair\fP
-.TP 5
-\-
+.bP
Stores the wide-character string,
characters referenced by \fIwcval\fP, into the array pointed to by \fIwch\fP.
.PP
is a null pointer, the
\fBgetcchar\fP
function does the following:
-.TP 5
-\-
+.bP
Obtains the number of wide characters pointed to by \fIwcval\fP
-.TP 5
-\-
+.bP
Does not change the data referenced by
\fIattrs\fP
or
.PP
The \fBsetcchar\fP function initializes the location pointed to by \fIwcval\fP
by using:
-.TP 5
-\-
+.bP
The character attributes in
\fIattrs\fP
-.TP 5
-\-
+.bP
The color pair in
\fIcolor_pair\fP
-.TP 5
-\-
+.bP
The wide-character string pointed to by \fIwch\fP.
The string must be L'\\0' terminated,
contain at most one spacing character,
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_legacy.3x,v 1.3 2010/09/11 22:21:52 tom Exp $
+.\" $Id: curs_legacy.3x,v 1.4 2010/09/18 22:31:47 tom Exp $
.TH curs_legacy 3X ""
.SH NAME
-get \fBcurses\fR cursor and window coordinates, attributes
+getattrs \- get \fBcurses\fR cursor and window coordinates, attributes
.SH SYNOPSIS
\fB#include <curses.h>\fR
.sp
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_slk.3x,v 1.19 2010/09/11 22:35:11 tom Exp $
+.\" $Id: curs_slk.3x,v 1.20 2010/09/18 22:38:29 tom Exp $
.TH curs_slk 3X ""
.na
.hy 0
.br
\fBint slk_attr_off(const attr_t attrs, void * opts);\fR
.br
-\fBint slk_attr_set(const attr_t attrs,\fR
-.br
- \fBshort color_pair_number, void* opts);\fR
+\fBint slk_attr_set(const attr_t attrs, short color_pair, void* opts);\fR
.br
\fBattr_t slk_attr(void);\fR
.br
-\fBint slk_color(short color_pair_number);\fR
+\fBint slk_color(short color_pair);\fR
.br
-\fBint slk_wset (int labnum, const wchar_t *label, int fmt);\fR
+\fBint slk_wset(int labnum, const wchar_t *label, int fmt);\fR
.br
.SH DESCRIPTION
The slk* functions manipulate the set of soft function-key labels that exist on
--- /dev/null
+.\"***************************************************************************
+.\" Copyright (c) 2010 Free Software Foundation, Inc. *
+.\" *
+.\" Permission is hereby granted, free of charge, to any person obtaining a *
+.\" copy of this software and associated documentation files (the *
+.\" "Software"), to deal in the Software without restriction, including *
+.\" without limitation the rights to use, copy, modify, merge, publish, *
+.\" distribute, distribute with modifications, sublicense, and/or sell *
+.\" copies of the Software, and to permit persons to whom the Software is *
+.\" furnished to do so, subject to the following conditions: *
+.\" *
+.\" The above copyright notice and this permission notice shall be included *
+.\" in all copies or substantial portions of the Software. *
+.\" *
+.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+.\" *
+.\" Except as contained in this notice, the name(s) of the above copyright *
+.\" holders shall not be used in advertising or otherwise to promote the *
+.\" sale, use or other dealings in this Software without prior written *
+.\" authorization. *
+.\"***************************************************************************
+.\"
+.\" $Id: curs_sp_funcs.3x,v 1.4 2010/09/18 20:07:36 tom Exp $
+.TH curs_sp_funcs 3X ""
+.na
+.hy 0
+.SH NAME
+new_prescr \- \fBcurses\fR screen-pointer extension
+.ad
+.hy
+.SH SYNOPSIS
+\fB#include <curses.h>\fR
+.nf
+.sp
+\fBint assume_default_colors_sp(SCREEN*, int, int);\fR
+.br
+\fBint baudrate_sp(SCREEN*);\fR
+.br
+\fBint beep_sp(SCREEN*);\fR
+.br
+\fBbool can_change_color_sp(SCREEN*);\fR
+.br
+\fBint cbreak_sp(SCREEN*);\fR
+.br
+\fBint color_content_sp(SCREEN*, short, short*, short*, short*);\fR
+.br
+\fBint curs_set_sp(SCREEN*, int);\fR
+.br
+\fBint define_key_sp(SCREEN*, const char *, int);\fR
+.br
+\fBint def_prog_mode_sp(SCREEN*);\fR
+.br
+\fBint def_shell_mode_sp(SCREEN*);\fR
+.br
+\fBint delay_output_sp(SCREEN*, int);\fR
+.br
+\fBint doupdate_sp(SCREEN*);\fR
+.br
+\fBint echo_sp(SCREEN*);\fR
+.br
+\fBint endwin_sp(SCREEN*);\fR
+.br
+\fBint erasechar_sp(SCREEN*);\fR
+.br
+\fBint filter_sp(SCREEN*);\fR
+.br
+\fBint flash_sp(SCREEN*);\fR
+.br
+\fBint flushinp_sp(SCREEN*);\fR
+.br
+\fBint get_escdelay_sp(SCREEN*);\fR
+.br
+\fBint getmouse_sp(SCREEN*, MEVENT*);\fR
+.br
+\fBWINDOW* getwin_sp(SCREEN*, FILE*);\fR
+.br
+\fBint halfdelay_sp(SCREEN*);\fR
+.br
+\fBbool has_colors_sp(SCREEN*);\fR
+.br
+\fBbool has_ic_sp(SCREEN*);\fR
+.br
+\fBbool has_il_sp(SCREEN*);\fR
+.br
+\fBint has_key_sp(SCREEN*, int);\fR
+.br
+\fBbool has_mouse_sp(SCREEN*);\fR
+.br
+\fBint init_color_sp(SCREEN*, short, short, short, short);\fR
+.br
+\fBint init_pair_sp(SCREEN*, short, short, short);\fR
+.br
+\fBint intrflush_sp(SCREEN*, WINDOW*, bool);\fR
+.br
+\fBbool isendwin_sp(SCREEN*);\fR
+.br
+\fBbool is_term_resized_sp(SCREEN*, int, int);\fR
+.br
+\fBchar* keybound_sp(SCREEN*, int, int);\fR
+.br
+\fBint key_defined_sp(SCREEN*, const char *);\fR
+.br
+\fBNCURSES_CONST char * keyname_sp(SCREEN*, int);\fR
+.br
+\fBint keyok_sp(SCREEN*, int, bool);\fR
+.br
+\fBchar killchar_sp(SCREEN*);\fR
+.br
+\fBint mcprint_sp(SCREEN*, char *, int);\fR
+.br
+\fBint mouseinterval_sp(SCREEN*, int);\fR
+.br
+\fBmmask_t mousemask_sp(SCREEN*, mmask_t, mmask_t *);\fR
+.br
+\fBint mvcur_sp(SCREEN*, int, int, int, int);\fR
+.br
+\fBint napms_sp(SCREEN*, int);\fR
+.br
+\fBWINDOW* newpad_sp(SCREEN*, int, int);\fR
+.br
+\fBSCREEN* new_prescr(void);\fR
+.br
+\fBSCREEN* newterm_sp(SCREEN*, NCURSES_CONST char *, FILE *, FILE *);\fR
+.br
+\fBWINDOW* newwin_sp(SCREEN*, int, int, int, int);\fR
+.br
+\fBint nl_sp(SCREEN*);\fR
+.br
+\fBint nocbreak_sp(SCREEN*);\fR
+.br
+\fBint noecho_sp(SCREEN*);\fR
+.br
+\fBint nofilter_sp(SCREEN*);\fR
+.br
+\fBint nonl_sp(SCREEN*);\fR
+.br
+\fBvoid noqiflush_sp(SCREEN*);\fR
+.br
+\fBint noraw_sp(SCREEN*);\fR
+.br
+\fBint pair_content_sp(SCREEN*, short, short*, short*);\fR
+.br
+\fBvoid qiflush_sp(SCREEN*);\fR
+.br
+\fBint raw_sp(SCREEN*);\fR
+.br
+\fBint reset_prog_mode_sp(SCREEN*);\fR
+.br
+\fBint reset_shell_mode_sp(SCREEN*);\fR
+.br
+\fBint resetty_sp(SCREEN*);\fR
+.br
+\fBint resize_term_sp(SCREEN*, int, int);\fR
+.br
+\fBint resizeterm_sp(SCREEN*, int, int);\fR
+.br
+\fBint restartterm_sp(SCREEN*, NCURSES_CONST char*, int, int *);\fR
+.br
+\fBint ripoffline_sp(SCREEN*, int, int (*)(WINDOW*, int));\fR
+.br
+\fBint savetty_sp(SCREEN*);\fR
+.br
+\fBint scr_init_sp(SCREEN*, const char *);\fR
+.br
+\fBint scr_restore_sp(SCREEN*, const char *);\fR
+.br
+\fBint scr_set_sp(SCREEN*, const char *);\fR
+.br
+\fBTERMINAL* set_curterm_sp(SCREEN*, TERMINAL*);\fR
+.br
+\fBint set_escdelay_sp(SCREEN*, int);\fR
+.br
+\fBint set_tabsize_sp(SCREEN*, int);\fR
+.br
+\fBint slk_attroff_sp(SCREEN*, const chtype);\fR
+.br
+\fBint slk_attron_sp(SCREEN*, const chtype);\fR
+.br
+\fBint slk_attr_set_sp(SCREEN*, const attr_t, short, void*);\fR
+.br
+\fBint slk_attrset_sp(SCREEN*, const chtype);\fR
+.br
+\fBint slk_attr_sp((SCREEN*);\fR
+.br
+\fBint slk_clear_sp(SCREEN*);\fR
+.br
+\fBint slk_color_sp(SCREEN*, short);\fR
+.br
+\fBint slk_init_sp(SCREEN*, int);\fR
+.br
+\fBint slk_label_sp(SCREEN*, int);\fR
+.br
+\fBint slk_noutrefresh_sp(SCREEN*);\fR
+.br
+\fBint slk_refresh_sp(SCREEN*);\fR
+.br
+\fBint slk_restore_sp(SCREEN*);\fR
+.br
+\fBint slk_set_sp(SCREEN*, int, const char *, int);\fR
+.br
+\fBint slk_touch_sp(SCREEN*);\fR
+.br
+\fBint start_color_sp(SCREEN*);\fR
+.br
+\fBattr_t term_attrs_sp(SCREEN*);\fR
+.br
+\fBchtype termattrs_sp(SCREEN*);\fR
+.br
+\fBchar* termname_sp(SCREEN*);\fR
+.br
+\fBint typeahead_sp(SCREEN*, int);\fR
+.br
+\fBNCURSES_CONST char* unctrl_sp(SCREEN*, chtype);\fR
+.br
+\fBint ungetch_sp(SCREEN*, int);\fR
+.br
+\fBint ungetmouse_sp(SCREEN*,MEVENT *);\fR
+.br
+\fBint unget_wch_sp(SCREEN*, const wchar_t);\fR
+.br
+\fBint use_default_colors_sp(SCREEN*);\fR
+.br
+\fBvoid use_env_sp(SCREEN*, bool);\fR
+.br
+\fBint use_legacy_coding_sp(SCREEN*, int);\fR
+.br
+\fBint vid_attr_sp(SCREEN*, attr_t, short, void *);\fR
+.br
+\fBint vidattr_sp(SCREEN*, chtype);\fR
+.br
+\fBint vid_puts_sp(SCREEN*, attr_t, short, void *, NCURSES_SP_OUTC);\fR
+.br
+\fBint vidputs_sp(SCREEN*, chtype, NCURSES_SP_OUTC);\fR
+.br
+\fBwchar_t* wunctrl_sp(SCREEN*, cchar_t *);\fR
+.sp
+\fB#include <form.h>\fR
+.sp
+\fBint new_form_sp(SCREEN*, FIELD **);\fR
+.sp
+\fB#include <menu.h>\fR
+.sp
+\fBint new_menu_sp(SCREEN*, ITEM **);\fR
+.sp
+\fB#include <panel.h>\fR
+.sp
+\fBint ceiling_panel(SCREEN*);\fR
+.br
+\fBPANEL* ground_panel(SCREEN*);\fR
+.br
+\fBint update_panels_sp(SCREEN*);\fR
+.sp
+\fB#include <term.h>\fR
+.sp
+\fBint del_curterm_sp(SCREEN*, TERMINAL *);\fR
+.br
+\fBint putp_sp(SCREEN*, const char *);\fR
+.br
+\fBint tgetflag_sp(SCREEN*, char *, const char *);\fR
+.br
+\fBint tgetent_sp(SCREEN*, char *, const char *);\fR
+.br
+\fBint tgetnum_sp(SCREEN*, NCURSES_CONST char *);\fR
+.br
+\fBchar* tgetstr_sp(SCREEN*, NCURSES_CONST char *, char **);\fR
+.br
+\fBint tigetflag_sp(SCREEN*, NCURSES_CONST char *);\fR
+.br
+\fBint tigetnum_sp(SCREEN*, NCURSES_CONST char *);\fR
+.br
+\fBchar* tigetstr_sp(SCREEN*, NCURSES_CONST char *);\fR
+.br
+\fBint tputs_sp(SCREEN*, const char *, int, NCURSES_SP_OUTC);\fR
+.ad
+.br
+.SH DESCRIPTION
+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 configurations supported by ncurses;
+it adds new entrypoints
+without changing the meaning of any of the existing ones.
+.PP
+.\" ***************************************************************************
+.SS IMPROVED FUNCTIONS
+Most of the functions are new versions of existing functions.
+A parameter is added at the front of the parameter list.
+It is a SCREEN pointer.
+.PP
+The existing functions all use the current screen,
+which is a static variable.
+The extended functions use the specified screen,
+thereby reducing the number of variables which must be modified
+to update multiple screens.
+.\" ***************************************************************************
+.SS NEW FUNCTIONS
+Here are the new functions:
+.TP 5
+ceiling_panel
+this returns a pointer to the topmost panel in the given screen.
+.TP 5
+ground_panel
+this returns a pointer to the lowest panel in the given screen.
+.TP 5
+new_prescr
+when creating a new screen, the library uses static variables which
+have been preset, e.g., by \fBuse_env\fP(3X), \fBfilter\fP(3X), etc.
+With the screen-pointer extension,
+there are situations where it must create a current screen before
+the unextended library does.
+The \fBnew_prescr\fP function is used internally to handle these cases.
+It is also provided as an entrypoint to allow applications to customize
+the library initialization.
+.\" ***************************************************************************
+.SH NOTES
+This extension introduces some new names:
+.TP 5
+NCURSES_SP_FUNCS
+This is set to the library patch-level number.
+In the unextended library, this is zero (0),
+to make it useful for checking if the extension is provided.
+.TP 5
+NCURSES_SP_NAME
+The new functions are named using the macro \fINCURSES_SP_NAME\fP,
+which hides the actual implementation.
+Currently this adds a "_sp" suffix to the name of the unextended function.
+This manual page indexes the extensions showing the full name.
+However the proper usage of these functions uses the macro,
+to provide for the possibility of changing the naming convention
+for specific library configurations.
+.TP 5
+NCURSES_SP_OUTC
+This is a new function-pointer type to use in the screen-pointer functions
+where an \fINCURSES_OUTC\fP is used in the unextended library.
+.TP 5
+NCURSES_OUTC
+This is a function-pointer type used for the cases where a function passes
+characters to the output stream, e.g., \fBvidputs\fP(3X).
+.PP
+.SH PORTABILITY
+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 extensions
+be conditioned using \fINCURSES_SP_FUNCS\fP.
+.SH SEE ALSO
+\fBcurses\fR(3X),
+\fBcurs_opaque\fR(3X),
+\fBcurs_threads\fR(3X).
+.\"#
+.\"# The following sets edit modes for GNU EMACS
+.\"# Local Variables:
+.\"# mode:nroff
+.\"# fill-column:79
+.\"# End:
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_threads.3x,v 1.15 2010/09/11 22:17:11 tom Exp $
+.\" $Id: curs_threads.3x,v 1.16 2010/09/18 20:25:32 tom Exp $
.TH curs_threads 3X ""
+.de bP
+.IP \(bu 4
+..
.na
.hy 0
.SH NAME
altered during operation.
In addition,
they use data which is maintained within a hierarchy of scopes.
-.RS
-.TP 3
-\-
+.RS 3
+.bP
global data, e.g., used in the low-level terminfo or termcap interfaces.
-.TP 3
-\-
+.bP
terminal data, e.g., associated with a call to \fIset_curterm\fP.
The terminal data are initialized when screens are created.
-.TP 3
-\-
+.bP
screen data, e.g., associated with a call to \fInewterm\fP or \fIinitscr\fP.
-.TP 3
-\-
+.bP
window data, e.g., associated with a call to \fInewwin\fP or \fIsubwin\fP.
Windows are associated with screens.
Pads are not necessarily associated with a particular screen.
.IP
Most curses applications operate on one or more windows within a single screen.
-.TP 3
-\-
+.bP
reentrant, i.e., it uses only the data passed as parameters.
.RE
.PP
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_util.3x,v 1.29 2010/09/11 18:13:16 Jason.McIntyre Exp $
+.\" $Id: curs_util.3x,v 1.30 2010/09/18 20:24:41 tom Exp $
.TH curs_util 3X ""
+.de bP
+.IP \(bu 4
+..
.na
.hy 0
.SH NAME
.PP
The \fBkeyname\fR routine returns a character string corresponding to the key \fIc\fR:
.RS 3
-.TP 3
-\-
+.bP
Printable characters are displayed as themselves, e.g., a one-character string containing the key.
-.TP 3
-\-
+.bP
Control characters are displayed in the \fB^\fR\fIX\fR notation.
-.TP 3
-\-
+.bP
DEL (character 127) is displayed as \fB^?\fP.
-.TP 3
-\-
+.bP
Values above 128 are either meta characters
(if the screen has not been initialized,
or if \fBmeta\fP has been called with a TRUE parameter),
or are displayed as themselves.
In the latter case, the values may not be printable;
this follows the X/Open specification.
-.TP 3
-\-
+.bP
Values above 256 may be the names of the names of function keys.
-.TP 3
-\-
+.bP
Otherwise (if there is no corresponding name) the function returns null,
to denote an error.
X/Open also lists an "UNKNOWN KEY" return value, which some implementations
It states that \fBunctrl\fR and \fBwunctrl\fR will return a null pointer if
unsuccessful, but does not define any error conditions.
This implementation checks for three cases:
-.RS
-.TP 5
-\-
+.RS 3
+.bP
the parameter is a 7-bit US\-ASCII code.
This is the case that X/Open Curses documented.
-.TP 5
-\-
+.bP
the parameter is in the range 128\-159, i.e., a C1 control code.
If \fBuse_legacy_coding\fP has been called with a \fB2\fP parameter,
\fBunctrl\fP returns the parameter, i.e., a one-character string with
initializing curses.
This implementation permits that,
and returns the ``~@'', etc., values in that case.
-.TP 5
-\-
+.bP
parameter values outside the 0 to 255 range.
\fBunctrl\fP returns a null pointer.
.RE
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: form_driver.3x,v 1.18 2010/07/31 14:49:44 tom Exp $
+.\" $Id: form_driver.3x,v 1.19 2010/09/18 20:23:02 tom Exp $
.TH form_driver 3X ""
+.de bP
+.IP \(bu 4
+..
.SH NAME
\fBform_driver\fR \- command-processing loop of the form system
.SH SYNOPSIS
.SH DESCRIPTION
Once a form has been posted (displayed), you should funnel input events to it
through \fBform_driver\fR. This routine has three major input cases:
-.TP 3
-\-
+.bP
The input is a form navigation request.
Navigation request codes are constants defined in \fB<form.h>\fP,
which are distinct from the key- and character codes returned by \fBwgetch\fP.
-.TP 3
-\-
+.bP
The input is a printable character.
Printable characters (which must be positive, less than 256) are
checked according to the program's locale settings.
-.TP 3
-\-
+.bP
The input is the KEY_MOUSE special key associated with an mouse event.
.PP
The form driver requests are as follows:
area or the decoration window) are handled.
.PP
If you click above the display region of the form:
-.RS
+.RS 3
.TP
a REQ_PREV_FIELD is generated for a single click,
.TP
.RE
.PP
If you click below the display region of the form:
-.RS
+.RS 3
.TP
a REQ_NEXT_FIELD is generated for a single click,
.TP
.RE
.PP
If you click at an field inside the display area of the form:
-.RS
-.TP 3
-\-
+.RS 3
+.bP
the form cursor is positioned to that field.
-.TP 3
-\-
+.bP
If you double-click a field,
the form cursor is positioned to that field
and \fBE_UNKNOWN_COMMAND\fR is returned.
be returned.
It is exactly the purpose of this return value to signal that an
application specific command should be executed.
-.TP 3
-\-
+.bP
If a translation
into a request was done, \fBform_driver\fR returns the result of this request.
.RE
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: form_field_buffer.3x,v 1.17 2010/09/11 18:13:24 Jason.McIntyre Exp $
+.\" $Id: form_field_buffer.3x,v 1.18 2010/09/18 20:22:01 tom Exp $
.TH form_field_buffer 3X ""
+.de bP
+.IP \(bu 4
+..
.SH NAME
\fBform_field_buffer\fR \- field buffer control
.SH SYNOPSIS
\fB#include <form.h>\fR
-.br
+.sp
int set_field_buffer(FIELD *field, int buf, const char *value);
.br
char *field_buffer(const FIELD *field, int buffer);
The function \fBset_field_buffer\fR sets the numbered buffer of the given field
to contain a given string:
.RS 3
-.TP 3
-\-
+.bP
Buffer 0 is the displayed value of the field.
-.TP 3
-\-
+.bP
Other numbered buffers may be allocated by applications through the \fBnbuf\fR
argument of (see \fBform_field_new\fR(3X))
but are not manipulated by the forms library.
The function \fBfield_buffer\fR returns a pointer to
the contents of the given numbered buffer:
.RS 3
-.TP 3
-\-
+.bP
The buffer contents always have the same length,
and are padded with trailing spaces
as needed to ensure this length is the same.
-.TP 3
-\-
+.bP
The buffer may contain leading spaces, depending on how it was set.
-.TP 3
-\-
+.bP
The buffer contents are set with \fBset_field_buffer\fP,
or as a side effect of any editing operations on the corresponding field.
-.TP 3
-\-
+.bP
Editing operations are based on the \fIwindow\fP which displays the field,
rather than a \fIstring\fP.
The window contains only printable characters, and is filled with blanks.
If you want the raw data, you must write your
own routine that copies the value out of the buffer and removes the leading
and trailing spaces.
-.TP 3
-\-
+.bP
Because editing operations change the content of the buffer to
correspond to the window, you should not rely on using buffers
for long-term storage of form data.
# use or other dealings in this Software without prior written #
# authorization. #
##############################################################################
-# $Id: man_db.renames,v 1.46 2010/09/11 18:47:13 tom Exp $
+# $Id: man_db.renames,v 1.47 2010/09/18 15:43:20 tom Exp $
# Manual-page renamings for the man_db program
#
# Files:
curs_scr_dump.3x scr_dump.3ncurses
curs_scroll.3x scroll.3ncurses
curs_slk.3x slk.3ncurses
+curs_sp_funcs.3x sp_funcs.3ncurses
curs_termattrs.3x termattrs.3ncurses
curs_termcap.3x termcap.3ncurses
curs_terminfo.3x terminfo.3ncurses
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: menu_driver.3x,v 1.17 2010/07/31 15:16:18 tom Exp $
+.\" $Id: menu_driver.3x,v 1.18 2010/09/18 20:20:39 tom Exp $
.TH menu_driver 3X ""
+.de bP
+.IP \(bu 4
+..
.SH NAME
\fBmenu_driver\fR \- command-processing loop of the menu system
.SH SYNOPSIS
.SH DESCRIPTION
Once a menu has been posted (displayed), you should funnel input events to it
through \fBmenu_driver\fR. This routine has three major input cases:
-.TP 3
-\-
+.bP
The input is a form navigation request.
Navigation request codes are constants defined in \fB<form.h>\fP,
which are distinct from the key- and character codes returned by \fBwgetch\fP.
-.TP 3
-\-
+.bP
The input is a printable character.
Printable characters (which must be positive, less than 256) are
checked according to the program's locale settings.
-.TP 3
-\-
+.bP
The input is the KEY_MOUSE special key associated with an mouse event.
.PP
The menu driver requests are as follows:
area or the decoration window) are handled.
.PP
If you click above the display region of the menu:
-.RS
-.TP
+.bP
a REQ_SCR_ULINE is generated for a single click,
-.TP
+.bP
a REQ_SCR_UPAGE is generated for a double-click and
-.TP
+.bP
a REQ_FIRST_ITEM is generated for a triple-click.
-.RE
.PP
If you click below the display region of the menu:
-.RS
-.TP
+.bP
a REQ_SCR_DLINE is generated for a single click,
-.TP
+.bP
a REQ_SCR_DPAGE is generated for a double-click and
-.TP
+.bP
a REQ_LAST_ITEM is generated for a triple-click.
-.RE
.PP
If you click at an item inside the display area of the menu:
-.RS
-.TP 3
-\-
+.bP
the menu cursor is positioned to that item.
-.TP 3
-\-
+.bP
If you double-click an item a REQ_TOGGLE_ITEM
is generated and \fBE_UNKNOWN_COMMAND\fR is returned.
This return value makes sense,
be returned.
It is exactly the purpose of this return value to signal that an
application specific command should be executed.
-.TP 3
-\-
+.bP
If a translation
into a request was done, \fBmenu_driver\fR returns the result of this request.
-.RE
.PP
If you clicked outside the user window or the mouse event could not be translated
into a menu request an \fBE_REQUEST_DENIED\fR is returned.
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: ncurses.3x,v 1.97 2010/09/11 20:54:13 tom Exp $
+.\" $Id: ncurses.3x,v 1.98 2010/09/18 20:17:20 tom Exp $
.hy 0
.TH ncurses 3X ""
+.de bP
+.IP \(bu 4
+..
.ds n 5
.ds d @TERMINFO@
.SH NAME
This is the simplest, but not the only way to change the list of directories.
The complete list of directories in order follows:
.RS
-.TP 3
-\-
+.bP
the last directory to which \fBncurses\fR wrote, if any, is searched first
-.TP 3
-\-
+.bP
the directory specified by the TERMINFO symbol
-.TP 3
-\-
+.bP
$HOME/.terminfo
-.TP 3
-\-
+.bP
directories listed in the TERMINFO_DIRS symbol
-.TP 3
-\-
+.bP
one or more directories whose names are configured and compiled into the
ncurses library, e.g.,
@TERMINFO@
-- sale, use or other dealings in this Software without prior written --
-- authorization. --
-------------------------------------------------------------------------------
--- $Id: README,v 1.42 2010/09/11 22:00:58 tom Exp $
+-- $Id: README,v 1.43 2010/09/18 15:11:39 tom Exp $
-------------------------------------------------------------------------------
The programs in this directory are designed to test your newest toy :-)
new_field test: cardfile demo_forms ncurses
new_fieldtype test: ncurses
new_form test: cardfile demo_forms ncurses
+new_form_sp -
new_page test: demo_forms
pos_form_cursor -
post_form test: cardfile demo_forms ncurses
menu_win test: demo_menus ncurses
new_item test: demo_menus ncurses
new_menu test: demo_menus ncurses
+new_menu_sp -
pos_menu_cursor lib: menu
post_menu test: demo_menus ncurses
scale_menu test: demo_menus ncurses
addstr test: blue bs cardfile gdc hanoi lrtest ncurses savescreen test_addstr
addwstr test: ncurses test_addwstr
assume_default_colors test: ncurses
+assume_default_colors_sp -
attr_get test: ncurses
attr_off test: ncurses
attr_on test: ncurses
attron test: bs echochar filter gdc ncurses
attrset test: bs firework gdc hanoi insdelln ncurses rain tclock testaddch testcurs
baudrate lib: ncurses
+baudrate_sp lib: ncurses
beep test: blue bs cardfile chgat clip_printw demo_forms demo_menus demo_panels edit_field hanoi inch_wide inchs ins_wide insdelln inserts knight movewindow ncurses savescreen tclock test_add_wchstr test_addchstr test_addstr test_addwstr test_get_wstr test_getstr test_instr test_inwstr test_opaque testcurs view xmas
+beep_sp lib: ncurses
bkgd test: background cardfile demo_forms ncurses savescreen tclock view
bkgdset test: background ncurses testaddch
bkgrnd test: ncurses
box test: cardfile chgat clip_printw demo_forms demo_menus demo_panels ditto edit_field inch_wide inchs ins_wide insdelln inserts lrtest ncurses newdemo redraw test_add_wchstr test_addchstr test_addstr test_addwstr test_get_wstr test_getstr test_instr test_inwstr test_opaque testcurs
box_set test: ncurses
can_change_color test: ncurses
+can_change_color_sp -
cbreak test: background blue bs cardfile chgat clip_printw color_set demo_altkeys demo_defkey demo_forms demo_keyok demo_menus demo_panels ditto filter firework foldkeys gdc hanoi hashtest inch_wide inchs ins_wide insdelln inserts knight lrtest movewindow ncurses newdemo savescreen tclock test_add_wchstr test_addchstr test_addstr test_addwstr test_get_wstr test_getstr test_instr test_inwstr test_opaque testcurs view worm xmas
+cbreak_sp lib: ncurses
chgat test: chgat
clear test: blue bs gdc ncurses testcurs xmas
clearok test: bs knight
clrtobot test: demo_menus ncurses
clrtoeol test: blue bs demo_altkeys demo_menus foldkeys hanoi hashtest movewindow ncurses view
color_content test: ncurses
+color_content_sp -
color_set test: color_set ncurses
copywin test: ncurses testcurs
cur_term test: demo_terminfo dots dots_mvcur lrtest progs: clear tabs tput tset
curs_set test: echochar firework gdc hanoi lrtest ncurses newdemo rain savescreen tclock testcurs worm xmas
+curs_set_sp lib: ncurses
curscr test: demo_panels edit_field knight lrtest ncurses savescreen tclock view
curses_version test: ncurses progs: infocmp tic toe tput tset
def_prog_mode test: bs ncurses
-def_shell_mode lib: ncurses
+def_prog_mode_sp lib: ncurses
+def_shell_mode -
+def_shell_mode_sp lib: ncurses
define_key test: demo_altkeys demo_defkey foldkeys
+define_key_sp -
del_curterm lib: ncurses
+del_curterm_sp lib: ncurses
delay_output test: newdemo
+delay_output_sp -
delch -
deleteln test: insdelln
delscreen test: ditto dots_mvcur
delwin test: cardfile chgat clip_printw demo_forms demo_panels edit_field inch_wide inchs ins_wide insdelln inserts movewindow ncurses newdemo redraw test_add_wchstr test_addchstr test_addstr test_addwstr test_get_wstr test_getstr test_instr test_inwstr test_opaque testcurs
derwin test: cardfile chgat clip_printw demo_forms demo_menus ditto inch_wide inchs ins_wide insdelln inserts movewindow ncurses test_add_wchstr test_addchstr test_addstr test_addwstr test_get_wstr test_getstr test_instr test_inwstr test_opaque
doupdate test: cardfile demo_menus demo_panels ditto edit_field ins_wide inserts knight movewindow ncurses redraw savescreen test_add_wchstr test_addchstr test_addstr test_addwstr test_get_wstr test_getstr
+doupdate_sp lib: ncurses
dupwin test: edit_field
echo test: bs hanoi ncurses test_get_wstr test_getstr testcurs testscanw
+echo_sp lib: ncurses
echo_wchar test: ncurses
echochar test: echochar ncurses
endwin test: background blue bs cardfile chgat clip_printw color_set demo_altkeys demo_defkey demo_forms demo_keyok demo_menus demo_panels ditto dots_mvcur echochar filter firework firstlast foldkeys gdc hanoi hashtest inch_wide inchs ins_wide insdelln inserts key_names keynames knight lrtest movewindow ncurses newdemo rain redraw savescreen tclock test_add_wchstr test_addchstr test_addstr test_addwstr test_get_wstr test_getstr test_instr test_inwstr test_opaque testaddch testcurs testscanw view worm xmas
+endwin_sp lib: ncurses
erase test: cardfile demo_menus filter firework firstlast hanoi lrtest ncurses tclock test_opaque testcurs
erasechar lib: ncurses
+erasechar_sp lib: ncurses
erasewchar -
filter test: filter
+filter_sp -
flash test: cardfile lrtest ncurses tclock testcurs
+flash_sp -
flushinp test: ncurses newdemo testcurs
+flushinp_sp lib: ncurses
get_escdelay -
+get_escdelay_sp -
get_wch -
get_wstr test: test_get_wstr
getattrs -
getmaxx test: chgat clip_printw demo_panels inch_wide inchs insdelln movewindow ncurses newdemo redraw test_get_wstr test_getstr test_instr test_inwstr test_opaque testcurs
getmaxy test: chgat clip_printw demo_forms demo_panels inch_wide inchs insdelln movewindow ncurses newdemo redraw test_get_wstr test_getstr test_instr test_inwstr test_opaque testcurs
getmouse test: bs knight movewindow ncurses
+getmouse_sp -
getn_wstr test: test_get_wstr
getnstr test: filter ncurses test_getstr
getparx test: movewindow
getpary test: movewindow
getstr test: test_getstr
getwin test: ncurses
+getwin_sp -
halfdelay test: view
+halfdelay_sp -
has_colors test: background bs cardfile chgat clip_printw color_set demo_forms demo_menus demo_panels echochar filter firework gdc hanoi ins_wide insdelln inserts knight ncurses newdemo rain savescreen tclock test_add_wchstr test_addchstr test_addstr test_addwstr testcurs view worm xmas
+has_colors_sp lib: ncurses
has_ic test: lrtest
-has_il lib: ncurses
-has_key lib: ncurses
+has_ic_sp lib: ncurses
+has_il -
+has_il_sp lib: ncurses
+has_key -
+has_key_sp lib: ncurses
has_mouse -
+has_mouse_sp -
hline test: gdc ncurses
hline_set -
idcok test: test_opaque
inchnstr test: inchs
inchstr test: inchs
init_color test: ncurses
+init_color_sp lib: ncurses
init_pair test: background blue bs cardfile chgat clip_printw color_set demo_forms demo_menus demo_panels echochar filter firework gdc hanoi ins_wide insdelln inserts knight ncurses newdemo rain savescreen tclock test_add_wchstr test_addchstr test_addstr test_addwstr testaddch testcurs view worm xmas
+init_pair_sp -
initscr test: background blue bs cardfile chgat clip_printw color_set demo_defkey demo_forms demo_keyok demo_menus demo_panels echochar filter firework firstlast gdc hanoi hashtest inch_wide inchs ins_wide insdelln inserts knight lrtest movewindow ncurses newdemo rain redraw savescreen tclock test_add_wchstr test_addchstr test_addstr test_addwstr test_get_wstr test_getstr test_instr test_inwstr test_opaque testaddch testcurs testscanw view worm xmas
innstr test: test_instr
innwstr test: test_inwstr
insstr test: inserts
instr test: test_instr
intrflush test: demo_forms movewindow
+intrflush_sp -
inwstr test: test_inwstr
is_cleared test: test_opaque
is_idcok test: test_opaque
is_subwin -
is_syncok test: test_opaque
is_term_resized -
+is_term_resized_sp -
is_wintouched lib: ncurses
isendwin -
+isendwin_sp -
key_defined test: demo_defkey foldkeys
+key_defined_sp lib: ncurses
key_name test: key_names ncurses
keybound test: demo_altkeys demo_defkey
+keybound_sp lib: ncurses
keyname test: demo_altkeys demo_defkey demo_keyok demo_menus edit_field foldkeys keynames movewindow ncurses redraw testcurs view progs: tic
+keyname_sp lib: ncurses
keyok test: demo_keyok foldkeys
+keyok_sp lib: ncurses
keypad test: bs cardfile chgat clip_printw demo_altkeys demo_defkey demo_forms demo_keyok demo_menus demo_panels ditto edit_field filter firework foldkeys hashtest inch_wide inchs ins_wide insdelln inserts key_names keynames knight lrtest movewindow ncurses redraw savescreen tclock test_add_wchstr test_addchstr test_addstr test_addwstr test_get_wstr test_getstr test_instr test_inwstr test_opaque testcurs testscanw view
killchar lib: ncurses
+killchar_sp lib: ncurses
killwchar -
leaveok test: hanoi test_opaque
longname test: testcurs progs: tput
mcprint -
+mcprint_sp -
meta test: key_names keynames ncurses
mouse_trafo -
mouseinterval -
+mouseinterval_sp -
mousemask test: bs demo_forms demo_menus knight movewindow ncurses
+mousemask_sp -
move test: blue bs cardfile chgat demo_altkeys demo_menus echochar foldkeys gdc hanoi hashtest inch_wide inchs ins_wide inserts knight lrtest movewindow ncurses savescreen test_add_wchstr test_addchstr test_addstr test_addwstr test_get_wstr test_getstr test_instr test_inwstr test_opaque testscanw view xmas
mvadd_wch test: ncurses test_add_wchstr test_addwstr
mvadd_wchnstr test: test_add_wchstr
mvaddwstr test: test_addwstr
mvchgat test: chgat
mvcur test: dots_mvcur redraw
+mvcur_sp lib: ncurses
mvdelch -
mvderwin test: movewindow
mvget_wch -
mvwvline test: ins_wide inserts movewindow test_add_wchstr test_addchstr test_addstr test_addwstr
mvwvline_set -
napms test: demo_panels ditto dots dots_mvcur echochar firework gdc hanoi lrtest ncurses railroad rain tclock test_opaque testcurs view worm xmas progs: tset
+napms_sp -
+new_prescr lib: ncurses
newpad test: edit_field ncurses testcurs
+newpad_sp lib: ncurses
newscr lib: ncurses
newterm test: demo_altkeys ditto dots_mvcur filter foldkeys gdc key_names keynames
+newterm_sp -
newwin test: cardfile chgat clip_printw demo_defkey demo_forms demo_keyok demo_menus demo_panels ditto edit_field firstlast inch_wide inchs ins_wide insdelln inserts knight movewindow ncurses newdemo redraw test_add_wchstr test_addchstr test_addstr test_addwstr test_get_wstr test_getstr test_instr test_inwstr test_opaque testcurs xmas
+newwin_sp lib: ncurses
nl test: demo_forms ncurses rain testcurs
+nl_sp lib: ncurses
nocbreak test: testcurs
+nocbreak_sp lib: ncurses
nodelay test: ditto firework gdc lrtest ncurses newdemo rain tclock test_opaque view worm xmas
noecho test: background bs cardfile chgat clip_printw color_set demo_altkeys demo_defkey demo_forms demo_keyok demo_menus demo_panels ditto firework firstlast foldkeys gdc hanoi hashtest inch_wide inchs ins_wide insdelln inserts knight lrtest movewindow ncurses rain redraw savescreen tclock test_add_wchstr test_addchstr test_addstr test_addwstr test_get_wstr test_getstr test_instr test_inwstr test_opaque testcurs view worm xmas
+noecho_sp lib: ncurses
nofilter -
+nofilter_sp -
nonl test: bs demo_forms hashtest movewindow ncurses view worm xmas
+nonl_sp lib: ncurses
noqiflush -
+noqiflush_sp -
noraw test: demo_forms demo_menus ncurses testcurs
+noraw_sp lib: ncurses
notimeout test: test_opaque
numcodes test: demo_termcap test_arrays progs: dump_entry
numfnames test: demo_terminfo test_arrays progs: dump_entry
overlay test: ncurses testcurs xmas
overwrite test: ncurses savescreen
pair_content test: background color_set
+pair_content_sp lib: ncurses
pecho_wchar -
pechochar -
pnoutrefresh test: edit_field ncurses
prefresh test: testcurs
printw test: background blue bs color_set demo_altkeys demo_defkey demo_keyok demo_menus filter foldkeys ncurses savescreen testcurs testscanw view
putp progs: tput
+putp_sp lib: ncurses
putwin test: ncurses
qiflush -
+qiflush_sp -
raw test: demo_forms ncurses redraw testcurs
+raw_sp lib: ncurses
redrawwin test: redraw
refresh test: blue bs demo_defkey demo_forms demo_keyok demo_menus demo_panels echochar filter firstlast gdc hanoi hashtest lrtest movewindow ncurses savescreen tclock testcurs view xmas
reset_prog_mode test: filter ncurses
+reset_prog_mode_sp lib: ncurses
reset_shell_mode test: bs filter savescreen
+reset_shell_mode_sp lib: ncurses
resetty -
+resetty_sp -
resize_term test: view
-resizeterm lib: ncurses
+resize_term_sp -
+resizeterm -
+resizeterm_sp lib: ncurses
restartterm -
+restartterm_sp -
ripoffline test: demo_menus ncurses
+ripoffline_sp -
savetty -
+savetty_sp -
scanw test: testcurs testscanw
scr_dump test: savescreen
scr_init test: savescreen
+scr_init_sp -
scr_restore test: savescreen
+scr_restore_sp -
scr_set test: savescreen
+scr_set_sp -
scrl test: view
scroll test: testcurs
scrollok test: clip_printw demo_altkeys demo_defkey demo_keyok demo_panels ditto foldkeys hashtest knight ncurses redraw test_opaque testcurs testscanw view
set_curterm lib: ncurses
+set_curterm_sp -
set_escdelay test: test_opaque
+set_escdelay_sp lib: ncurses
set_tabsize test: test_opaque
+set_tabsize_sp -
set_term lib: ncurses
setcchar test: demo_panels ins_wide ncurses test_add_wchstr test_addwstr view
setscrreg test: view
slk_attr_off -
slk_attr_on -
slk_attr_set test: ncurses
+slk_attr_set_sp -
+slk_attr_sp -
slk_attroff lib: ncurses
+slk_attroff_sp -
slk_attron lib: ncurses
+slk_attron_sp -
slk_attrset test: ncurses
+slk_attrset_sp -
slk_clear test: ncurses
+slk_clear_sp -
slk_color test: ncurses
+slk_color_sp -
slk_init test: ncurses
+slk_init_sp -
slk_label test: ncurses
+slk_label_sp -
slk_noutrefresh test: ncurses
+slk_noutrefresh_sp -
slk_refresh test: ncurses
+slk_refresh_sp lib: ncurses
slk_restore test: ncurses
+slk_restore_sp lib: ncurses
slk_set test: ncurses
+slk_set_sp -
slk_touch test: ncurses
+slk_touch_sp lib: ncurses
slk_wset test: ncurses
standend test: blue gdc ncurses
standout test: blue ncurses
start_color test: background blue bs cardfile chgat clip_printw color_set demo_forms demo_menus demo_panels echochar filter firework gdc hanoi ins_wide insdelln inserts knight ncurses newdemo rain savescreen tclock test_add_wchstr test_addchstr test_addstr test_addwstr testaddch testcurs view worm xmas
+start_color_sp -
stdscr test: bs chgat clip_printw demo_altkeys demo_forms demo_menus demo_panels ditto filter firework foldkeys gdc hanoi hashtest inch_wide inchs ins_wide insdelln inserts key_names keynames knight lrtest movewindow ncurses rain redraw savescreen tclock test_add_wchstr test_addchstr test_addstr test_addwstr test_get_wstr test_getstr test_instr test_inwstr test_opaque testcurs testscanw view worm xmas
strcodes test: demo_termcap test_arrays progs: dump_entry
strfnames test: demo_terminfo test_arrays progs: dump_entry
subwin test: movewindow ncurses newdemo testcurs
syncok test: test_opaque
term_attrs test: ncurses
+term_attrs_sp -
termattrs test: ncurses testcurs
+termattrs_sp lib: ncurses
termname test: testcurs
+termname_sp lib: ncurses
tgetent test: demo_termcap railroad
+tgetent_sp -
tgetflag test: demo_termcap
+tgetflag_sp -
tgetnum test: demo_termcap railroad
+tgetnum_sp -
tgetstr test: demo_termcap railroad
+tgetstr_sp -
tgoto test: railroad
tigetflag test: demo_terminfo progs: tput
+tigetflag_sp -
tigetnum test: demo_terminfo ncurses progs: tput
+tigetnum_sp -
tigetstr test: blue demo_defkey demo_terminfo foldkeys testcurs progs: tput
+tigetstr_sp -
timeout test: rain savescreen
tiparm -
touchline test: chgat clip_printw insdelln
touchwin test: chgat clip_printw demo_menus edit_field filter firstlast inch_wide inchs ins_wide insdelln inserts movewindow ncurses redraw test_add_wchstr test_addchstr test_addstr test_addwstr test_get_wstr test_getstr test_instr test_inwstr test_opaque xmas
tparm test: dots dots_mvcur progs: tabs tic tput
tputs test: dots dots_mvcur railroad progs: clear tabs tset
+tputs_sp lib: ncurses
trace test: demo_menus hanoi hashtest lrtest ncurses testcurs view worm
ttytype lib: ncurses
typeahead test: testcurs
+typeahead_sp lib: ncurses
unctrl test: ncurses redraw testcurs
+unctrl_sp lib: ncurses
unget_wch -
+unget_wch_sp -
ungetch test: bs knight
+ungetch_sp lib: ncurses
ungetmouse -
+ungetmouse_sp -
untouchwin lib: form
use_default_colors test: filter firework gdc hanoi knight ncurses rain tclock worm xmas
+use_default_colors_sp -
use_env progs: tput
+use_env_sp -
use_extended_names test: demo_terminfo progs: infocmp tic
use_legacy_coding -
+use_legacy_coding_sp -
use_screen test: ditto
use_window test: rain worm
vid_attr -
+vid_attr_sp -
vid_puts -
-vidattr lib: ncurses
-vidputs lib: ncurses
+vid_puts_sp -
+vidattr -
+vidattr_sp lib: ncurses
+vidputs -
+vidputs_sp lib: ncurses
vline test: gdc ncurses
vline_set -
vw_printw test: clip_printw
wtimeout test: ncurses
wtouchln lib: ncurses
wunctrl lib: ncurses
+wunctrl_sp -
wvline test: testcurs
wvline_set lib: ncurses
libpanel:
--------
bottom_panel test: demo_panels ncurses
+ceiling_panel -
del_panel test: demo_panels ncurses
+ground_panel -
hide_panel test: demo_panels ncurses
move_panel test: demo_panels ncurses
new_panel test: cardfile demo_panels ncurses
show_panel test: demo_panels ncurses
top_panel test: cardfile demo_panels ncurses
update_panels test: cardfile demo_panels ncurses
+update_panels_sp -
#!/bin/sh
##############################################################################
-# Copyright (c) 2003,2006 Free Software Foundation, Inc. #
+# Copyright (c) 2003-2006,2010 Free Software Foundation, Inc. #
# #
# Permission is hereby granted, free of charge, to any person obtaining a #
# copy of this software and associated documentation files (the "Software"), #
# use or other dealings in this Software without prior written #
# authorization. #
##############################################################################
-# $Id: listused.sh,v 1.7 2006/06/03 16:39:37 tom Exp $
-# A very simple script to list entrypoints that are used by either a test
+# $Id: listused.sh,v 1.8 2010/09/18 15:15:15 tom Exp $
+# A very simple script to list all entrypoints that are used by either a test
# program, or within the libraries. This relies on the output format of 'nm',
# and assumes that the libraries are configured with TRACE defined, and using
# these options:
# --disable-macros
+# --enable-sp-funcs
# --enable-widec
# Static libraries are used, to provide some filtering based on internal usage
# of the different symbols.
projects / ncurses.git / commitdiff