.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_slk.3x,v 1.38 2021/06/17 21:26:02 tom Exp $
+.\" $Id: curs_slk.3x,v 1.39 2021/12/25 17:39:16 tom Exp $
.TH curs_slk 3X ""
.de bP
.ie n .IP \(bu 4
.na
.hy 0
.SH NAME
-\fBslk_init\fR,
-\fBslk_set\fR,
-\fBslk_wset\fR,
-\fBslk_refresh\fR,
-\fBslk_noutrefresh\fR,
-\fBslk_label\fR,
-\fBslk_clear\fR,
-\fBslk_restore\fR,
-\fBslk_touch\fR,
-\fBslk_attron\fR,
-\fBslk_attrset\fR,
-\fBslk_attroff\fR,
-\fBslk_attr_on\fR,
-\fBslk_attr_set\fR,
-\fBslk_attr_off\fR,
-\fBslk_attr\fR,
-\fBslk_color\fR,
-\fBextended_slk_color\fR \- \fBcurses\fR soft label routines
+\fBslk_init\fP,
+\fBslk_set\fP,
+\fBslk_wset\fP,
+\fBslk_refresh\fP,
+\fBslk_noutrefresh\fP,
+\fBslk_label\fP,
+\fBslk_clear\fP,
+\fBslk_restore\fP,
+\fBslk_touch\fP,
+\fBslk_attron\fP,
+\fBslk_attrset\fP,
+\fBslk_attroff\fP,
+\fBslk_attr_on\fP,
+\fBslk_attr_set\fP,
+\fBslk_attr_off\fP,
+\fBslk_attr\fP,
+\fBslk_color\fP,
+\fBextended_slk_color\fP \- \fBcurses\fP soft label routines
.ad
.hy
.SH SYNOPSIS
-\fB#include <curses.h>\fR
+\fB#include <curses.h>\fP
.sp
-\fBint slk_init(int \fP\fIfmt\fP\fB);\fR
+\fBint slk_init(int \fP\fIfmt\fP\fB);\fP
.sp
-\fBint slk_set(int \fP\fIlabnum\fP\fB, const char *\fP\fIlabel\fP\fB, int \fP\fIfmt\fP\fB);\fR
+\fBint slk_set(int \fP\fIlabnum\fP\fB, const char *\fP\fIlabel\fP\fB, int \fP\fIfmt\fP\fB);\fP
.br
/* extension */
.br
-\fBint slk_wset(int \fP\fIlabnum\fP\fB, const wchar_t *\fP\fIlabel\fP\fB, int \fP\fIfmt\fP\fB);\fR
+\fBint slk_wset(int \fP\fIlabnum\fP\fB, const wchar_t *\fP\fIlabel\fP\fB, int \fP\fIfmt\fP\fB);\fP
.sp
-\fBchar *slk_label(int \fP\fIlabnum\fP\fB);\fR
+\fBchar *slk_label(int \fP\fIlabnum\fP\fB);\fP
.sp
-\fBint slk_refresh(void);\fR
+\fBint slk_refresh(void);\fP
.br
-\fBint slk_noutrefresh(void);\fR
+\fBint slk_noutrefresh(void);\fP
.br
-\fBint slk_clear(void);\fR
+\fBint slk_clear(void);\fP
.br
-\fBint slk_restore(void);\fR
+\fBint slk_restore(void);\fP
.br
-\fBint slk_touch(void);\fR
+\fBint slk_touch(void);\fP
.sp
-\fBint slk_attron(const chtype \fP\fIattrs\fP\fB);\fR
+\fBint slk_attron(const chtype \fP\fIattrs\fP\fB);\fP
.br
-\fBint slk_attroff(const chtype \fP\fIattrs\fP\fB);\fR
+\fBint slk_attroff(const chtype \fP\fIattrs\fP\fB);\fP
.br
-\fBint slk_attrset(const chtype \fP\fIattrs\fP\fB);\fR
+\fBint slk_attrset(const chtype \fP\fIattrs\fP\fB);\fP
.br
-\fBint slk_attr_on(attr_t \fP\fIattrs\fP\fB, void* \fP\fIopts\fP\fB);\fR
+\fBint slk_attr_on(attr_t \fP\fIattrs\fP\fB, void* \fP\fIopts\fP\fB);\fP
.br
-\fBint slk_attr_off(const attr_t \fP\fIattrs\fP\fB, void * \fP\fIopts\fP\fB);\fR
+\fBint slk_attr_off(const attr_t \fP\fIattrs\fP\fB, void * \fP\fIopts\fP\fB);\fP
.br
-\fBint slk_attr_set(const attr_t \fP\fIattrs\fP\fB, short \fP\fIpair\fP\fB, void* \fP\fIopts\fP\fB);\fR
+\fBint slk_attr_set(const attr_t \fP\fIattrs\fP\fB, short \fP\fIpair\fP\fB, void* \fP\fIopts\fP\fB);\fP
.sp
-\fBattr_t slk_attr(void);\fR
+\fBattr_t slk_attr(void);\fP
.sp
-\fBint slk_color(short \fP\fIpair\fP\fB);\fR
+\fBint slk_color(short \fP\fIpair\fP\fB);\fP
.br
/* extension */
.br
-\fBint extended_slk_color(int \fP\fIpair\fP\fB);\fR
+\fBint extended_slk_color(int \fP\fIpair\fP\fB);\fP
.SH DESCRIPTION
The slk* functions manipulate the set of soft function-key labels that exist on
many terminals.
For those terminals that do not have soft labels,
-\fBcurses\fR takes over the bottom line of \fBstdscr\fR, reducing the size of
-\fBstdscr\fR and the variable \fBLINES\fR.
-\fBcurses\fR standardizes on eight
+\fBcurses\fP takes over the bottom line of \fBstdscr\fP, reducing the size of
+\fBstdscr\fP and the variable \fBLINES\fP.
+\fBcurses\fP standardizes on eight
labels of up to eight characters each.
In addition to this, the ncurses
implementation supports a mode where it simulates 12 labels of up to five
mode.
.SS Initialization
.PP
-The \fBslk_init\fR routine must be called before \fBinitscr\fR or \fBnewterm\fR
+The \fBslk_init\fP routine must be called before \fBinitscr\fP or \fBnewterm\fP
is called.
-If \fBinitscr\fR eventually uses a line from \fBstdscr\fR to
+If \fBinitscr\fP eventually uses a line from \fBstdscr\fP to
emulate the soft labels,
-then \fIfmt\fR determines how the labels are arranged on the screen:
+then \fIfmt\fP determines how the labels are arranged on the screen:
.RS 3
.TP 3
.B 0
.RE
.SS Labels
.PP
-The \fBslk_set\fR routine
-(and the \fBslk_wset\fR routine for the wide-character library)
+The \fBslk_set\fP routine
+(and the \fBslk_wset\fP routine for the wide-character library)
has three parameters:
.RS 3
.TP 5
.I labnum
-is the label number, from \fB1\fR to \fB8\fR
+is the label number, from \fB1\fP to \fB8\fP
(12 for \fIfmt\fP in \fBslk_init\fP is \fB2\fP or \fB3\fP);
.TP
.I label
.TP
.I fmt
is either
-\fB0\fR, \fB1\fR, or \fB2\fR, indicating whether the label is to be
+\fB0\fP, \fB1\fP, or \fB2\fP, indicating whether the label is to be
left-justified, centered, or right-justified, respectively, within the
label.
.RE
.PP
-The \fBslk_label\fR routine returns the current label for label number
-\fIlabnum\fR, with leading and trailing blanks stripped.
+The \fBslk_label\fP routine returns the current label for label number
+\fIlabnum\fP, with leading and trailing blanks stripped.
.SS Screen updates
.PP
-The \fBslk_refresh\fR and \fBslk_noutrefresh\fR routines correspond to
-the \fBwrefresh\fR and \fBwnoutrefresh\fR routines.
+The \fBslk_refresh\fP and \fBslk_noutrefresh\fP routines correspond to
+the \fBwrefresh\fP and \fBwnoutrefresh\fP routines.
.PP
-The \fBslk_clear\fR routine clears the soft labels from the screen.
+The \fBslk_clear\fP routine clears the soft labels from the screen.
.PP
-The \fBslk_restore\fR routine restores the soft labels to the screen
-after a \fBslk_clear\fR has been performed.
+The \fBslk_restore\fP routine restores the soft labels to the screen
+after a \fBslk_clear\fP has been performed.
.PP
-The \fBslk_touch\fR routine forces all the soft labels to be output
-the next time a \fBslk_noutrefresh\fR is performed.
+The \fBslk_touch\fP routine forces all the soft labels to be output
+the next time a \fBslk_noutrefresh\fP is performed.
.SS Video attributes
.PP
The
-\fBslk_attron\fR, \fBslk_attrset\fR, \fBslk_attroff\fR and \fBslk_attr\fR
+\fBslk_attron\fP, \fBslk_attrset\fP, \fBslk_attroff\fP and \fBslk_attr\fP
routines correspond to
-\fBattron\fR, \fBattrset\fR, \fBattroff\fR and \fBattr_get\fR, respectively.
+\fBattron\fP, \fBattrset\fP, \fBattroff\fP and \fBattr_get\fP, 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).
.SS Colors
.PP
-The \fBslk_color\fR routine corresponds to \fBcolor_set\fR.
+The \fBslk_color\fP routine corresponds to \fBcolor_set\fP.
It has an effect only
if soft labels are simulated on the bottom line of the screen.
.PP
-Because \fBslk_color\fR accepts only \fBshort\fP (signed 16-bit integer) values,
+Because \fBslk_color\fP accepts only \fBshort\fP (signed 16-bit integer) values,
this implementation provides
-\fBextended_slk_color\fR which accepts an integer value, e.g., 32-bits.
+\fBextended_slk_color\fP which accepts an integer value, e.g., 32-bits.
.
.SH RETURN VALUE
-These routines return \fBERR\fR upon failure
-and \fBOK\fP (SVr4 specifies only "an integer value other than \fBERR\fR")
+These routines return \fBERR\fP upon failure
+and \fBOK\fP (SVr4 specifies only "an integer value other than \fBERR\fP")
upon successful completion.
.PP
X/Open defines no error conditions.
In this implementation
.RS 3
.TP 5
-\fBslk_attr\fR
+\fBslk_attr\fP
returns the attribute used for the soft keys.
.TP 5
.na
if the terminal or the softkeys were not initialized, or
the color pair is outside the range 0..COLOR_PAIRS\-1.
.TP 5
-\fBslk_init\fR
+\fBslk_init\fP
returns an error
if the format parameter is outside the range 0..3.
.TP 5
-\fBslk_label\fR
-returns \fBNULL\fR on error.
+\fBslk_label\fP
+returns \fBNULL\fP on error.
.TP 5
\fBslk_set\fP
returns an error
if \fIopts\fP is set it is treated as a pointer to \fBint\fP,
and used to set the color pair instead of the \fBshort\fP pair parameter.
.SH NOTES
-Most applications would use \fBslk_noutrefresh\fR because a
-\fBwrefresh\fR is likely to follow soon.
+Most applications would use \fBslk_noutrefresh\fP because a
+\fBwrefresh\fP is likely to follow soon.
.SH PORTABILITY
The XSI Curses standard, Issue 4, described the soft-key functions,
with some differences from SVr4 curses:
.bP
It added functions like the SVr4
-attribute-manipulation functions \fBslk_attron\fR,
-\fBslk_attroff\fR, \fBslk_attrset\fR,
-but which use \fBattr_t\fR parameters (rather than \fBchtype\fP),
+attribute-manipulation functions \fBslk_attron\fP,
+\fBslk_attroff\fP, \fBslk_attrset\fP,
+but which use \fBattr_t\fP parameters (rather than \fBchtype\fP),
along with a reserved \fIopts\fP parameter.
.IP
Two of these new functions (unlike the SVr4 functions) have no provision
.IP
The third function (\fBslk_attr_set\fP) has a color-pair parameter.
.bP
-It added \fBconst\fR qualifiers to parameters (unnecessarily), and
+It added \fBconst\fP qualifiers to parameters (unnecessarily), and
.bP
It added \fBslk_color\fP.
.PP
-The format codes \fB2\fR and \fB3\fR for \fBslk_init\fR and the
-function \fBslk_attr\fR are specific to ncurses.
+The format codes \fB2\fP and \fB3\fP for \fBslk_init\fP and the
+function \fBslk_attr\fP are specific to ncurses.
.PP
X/Open Curses does not specify a limit for the number of colors and
color pairs which a terminal can support.
which use \fBshort\fP parameters,
allowing applications to use larger color- and pair-numbers.
.SH SEE ALSO
-\fBcurses\fR(3X),
-\fBcurs_attr\fR(3X),
-\fBcurs_initscr\fR(3X),
-\fBcurs_refresh\fR(3X),
-\fBcurs_variables\fR(3X).
+\fBcurses\fP(3X),
+\fBcurs_attr\fP(3X),
+\fBcurs_initscr\fP(3X),
+\fBcurs_refresh\fP(3X),
+\fBcurs_variables\fP(3X).
projects / ncurses.git / blobdiff