man/curs_slk.3x

   1 .\"***************************************************************************
   2 .\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
   3 .\" Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
   4 .\"                                                                          *
   5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   6 .\" copy of this software and associated documentation files (the            *
   7 .\" "Software"), to deal in the Software without restriction, including      *
   8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  10 .\" copies of the Software, and to permit persons to whom the Software is    *
  11 .\" furnished to do so, subject to the following conditions:                 *
  12 .\"                                                                          *
  13 .\" The above copyright notice and this permission notice shall be included  *
  14 .\" in all copies or substantial portions of the Software.                   *
  15 .\"                                                                          *
  16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23 .\"                                                                          *
  24 .\" Except as contained in this notice, the name(s) of the above copyright   *
  25 .\" holders shall not be used in advertising or otherwise to promote the     *
  26 .\" sale, use or other dealings in this Software without prior written       *
  27 .\" authorization.                                                           *
  28 .\"***************************************************************************
  29 .\"
  30 .\" $Id: curs_slk.3x,v 1.63 2023/10/07 21:19:07 tom Exp $
  31 .TH curs_slk 3X 2023-10-07 "ncurses 6.4" "Library calls"
  32 .ie \n(.g \{\
  33 .ds `` \(lq
  34 .ds '' \(rq
  35 .\}
  36 .el \{\
  37 .ie t .ds `` ``
  38 .el   .ds `` ""
  39 .ie t .ds '' ''
  40 .el   .ds '' ""
  41 .\}
  42 .
  43 .de bP
  44 .ie n  .IP \(bu 4
  45 .el    .IP \(bu 2
  46 ..
  47 .SH NAME
  48 \fB\%slk_init\fP,
  49 \fB\%slk_set\fP,
  50 \fB\%slk_wset\fP,
  51 \fB\%slk_refresh\fP,
  52 \fB\%slk_noutrefresh\fP,
  53 \fB\%slk_label\fP,
  54 \fB\%slk_clear\fP,
  55 \fB\%slk_restore\fP,
  56 \fB\%slk_touch\fP,
  57 \fB\%slk_attron\fP,
  58 \fB\%slk_attrset\fP,
  59 \fB\%slk_attroff\fP,
  60 \fB\%slk_attr_on\fP,
  61 \fB\%slk_attr_set\fP,
  62 \fB\%slk_attr_off\fP,
  63 \fB\%slk_attr\fP,
  64 \fB\%slk_color\fP,
  65 \fB\%extended_slk_color\fP \-
  66 \fIcurses\fR soft label key routines
  67 .SH SYNOPSIS
  68 .nf
  69 \fB#include <curses.h>
  70 .PP
  71 \fBint slk_init(int \fIfmt\fP);
  72 .PP
  73 \fBint slk_set(int \fIlabnum\fP, const char *\fIlabel\fP, int \fIfmt\fP);
  74 \fBint slk_wset(int \fIlabnum\fP, const wchar_t *\fIlabel\fP, int \fIfmt\fP);
  75 .PP
  76 \fBchar *slk_label(int \fIlabnum\fP);
  77 .PP
  78 \fBint slk_refresh(void);
  79 \fBint slk_noutrefresh(void);
  80 \fBint slk_clear(void);
  81 \fBint slk_restore(void);
  82 \fBint slk_touch(void);
  83 .PP
  84 \fBint slk_attron(const chtype \fIattrs\fP);
  85 \fBint slk_attroff(const chtype \fIattrs\fP);
  86 \fBint slk_attrset(const chtype \fIattrs\fP);
  87 \fBint slk_attr_on(attr_t \fIattrs\fP, void* \fIopts\fP);
  88 \fBint slk_attr_off(const attr_t \fIattrs\fP, void * \fIopts\fP);
  89 \fBint slk_attr_set(const attr_t \fIattrs\fP, short \fIpair\fP, void* \fIopts\fP);
  90 \fI/* extension */
  91 \fBattr_t slk_attr(void);
  92 .PP
  93 \fBint slk_color(short \fIpair\fP);
  94 \fI/* extension */
  95 \fBint extended_slk_color(int \fIpair\fP);
  96 .fi
  97 .SH DESCRIPTION
  98 The \fBslk\fP* functions manipulate the set of soft function-key labels that exist on
  99 many terminals.
 100 For those terminals that do not have soft labels,
 101 \fIcurses\fP takes over the bottom line of \fB\%stdscr\fP, reducing the size of
 102 \fB\%stdscr\fP and the variable \fBLINES\fP.
 103 \fIcurses\fP standardizes on eight
 104 labels of up to eight characters each.
 105 In addition to this, the \fIncurses\fP
 106 implementation supports a mode where it simulates 12 labels of up to five
 107 characters each.
 108 This is useful for PC-like enduser devices.
 109 \fIncurses\fP simulates this mode by taking over up to two lines at
 110 the bottom of the screen;
 111 it does not try to use any hardware support for this
 112 mode.
 113 .SS Initialization
 114 The \fB\%slk_init\fP routine must be called before \fB\%initscr\fP or \fB\%newterm\fP
 115 is called.
 116 If \fB\%initscr\fP eventually uses a line from \fB\%stdscr\fP to
 117 emulate the soft labels,
 118 then \fIfmt\fP determines how the labels are arranged on the screen:
 119 .RS 3
 120 .TP 3
 121 .B 0
 122 indicates a 3\-2\-3 arrangement of
 123 the labels.
 124 .TP 3
 125 .B 1
 126 indicates a 4\-4 arrangement
 127 .TP 3
 128 .B 2
 129 indicates the PC-like 4\-4\-4 mode.
 130 .TP 3
 131 .B 3
 132 is again the PC-like 4\-4\-4 mode,
 133 but in addition an index line is generated, helping the user to
 134 identify the key numbers easily.
 135 .RE
 136 .SS Labels
 137 The \fB\%slk_set\fP routine
 138 (and the \fB\%slk_wset\fP routine for the wide-character library)
 139 has three parameters:
 140 .RS 3
 141 .TP 5
 142 .I labnum
 143 is the label number, from \fB1\fP to \fB8\fP
 144 (12 if \fIfmt\fP in \fB\%slk_init\fP is \fB2\fP or \fB3\fP);
 145 .TP
 146 .I label
 147 is be the string to put on the label,
 148 up to eight
 149 (five if \fIfmt\fP in \fB\%slk_init\fP is \fB2\fP or \fB3\fP)
 150 characters in length.
 151 A null string or a null pointer sets up a blank label.
 152 .TP
 153 .I fmt
 154 is either
 155 \fB0\fP, \fB1\fP, or \fB2\fP, indicating whether the label is to be
 156 left-justified, centered, or right-justified, respectively, within the
 157 label.
 158 .RE
 159 .PP
 160 The \fB\%slk_label\fP routine returns the current label for label number
 161 \fIlabnum\fP, with leading and trailing blanks stripped.
 162 .SS Screen updates
 163 The \fB\%slk_refresh\fP and \fB\%slk_noutrefresh\fP routines correspond to
 164 the \fB\%wrefresh\fP and \fB\%wnoutrefresh\fP routines.
 165 .PP
 166 The \fB\%slk_clear\fP routine clears the soft labels from the screen.
 167 .PP
 168 The \fB\%slk_restore\fP routine restores the soft labels to the screen
 169 after a \fB\%slk_clear\fP has been performed.
 170 .PP
 171 The \fB\%slk_touch\fP routine forces all the soft labels to be output
 172 the next time a \fB\%slk_noutrefresh\fP is performed.
 173 .SS Video attributes
 174 The
 175 \fB\%slk_attron\fP, \fB\%slk_attrset\fP, \fB\%slk_attroff\fP and \fB\%slk_attr\fP
 176 routines correspond to
 177 \fB\%attron\fP, \fB\%attrset\fP, \fB\%attroff\fP and \fB\%attr_get\fP, respectively.
 178 They have an effect only if soft labels are simulated on the bottom line of
 179 the screen.
 180 The default highlight for soft keys is A_STANDOUT (as in
 181 System V \fIcurses\fP, which does not document this fact).
 182 .SS Colors
 183 The \fB\%slk_color\fP routine corresponds to \fB\%color_set\fP.
 184 It has an effect only
 185 if soft labels are simulated on the bottom line of the screen.
 186 .PP
 187 Because \fB\%slk_color\fP accepts only \fBshort\fP (signed 16-bit integer) values,
 188 this implementation provides
 189 \fB\%extended_slk_color\fP which accepts an integer value, e.g., 32-bits.
 190 .
 191 .SH RETURN VALUE
 192 These routines return \fBERR\fP upon failure
 193 and \fBOK\fP (SVr4 specifies only "an integer value other than \fBERR\fP")
 194 upon successful completion.
 195 .PP
 196 X/Open defines no error conditions.
 197 In this implementation
 198 .RS 3
 199 .TP 5
 200 \fBslk_attr\fP
 201 returns the attribute used for the soft keys.
 202 .TP 5
 203 \fBslk_attroff\fP, \fBslk_attron\fP, \fBslk_clear\fP, \fBslk_noutrefresh\fP, \fBslk_refresh\fP, \fBslk_touch\fP
 204 return an error
 205 if the terminal or the softkeys were not initialized.
 206 .TP 5
 207 \fBslk_attrset\fP
 208 returns an error
 209 if the terminal or the softkeys were not initialized.
 210 .TP 5
 211 \fBslk_attr_set\fP
 212 returns an error
 213 if the terminal or the softkeys were not initialized, or
 214 the color pair is outside the range 0..\fBCOLOR_PAIRS\fP\-1.
 215 .TP 5
 216 \fBslk_color\fP
 217 returns an error
 218 if the terminal or the softkeys were not initialized, or
 219 the color pair is outside the range 0..\fBCOLOR_PAIRS\fP\-1.
 220 .TP 5
 221 \fBslk_init\fP
 222 returns an error
 223 if the format parameter is outside the range 0..3.
 224 .TP 5
 225 \fBslk_label\fP
 226 returns \fBNULL\fP on error.
 227 .TP 5
 228 \fBslk_set\fP
 229 returns an error
 230 if the terminal or the softkeys were not initialized, or
 231 the \fIlabnum\fP parameter is outside the range of label counts, or
 232 if the format parameter is outside the range 0..2, or if
 233 memory for the labels cannot be allocated.
 234 .RE
 235 .SH HISTORY
 236 SVr3 introduced these functions:
 237   \fBslk_clear\fP
 238   \fBslk_init\fP
 239   \fBslk_label\fP
 240   \fBslk_noutrefresh\fP
 241   \fBslk_refresh\fP
 242   \fBslk_restore\fP
 243   \fBslk_set\fP
 244   \fBslk_touch\fP
 245 .PP
 246 SVr4 added these functions:
 247   \fBslk_attroff\fP
 248   \fBslk_attron\fP
 249   \fBslk_attrset\fP
 250   \fBslk_start\fP
 251 .PP
 252 X/Open \fIcurses\fP added these:
 253   \fBslk_attr_off\fP
 254   \fBslk_attr_on\fP
 255   \fBslk_attr_set\fP
 256   \fBslk_color\fP
 257   \fBslk_wset\fP
 258 .SH EXTENSIONS
 259 X/Open \fIcurses\fP documents the \fIopts\fP argument as reserved for future use,
 260 saying that it must be null.
 261 This implementation
 262 uses that parameter in ABI 6 for the functions which have a color-pair
 263 parameter to support extended color pairs.
 264 .PP
 265 For  functions  which modify the color, e.g., \fB\%slk_attr_set\fP,
 266 if \fIopts\fP is set it is treated as a pointer to \fBint\fP,
 267 and used to  set  the  color pair instead of the \fBshort\fP pair parameter.
 268 .SH NOTES
 269 Most applications would use \fB\%slk_noutrefresh\fP because a
 270 \fB\%wrefresh\fP is likely to follow soon.
 271 .SH PORTABILITY
 272 The XSI \fIcurses\fP standard, Issue 4, described the soft-key functions,
 273 with some differences from SVr4 \fIcurses\fP:
 274 .bP
 275 It added functions like the SVr4
 276 attribute-manipulation functions \fB\%slk_attron\fP,
 277 \fB\%slk_attroff\fP, \fB\%slk_attrset\fP,
 278 but which use \fBattr_t\fP parameters (rather than \fB\%chtype\fP),
 279 along with a reserved \fIopts\fP parameter.
 280 .IP
 281 Two of these new functions (unlike the SVr4 functions) have no provision
 282 for color: \fB\%slk_attr_on\fP and \fB\%slk_attr_off\fP.
 283 .IP
 284 The third function \%(\fBslk_attr_set\fP) has a color-pair parameter.
 285 .bP
 286 It added \fBconst\fP qualifiers to parameters (unnecessarily), and
 287 .bP
 288 It added \fB\%slk_color\fP.
 289 .PP
 290 Although \fB\%slk_start\fP is declared in the \fIcurses\fP header file,
 291 it was not documented by SVr4 other than its presence in a list
 292 of libtermlib.so.1 symbols.
 293 Reading the source code (i.e., Illumos):
 294 .bP
 295 \fB\%slk_start\fP has two parameters:
 296 .RS
 297 .bP
 298 \fIng\fP (number of groups) and
 299 .bP
 300 \fIgp\fP (group pointer).
 301 .RE
 302 .bP
 303 Soft-key groups are an array of \fIng\fP integers.
 304 .bP
 305 In SVr4, \fB\%slk_init\fP calls \fB\%slk_start\fP passing a null for \fIgp\fP.
 306 For this case, \fB\%slk_start\fP uses the number of groups \fIng\fP
 307 (3 for the 3-2-3 layout, 2 for the 4-4 layout) which \fB\%slk_init\fP provided.
 308 .IP
 309 If \fIng\fP is neither 2 or 3,
 310 \fB\%slk_start\fP checks the terminfo \fBfln\fP (label_format) capability,
 311 interpreting that as a comma-separated list of numbers,
 312 e.g., \*(``3,2,3\*('' for the 3-2-3 layout.
 313 .IP
 314 Finally, if there is no \fBfln\fP capability, \fB\%slk_start\fP returns \fBERR\fP.
 315 .bP
 316 If \fB\%slk_start\fP is given a non-null \fIgp\fP,
 317 it copies the \fIng\fP elements of the group of soft-keys, up to 16.
 318 .IP
 319 If there are more than 16 elements, \fB\%slk_start\fP returns an error.
 320 .bP
 321 The format codes \fB2\fP and \fB3\fP for \fB\%slk_init\fP
 322 were added by \fIncurses\fP in 1996.
 323 PDCurses 2.4 added this feature in 2001.
 324 .PP
 325 The function \fB\%slk_attr\fP was added by \fIncurses\fP in 1996.
 326 .PP
 327 X/Open \fIcurses\fP does not specify a limit for the number of colors and
 328 color pairs which a terminal can support.
 329 However, in its use of \fBshort\fP for the parameters,
 330 it carries over SVr4's implementation detail for the compiled
 331 terminfo database, which uses signed 16-bit numbers.
 332 This implementation provides extended versions of those functions
 333 which use \fBint\fP parameters,
 334 allowing applications to use larger color- and pair-numbers.
 335 .SH SEE ALSO
 336 \fB\%curses\fP(3X),
 337 \fB\%curs_attr\fP(3X),
 338 \fB\%curs_initscr\fP(3X),
 339 \fB\%curs_refresh\fP(3X),
 340 \fB\%curs_variables\fP(3X)