* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_slk.3x,v 1.53 2023/09/16 23:37:03 tom Exp @
+ * @Id: curs_slk.3x,v 1.60 2023/09/23 22:49:51 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>curs_slk 3x 2023-09-16 ncurses 6.4 Library calls</TITLE>
+<TITLE>curs_slk 3x 2023-09-23 ncurses 6.4 Library calls</TITLE>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
</HEAD>
<BODY>
-<H1 class="no-header">curs_slk 3x 2023-09-16 ncurses 6.4 Library calls</H1>
+<H1 class="no-header">curs_slk 3x 2023-09-23 ncurses 6.4 Library calls</H1>
<PRE>
<STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
<STRONG>int</STRONG> <STRONG>slk_attr_on(attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>void*</STRONG> <EM>opts</EM><STRONG>);</STRONG>
<STRONG>int</STRONG> <STRONG>slk_attr_off(const</STRONG> <STRONG>attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG> <EM>opts</EM><STRONG>);</STRONG>
<STRONG>int</STRONG> <STRONG>slk_attr_set(const</STRONG> <STRONG>attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>void*</STRONG> <EM>opts</EM><STRONG>);</STRONG>
- /* extension */
+ <EM>/*</EM> <EM>extension</EM> <EM>*/</EM>
<STRONG>attr_t</STRONG> <STRONG>slk_attr(void);</STRONG>
<STRONG>int</STRONG> <STRONG>slk_color(short</STRONG> <EM>pair</EM><STRONG>);</STRONG>
- /* extension */
+ <EM>/*</EM> <EM>extension</EM> <EM>*/</EM>
<STRONG>int</STRONG> <STRONG>extended_slk_color(int</STRONG> <EM>pair</EM><STRONG>);</STRONG>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
- The slk* functions manipulate the set of soft function-key labels that
+ The <STRONG>slk</STRONG>* functions manipulate the set of soft function-key labels that
exist on many terminals. For those terminals that do not have soft
- labels, <STRONG>curses</STRONG> takes over the bottom line of <STRONG>stdscr</STRONG>, reducing the size
- of <STRONG>stdscr</STRONG> and the variable <STRONG>LINES</STRONG>. <STRONG>curses</STRONG> standardizes on eight labels
- of up to eight characters each. In addition to this, the ncurses
+ labels, <EM>curses</EM> takes over the bottom line of <STRONG>stdscr</STRONG>, reducing the size
+ of <STRONG>stdscr</STRONG> and the variable <STRONG>LINES</STRONG>. <EM>curses</EM> standardizes on eight labels
+ of up to eight characters each. In addition to this, the <EM>ncurses</EM>
implementation supports a mode where it simulates 12 labels of up to
five characters each. This is useful for PC-like enduser devices.
- ncurses simulates this mode by taking over up to two lines at the
+ <EM>ncurses</EM> simulates this mode by taking over up to two lines at the
bottom of the screen; it does not try to use any hardware support for
this mode.
correspond to <STRONG>attron</STRONG>, <STRONG>attrset</STRONG>, <STRONG>attroff</STRONG> and <STRONG>attr_get</STRONG>, respectively.
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).
+ (as in System V <EM>curses</EM>, which does not document this fact).
</PRE><H3><a name="h3-Colors">Colors</a></H3><PRE>
<STRONG>slk_attr_set</STRONG>
returns an error if the terminal or the softkeys were not
initialized, or the color pair is outside the range
- 0..COLOR_PAIRS-1.
+ 0..<STRONG>COLOR_PAIRS</STRONG>-1.
<STRONG>slk_color</STRONG>
returns an error if the terminal or the softkeys were not
initialized, or the color pair is outside the range
- 0..COLOR_PAIRS-1.
+ 0..<STRONG>COLOR_PAIRS</STRONG>-1.
<STRONG>slk_init</STRONG>
returns an error if the format parameter is outside the range
</PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
SVr3 introduced these functions:
- slk_clear
- slk_init
- slk_label
- slk_noutrefresh
- slk_refresh
- slk_restore
- slk_set
- slk_touch
+ <STRONG>slk_clear</STRONG>
+ <STRONG>slk_init</STRONG>
+ <STRONG>slk_label</STRONG>
+ <STRONG>slk_noutrefresh</STRONG>
+ <STRONG>slk_refresh</STRONG>
+ <STRONG>slk_restore</STRONG>
+ <STRONG>slk_set</STRONG>
+ <STRONG>slk_touch</STRONG>
SVr4 added these functions:
- slk_attroff
- slk_attron
- slk_attrset
- slk_start
+ <STRONG>slk_attroff</STRONG>
+ <STRONG>slk_attron</STRONG>
+ <STRONG>slk_attrset</STRONG>
+ <STRONG>slk_start</STRONG>
- X/Open Curses added these:
- slk_attr_off
- slk_attr_on
- slk_attr_set
- slk_color
- slk_wset
+ X/Open <EM>curses</EM> added these:
+ <STRONG>slk_attr_off</STRONG>
+ <STRONG>slk_attr_on</STRONG>
+ <STRONG>slk_attr_set</STRONG>
+ <STRONG>slk_color</STRONG>
+ <STRONG>slk_wset</STRONG>
</PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
- X/Open Curses documents the <EM>opts</EM> argument as reserved for future use,
+ X/Open <EM>curses</EM> documents the <EM>opts</EM> argument as reserved for future use,
saying that it must be null. This implementation uses that parameter
in ABI 6 for the functions which have a color-pair parameter to support
extended color pairs.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- The XSI Curses standard, Issue 4, described the soft-key functions,
- with some differences from SVr4 curses:
+ The XSI <EM>curses</EM> standard, Issue 4, described the soft-key functions,
+ with some differences from SVr4 <EM>curses</EM>:
<STRONG>o</STRONG> It added functions like the SVr4 attribute-manipulation functions
<STRONG>slk_attron</STRONG>, <STRONG>slk_attroff</STRONG>, <STRONG>slk_attrset</STRONG>, but which use <STRONG>attr_t</STRONG>
<STRONG>o</STRONG> It added <STRONG>slk_color</STRONG>.
- Although <STRONG>slk_start</STRONG> is declared in the curses header file, it was not
+ Although <STRONG>slk_start</STRONG> is declared in the <EM>curses</EM> header file, it was not
documented by SVr4 other than its presence in a list of libtermlib.so.1
symbols. Reading the source code (i.e., Illumos):
case, <STRONG>slk_start</STRONG> uses the number of groups <EM>ng</EM> (3 for the 3-2-3
layout, 2 for the 4-4 layout) which <STRONG>slk_init</STRONG> provided.
- If <EM>ng</EM> is neither 2 or 3, <STRONG>slk_start</STRONG> checks the terminfo <EM>fln</EM>
+ If <EM>ng</EM> is neither 2 or 3, <STRONG>slk_start</STRONG> checks the terminfo <STRONG>fln</STRONG>
(label_format) capability, interpreting that as a comma-separated
list of numbers, e.g., "3,2,3" for the 3-2-3 layout.
- Finally, if there is no <EM>fln</EM> capability, <STRONG>slk_start</STRONG> returns ERR.
+ Finally, if there is no <STRONG>fln</STRONG> capability, <STRONG>slk_start</STRONG> returns <STRONG>ERR</STRONG>.
<STRONG>o</STRONG> If <STRONG>slk_start</STRONG> is given a non-null <EM>gp</EM>, it copies the <EM>ng</EM> elements of
the group of soft-keys, up to 16.
If there are more than 16 elements, <STRONG>slk_start</STRONG> returns an error.
- <STRONG>o</STRONG> The format codes <STRONG>2</STRONG> and <STRONG>3</STRONG> for <STRONG>slk_init</STRONG> were added by ncurses in
+ <STRONG>o</STRONG> The format codes <STRONG>2</STRONG> and <STRONG>3</STRONG> for <STRONG>slk_init</STRONG> were added by <EM>ncurses</EM> in
1996. PDCurses 2.4 added this feature in 2001.
- The function <STRONG>slk_attr</STRONG> was added by ncurses in 1996.
+ The function <STRONG>slk_attr</STRONG> was added by <EM>ncurses</EM> in 1996.
- X/Open Curses does not specify a limit for the number of colors and
+ X/Open <EM>curses</EM> does not specify a limit for the number of colors and
color pairs which a terminal can support. However, in its use of <STRONG>short</STRONG>
for the parameters, it carries over SVr4's implementation detail for
the compiled terminfo database, which uses signed 16-bit numbers. This
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>,
- <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
+ <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
-ncurses 6.4 2023-09-
16 <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
+ncurses 6.4 2023-09-
23 <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
</PRE>
<div class="nav">
<ul>
projects / ncurses.git / blobdiff