X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_slk.3x;h=7bc27a6de4f03c32dbd64f1ee924965894eee788;hb=2de8c14bb2c6f8e61cfbbfb1f0f30d1ad64c8d68;hp=2cdab7926fad6ee3cc732bc6d67511a500db4c76;hpb=0eedaa5673ff8181abe51e3a6fadca3820f90c46;p=ncurses.git diff --git a/man/curs_slk.3x b/man/curs_slk.3x index 2cdab792..7bc27a6d 100644 --- a/man/curs_slk.3x +++ b/man/curs_slk.3x @@ -27,12 +27,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_slk.3x,v 1.60 2023/09/23 22:49:51 tom Exp $ -.TH curs_slk 3X 2023-09-23 "ncurses 6.4" "Library calls" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_slk.3x,v 1.64 2023/10/21 10:31:22 tom Exp $ +.TH curs_slk 3X 2023-10-21 "ncurses 6.4" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 @@ -59,37 +66,37 @@ \fIcurses\fR soft label key routines .SH SYNOPSIS .nf -\fB#include \fP +\fB#include .PP -\fBint slk_init(int \fIfmt\fB);\fR +\fBint slk_init(int \fIfmt\fP); .PP -\fBint slk_set(int \fIlabnum\fB, const char *\fIlabel\fB, int \fIfmt\fB);\fR -\fBint slk_wset(int \fIlabnum\fB, const wchar_t *\fIlabel\fB, int \fIfmt\fB);\fR +\fBint slk_set(int \fIlabnum\fP, const char *\fIlabel\fP, int \fIfmt\fP); +\fBint slk_wset(int \fIlabnum\fP, const wchar_t *\fIlabel\fP, int \fIfmt\fP); .PP -\fBchar *slk_label(int \fIlabnum\fB);\fR +\fBchar *slk_label(int \fIlabnum\fP); .PP -\fBint slk_refresh(void);\fP -\fBint slk_noutrefresh(void);\fP -\fBint slk_clear(void);\fP -\fBint slk_restore(void);\fP -\fBint slk_touch(void);\fP +\fBint slk_refresh(void); +\fBint slk_noutrefresh(void); +\fBint slk_clear(void); +\fBint slk_restore(void); +\fBint slk_touch(void); .PP -\fBint slk_attron(const chtype \fIattrs\fB);\fR -\fBint slk_attroff(const chtype \fIattrs\fB);\fR -\fBint slk_attrset(const chtype \fIattrs\fB);\fR -\fBint slk_attr_on(attr_t \fIattrs\fB, void* \fIopts\fB);\fR -\fBint slk_attr_off(const attr_t \fIattrs\fB, void * \fIopts\fB);\fR -\fBint slk_attr_set(const attr_t \fIattrs\fB, short \fIpair\fB, void* \fIopts\fB);\fR -\fI/* extension */\fP -\fBattr_t slk_attr(void);\fP +\fBint slk_attron(const chtype \fIattrs\fP); +\fBint slk_attroff(const chtype \fIattrs\fP); +\fBint slk_attrset(const chtype \fIattrs\fP); +\fBint slk_attr_on(attr_t \fIattrs\fP, void* \fIopts\fP); +\fBint slk_attr_off(const attr_t \fIattrs\fP, void * \fIopts\fP); +\fBint slk_attr_set(const attr_t \fIattrs\fP, short \fIpair\fP, void* \fIopts\fP); +\fI/* extension */ +\fBattr_t slk_attr(void); .PP -\fBint slk_color(short \fIpair\fB);\fR -\fI/* extension */\fP -\fBint extended_slk_color(int \fIpair\fB);\fR +\fBint slk_color(short \fIpair\fP); +\fI/* extension */ +\fBint extended_slk_color(int \fIpair\fP); .fi .SH DESCRIPTION -The \fBslk\fP* functions manipulate the set of soft function-key labels that exist on -many terminals. +The \fBslk\fP* functions manipulate the set +of soft function-key labels that exist on many terminals. For those terminals that do not have soft labels, \fIcurses\fP takes over the bottom line of \fB\%stdscr\fP, reducing the size of \fB\%stdscr\fP and the variable \fBLINES\fP. @@ -104,7 +111,8 @@ the bottom of the screen; it does not try to use any hardware support for this mode. .SS Initialization -The \fB\%slk_init\fP routine must be called before \fB\%initscr\fP or \fB\%newterm\fP +The \fB\%slk_init\fP routine must be called +before \fB\%initscr\fP or \fB\%newterm\fP is called. If \fB\%initscr\fP eventually uses a line from \fB\%stdscr\fP to emulate the soft labels, @@ -177,7 +185,8 @@ The \fB\%slk_color\fP routine corresponds to \fB\%color_set\fP. It has an effect only if soft labels are simulated on the bottom line of the screen. .PP -Because \fB\%slk_color\fP accepts only \fBshort\fP (signed 16-bit integer) values, +Because \fB\%slk_color\fP accepts +only \fBshort\fP (signed 16-bit integer) values, this implementation provides \fB\%extended_slk_color\fP which accepts an integer value, e.g., 32-bits. . @@ -249,7 +258,8 @@ X/Open \fIcurses\fP added these: \fBslk_color\fP \fBslk_wset\fP .SH EXTENSIONS -X/Open \fIcurses\fP documents the \fIopts\fP argument as reserved for future use, +X/Open \fIcurses\fP documents the \fIopts\fP 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 @@ -274,7 +284,7 @@ along with a reserved \fIopts\fP parameter. Two of these new functions (unlike the SVr4 functions) have no provision for color: \fB\%slk_attr_on\fP and \fB\%slk_attr_off\fP. .IP -The third function (\fB\%slk_attr_set\fP) has a color-pair parameter. +The third function \%(\fBslk_attr_set\fP) has a color-pair parameter. .bP It added \fBconst\fP qualifiers to parameters (unnecessarily), and .bP @@ -304,7 +314,8 @@ If \fIng\fP is neither 2 or 3, interpreting that as a comma-separated list of numbers, e.g., \*(``3,2,3\*('' for the 3-2-3 layout. .IP -Finally, if there is no \fBfln\fP capability, \fB\%slk_start\fP returns \fBERR\fP. +Finally, if there is no \fBfln\fP capability, +\fB\%slk_start\fP returns \fBERR\fP. .bP If \fB\%slk_start\fP is given a non-null \fIgp\fP, it copies the \fIng\fP elements of the group of soft-keys, up to 16.