X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_slk.3x;h=d09d6c781a6022f39b7570e0d0540e6ae80d70ff;hb=8f487e9f47505e8cf31ea1b5e3075b2a43ce9302;hp=0b9b1d0b808deb0f92cb9700b5f66bb82df4ac5a;hpb=3eda6f30a84d53844d2ebceadb457e2e7e9cfbf3;p=ncurses.git diff --git a/man/curs_slk.3x b/man/curs_slk.3x index 0b9b1d0b..d09d6c78 100644 --- a/man/curs_slk.3x +++ b/man/curs_slk.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2016,2017 Free Software Foundation, Inc. * +.\" Copyright 2018-2020,2021 Thomas E. Dickey * +.\" Copyright 1998-2016,2017 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 * @@ -26,10 +27,11 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_slk.3x,v 1.31 2017/03/31 11:09:28 tom Exp $ +.\" $Id: curs_slk.3x,v 1.38 2021/06/17 21:26:02 tom Exp $ .TH curs_slk 3X "" .de bP -.IP \(bu 4 +.ie n .IP \(bu 4 +.el .IP \(bu 2 .. .na .hy 0 @@ -61,6 +63,8 @@ .sp \fBint slk_set(int \fP\fIlabnum\fP\fB, const char *\fP\fIlabel\fP\fB, int \fP\fIfmt\fP\fB);\fR .br +/* extension */ +.br \fBint slk_wset(int \fP\fIlabnum\fP\fB, const wchar_t *\fP\fIlabel\fP\fB, int \fP\fIfmt\fP\fB);\fR .sp \fBchar *slk_label(int \fP\fIlabnum\fP\fB);\fR @@ -175,8 +179,10 @@ The \fBslk_touch\fR routine forces all the soft labels to be output the next time a \fBslk_noutrefresh\fR is performed. .SS Video attributes .PP -The \fBslk_attron\fR, \fBslk_attrset\fR, \fBslk_attroff\fR and \fBslk_attr\fR -routines correspond to \fBattron\fR, \fBattrset\fR, \fBattroff\fR and \fBattr_get\fR. +The +\fBslk_attron\fR, \fBslk_attrset\fR, \fBslk_attroff\fR and \fBslk_attr\fR +routines correspond to +\fBattron\fR, \fBattrset\fR, \fBattroff\fR and \fBattr_get\fR, 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 @@ -188,12 +194,13 @@ 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, -this implementation provides +this implementation provides \fBextended_slk_color\fR which accepts an integer value, e.g., 32-bits. . .SH RETURN VALUE -These routines return \fBERR\fR upon failure and OK (SVr4 specifies only "an -integer value other than \fBERR\fR") upon successful completion. +These routines return \fBERR\fR upon failure +and \fBOK\fP (SVr4 specifies only "an integer value other than \fBERR\fR") +upon successful completion. .PP X/Open defines no error conditions. In this implementation @@ -238,11 +245,34 @@ the \fIlabnum\fP 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. .RE +.SH HISTORY +SVr3 introduced these functions: + slk_clear + slk_init + slk_label + slk_noutrefresh + slk_refresh + slk_restore + slk_set + slk_touch +.PP +SVr4 added these functions: + slk_attroff + slk_attron + slk_attrset + slk_start +.PP +X/Open Curses added these: + slk_attr_off + slk_attr_on + slk_attr_set + slk_color + slk_wset .SH EXTENSIONS .PP X/Open Curses documents the \fIopts\fP argument as reserved for future use, saying that it must be null. -This implementation +This implementation uses that parameter in ABI 6 for the functions which have a color-pair parameter to support extended color pairs. .PP