<!--
****************************************************************************
- * Copyright 2018-2022,2023 Thomas E. Dickey *
+ * Copyright 2018-2023,2024 Thomas E. Dickey *
* Copyright 1998-2016,2017 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_slk.3x,v 1.67 2023/12/16 21:18:45 tom Exp @
+ * @Id: curs_slk.3x,v 1.73 2024/05/25 20:10:58 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-12-16 ncurses 6.4 Library calls</TITLE>
+<TITLE>curs_slk 3x 2024-05-25 ncurses 6.5 Library calls</TITLE>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
</HEAD>
<BODY>
-<H1 class="no-header">curs_slk 3x 2023-12-16 ncurses 6.4 Library calls</H1>
+<H1 class="no-header">curs_slk 3x 2024-05-25 ncurses 6.5 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>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 softkeys were not
+ return <STRONG>ERR</STRONG> if the terminal or the softkeys were not
initialized.
<STRONG>slk_attrset</STRONG>
- returns an error if the terminal or the softkeys were not
+ returns <STRONG>ERR</STRONG> if the terminal or the softkeys were not
initialized.
<STRONG>slk_attr_set</STRONG>
- returns an error if the terminal or the softkeys were not
+ returns <STRONG>ERR</STRONG> if the terminal or the softkeys were not
initialized, or the color pair is outside the range
0..<STRONG>COLOR_PAIRS</STRONG>-1.
<STRONG>slk_color</STRONG>
- returns an error if the terminal or the softkeys were not
+ returns <STRONG>ERR</STRONG> if the terminal or the softkeys were not
initialized, or the color pair is outside the range
0..<STRONG>COLOR_PAIRS</STRONG>-1.
<STRONG>slk_init</STRONG>
- returns an error if the format parameter is outside the range
- 0..3.
+ returns <STRONG>ERR</STRONG> 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 softkeys were not
- initialized, or the <EM>labnum</EM> parameter is outside the range of
- label counts, or if the format parameter is outside the range
+ returns <STRONG>ERR</STRONG> if the terminal or the softkeys were not
+ initialized, or the <EM>labnum</EM> parameter 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><a name="h2-NOTES">NOTES</a></H2><PRE>
- Most applications would use <STRONG>slk_noutrefresh</STRONG> because a <STRONG>wrefresh</STRONG> is
+ Most applications would use <STRONG>slk_noutrefresh</STRONG> because a <STRONG>wrefresh</STRONG> is
likely to follow soon.
</PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
- X/Open Curses documents the <EM>opts</EM> argument as reserved for future use,
- saying that it must be null. This implementation uses that parameter
+ X/Open Curses 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.
- For functions which modify the color, e.g., <STRONG>slk_attr_set</STRONG>, if <EM>opts</EM> is
- set it is treated as a pointer to <EM>int</EM>, and used to set the color pair
+ For functions which modify the color, e.g., <STRONG>slk_attr_set</STRONG>, if <EM>opts</EM> is
+ set it is treated as a pointer to <EM>int</EM>, and used to set the color pair
instead of the <EM>short</EM> pair parameter.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- X/Open Curses, Issue 4, describes these functions, with some
- differences from SVr4 <EM>curses</EM>:
+ X/Open Curses, Issue 4 describes these functions, with some differences
+ from SVr4 <EM>curses</EM>:
- <STRONG>o</STRONG> X/Open added functions like the SVr4 attribute-manipulation
- functions <STRONG>slk_attron</STRONG>, <STRONG>slk_attroff</STRONG>, and <STRONG>slk_attrset</STRONG>, but which use
- <EM>attr</EM><STRONG>_</STRONG><EM>t</EM> parameters (rather than <EM>chtype</EM>), along with a reserved <EM>opts</EM>
+ <STRONG>o</STRONG> X/Open added functions like the SVr4 attribute-manipulation
+ functions <STRONG>slk_attron</STRONG>, <STRONG>slk_attroff</STRONG>, and <STRONG>slk_attrset</STRONG>, but which use
+ <EM>attr</EM><STRONG>_</STRONG><EM>t</EM> parameters (rather than <EM>chtype</EM>), along with a reserved <EM>opts</EM>
parameter.
- Two of these new functions (unlike the SVr4 functions) have no
+ Two of these new functions (unlike the SVr4 functions) have no
provision for color: <STRONG>slk_attr_on</STRONG> and <STRONG>slk_attr_off</STRONG>.
The third function (<STRONG>slk_attr_set</STRONG>) has a color pair parameter.
<STRONG>o</STRONG> It added <STRONG>slk_color</STRONG>.
- Although <STRONG>slk_start</STRONG> is declared in the <EM>curses</EM> 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):
<STRONG>o</STRONG> Soft-key groups are an array of <EM>ng</EM> integers.
- <STRONG>o</STRONG> In SVr4, <STRONG>slk_init</STRONG> calls <STRONG>slk_start</STRONG> passing a null for <EM>gp</EM>. For this
- case, <STRONG>slk_start</STRONG> uses the number of groups <EM>ng</EM> (3 for the 3-2-3
+ <STRONG>o</STRONG> In SVr4, <STRONG>slk_init</STRONG> calls <STRONG>slk_start</STRONG> passing a null for <EM>gp</EM>. For this
+ 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 <STRONG>fln</STRONG>
- (label_format) capability, interpreting that as a comma-separated
+ 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 <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
+ <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.
+ If there are more than 16 elements, <STRONG>slk_start</STRONG> returns <STRONG>ERR</STRONG>.
- <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
+ <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 <EM>ncurses</EM> in 1996.
- X/Open Curses does not specify a limit for the number of colors and
+ X/Open Curses does not specify a limit for the number of colors and
color pairs which a terminal can support. However, in its use of <EM>short</EM>
- for the parameters, it carries over SVr4's implementation detail for
+ for the parameters, it carries over SVr4's implementation detail for
the compiled terminfo database, which uses signed 16-bit numbers. This
- implementation provides extended versions of those functions which use
- <EM>int</EM> parameters, allowing applications to use larger color- and pair-
+ implementation provides extended versions of those functions which use
+ <EM>int</EM> parameters, allowing applications to use larger color- and pair-
numbers.
-ncurses 6.
4 2023-12-16 <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
+ncurses 6.
5 2024-05-25 <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
</PRE>
<div class="nav">
<ul>
projects / ncurses.git / blobdiff