man/curs_slk.3x

   1 .\"***************************************************************************
   2 .\" Copyright 2018-2021,2022 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.44 2022/10/29 22:44:14 tom Exp $
  31 .TH curs_slk 3X ""
  32 .ie \n(.g .ds `` \(lq
  33 .el       .ds `` ``
  34 .ie \n(.g .ds '' \(rq
  35 .el       .ds '' ''
  36 .de bP
  37 .ie n  .IP \(bu 4
  38 .el    .IP \(bu 2
  39 ..
  40 .na
  41 .hy 0
  42 .SH NAME
  43 \fBslk_init\fP,
  44 \fBslk_set\fP,
  45 \fBslk_wset\fP,
  46 \fBslk_refresh\fP,
  47 \fBslk_noutrefresh\fP,
  48 \fBslk_label\fP,
  49 \fBslk_clear\fP,
  50 \fBslk_restore\fP,
  51 \fBslk_touch\fP,
  52 \fBslk_attron\fP,
  53 \fBslk_attrset\fP,
  54 \fBslk_attroff\fP,
  55 \fBslk_attr_on\fP,
  56 \fBslk_attr_set\fP,
  57 \fBslk_attr_off\fP,
  58 \fBslk_attr\fP,
  59 \fBslk_color\fP,
  60 \fBextended_slk_color\fP \- \fBcurses\fP soft label routines
  61 .ad
  62 .hy
  63 .SH SYNOPSIS
  64 \fB#include <curses.h>\fP
  65 .sp
  66 \fBint slk_init(int \fIfmt\fB);\fR
  67 .sp
  68 \fBint slk_set(int \fIlabnum\fB, const char *\fIlabel\fB, int \fIfmt\fB);\fR
  69 .br
  70 \fBint slk_wset(int \fIlabnum\fB, const wchar_t *\fIlabel\fB, int \fIfmt\fB);\fR
  71 .sp
  72 \fBchar *slk_label(int \fIlabnum\fB);\fR
  73 .sp
  74 \fBint slk_refresh(void);\fP
  75 .br
  76 \fBint slk_noutrefresh(void);\fP
  77 .br
  78 \fBint slk_clear(void);\fP
  79 .br
  80 \fBint slk_restore(void);\fP
  81 .br
  82 \fBint slk_touch(void);\fP
  83 .sp
  84 \fBint slk_attron(const chtype \fIattrs\fB);\fR
  85 .br
  86 \fBint slk_attroff(const chtype \fIattrs\fB);\fR
  87 .br
  88 \fBint slk_attrset(const chtype \fIattrs\fB);\fR
  89 .br
  90 \fBint slk_attr_on(attr_t \fIattrs\fB, void* \fIopts\fB);\fR
  91 .br
  92 \fBint slk_attr_off(const attr_t \fIattrs\fB, void * \fIopts\fB);\fR
  93 .br
  94 \fBint slk_attr_set(const attr_t \fIattrs\fB, short \fIpair\fB, void* \fIopts\fB);\fR
  95 .br
  96 /* extension */
  97 .br
  98 \fBattr_t slk_attr(void);\fP
  99 .sp
 100 \fBint slk_color(short \fIpair\fB);\fR
 101 .br
 102 /* extension */
 103 .br
 104 \fBint extended_slk_color(int \fIpair\fB);\fR
 105 .SH DESCRIPTION
 106 The slk* functions manipulate the set of soft function-key labels that exist on
 107 many terminals.
 108 For those terminals that do not have soft labels,
 109 \fBcurses\fP takes over the bottom line of \fBstdscr\fP, reducing the size of
 110 \fBstdscr\fP and the variable \fBLINES\fP.
 111 \fBcurses\fP standardizes on eight
 112 labels of up to eight characters each.
 113 In addition to this, the ncurses
 114 implementation supports a mode where it simulates 12 labels of up to five
 115 characters each.
 116 This is useful for PC-like enduser devices.
 117 ncurses simulates this mode by taking over up to two lines at
 118 the bottom of the screen;
 119 it does not try to use any hardware support for this
 120 mode.
 121 .SS Initialization
 122 .PP
 123 The \fBslk_init\fP routine must be called before \fBinitscr\fP or \fBnewterm\fP
 124 is called.
 125 If \fBinitscr\fP eventually uses a line from \fBstdscr\fP to
 126 emulate the soft labels,
 127 then \fIfmt\fP determines how the labels are arranged on the screen:
 128 .RS 3
 129 .TP 3
 130 .B 0
 131 indicates a 3\-2\-3 arrangement of
 132 the labels.
 133 .TP 3
 134 .B 1
 135 indicates a 4\-4 arrangement
 136 .TP 3
 137 .B 2
 138 indicates the PC-like 4\-4\-4 mode.
 139 .TP 3
 140 .B 3
 141 is again the PC-like 4\-4\-4 mode,
 142 but in addition an index line is generated, helping the user to
 143 identify the key numbers easily.
 144 .RE
 145 .SS Labels
 146 .PP
 147 The \fBslk_set\fP routine
 148 (and the \fBslk_wset\fP routine for the wide-character library)
 149 has three parameters:
 150 .RS 3
 151 .TP 5
 152 .I labnum
 153 is the label number, from \fB1\fP to \fB8\fP
 154 (12 if \fIfmt\fP in \fBslk_init\fP is \fB2\fP or \fB3\fP);
 155 .TP
 156 .I label
 157 is be the string to put on the label,
 158 up to eight
 159 (five if \fIfmt\fP in \fBslk_init\fP is \fB2\fP or \fB3\fP)
 160 characters in length.
 161 A null string or a null pointer sets up a blank label.
 162 .TP
 163 .I fmt
 164 is either
 165 \fB0\fP, \fB1\fP, or \fB2\fP, indicating whether the label is to be
 166 left-justified, centered, or right-justified, respectively, within the
 167 label.
 168 .RE
 169 .PP
 170 The \fBslk_label\fP routine returns the current label for label number
 171 \fIlabnum\fP, with leading and trailing blanks stripped.
 172 .SS Screen updates
 173 .PP
 174 The \fBslk_refresh\fP and \fBslk_noutrefresh\fP routines correspond to
 175 the \fBwrefresh\fP and \fBwnoutrefresh\fP routines.
 176 .PP
 177 The \fBslk_clear\fP routine clears the soft labels from the screen.
 178 .PP
 179 The \fBslk_restore\fP routine restores the soft labels to the screen
 180 after a \fBslk_clear\fP has been performed.
 181 .PP
 182 The \fBslk_touch\fP routine forces all the soft labels to be output
 183 the next time a \fBslk_noutrefresh\fP is performed.
 184 .SS Video attributes
 185 .PP
 186 The
 187 \fBslk_attron\fP, \fBslk_attrset\fP, \fBslk_attroff\fP and \fBslk_attr\fP
 188 routines correspond to
 189 \fBattron\fP, \fBattrset\fP, \fBattroff\fP and \fBattr_get\fP, respectively.
 190 They have an effect only if soft labels are simulated on the bottom line of
 191 the screen.
 192 The default highlight for soft keys is A_STANDOUT (as in
 193 System V curses, which does not document this fact).
 194 .SS Colors
 195 .PP
 196 The \fBslk_color\fP routine corresponds to \fBcolor_set\fP.
 197 It has an effect only
 198 if soft labels are simulated on the bottom line of the screen.
 199 .PP
 200 Because \fBslk_color\fP accepts only \fBshort\fP (signed 16-bit integer) values,
 201 this implementation provides
 202 \fBextended_slk_color\fP which accepts an integer value, e.g., 32-bits.
 203 .
 204 .SH RETURN VALUE
 205 These routines return \fBERR\fP upon failure
 206 and \fBOK\fP (SVr4 specifies only "an integer value other than \fBERR\fP")
 207 upon successful completion.
 208 .PP
 209 X/Open defines no error conditions.
 210 In this implementation
 211 .RS 3
 212 .TP 5
 213 \fBslk_attr\fP
 214 returns the attribute used for the soft keys.
 215 .TP 5
 216 .na
 217 .hy 0
 218 \fBslk_attroff\fP, \fBslk_attron\fP, \fBslk_clear\fP, \fBslk_noutrefresh\fP, \fBslk_refresh\fP, \fBslk_touch\fP
 219 .ad
 220 .hy
 221 return an error
 222 if the terminal or the softkeys were not initialized.
 223 .TP 5
 224 \fBslk_attrset\fP
 225 returns an error
 226 if the terminal or the softkeys were not initialized.
 227 .TP 5
 228 \fBslk_attr_set\fP
 229 returns an error
 230 if the terminal or the softkeys were not initialized, or
 231 the color pair is outside the range 0..COLOR_PAIRS\-1.
 232 .TP 5
 233 \fBslk_color\fP
 234 returns an error
 235 if the terminal or the softkeys were not initialized, or
 236 the color pair is outside the range 0..COLOR_PAIRS\-1.
 237 .TP 5
 238 \fBslk_init\fP
 239 returns an error
 240 if the format parameter is outside the range 0..3.
 241 .TP 5
 242 \fBslk_label\fP
 243 returns \fBNULL\fP on error.
 244 .TP 5
 245 \fBslk_set\fP
 246 returns an error
 247 if the terminal or the softkeys were not initialized, or
 248 the \fIlabnum\fP parameter is outside the range of label counts, or
 249 if the format parameter is outside the range 0..2, or if
 250 memory for the labels cannot be allocated.
 251 .RE
 252 .SH HISTORY
 253 SVr3 introduced these functions:
 254   slk_clear
 255   slk_init
 256   slk_label
 257   slk_noutrefresh
 258   slk_refresh
 259   slk_restore
 260   slk_set
 261   slk_touch
 262 .PP
 263 SVr4 added these functions:
 264   slk_attroff
 265   slk_attron
 266   slk_attrset
 267   slk_start
 268 .PP
 269 X/Open Curses added these:
 270   slk_attr_off
 271   slk_attr_on
 272   slk_attr_set
 273   slk_color
 274   slk_wset
 275 .SH EXTENSIONS
 276 .PP
 277 X/Open Curses documents the \fIopts\fP argument as reserved for future use,
 278 saying that it must be null.
 279 This implementation
 280 uses that parameter in ABI 6 for the functions which have a color-pair
 281 parameter to support extended color pairs.
 282 .PP
 283 For  functions  which modify the color, e.g., \fBslk_attr_set\fP,
 284 if \fIopts\fP is set it is treated as a pointer to \fBint\fP,
 285 and used to  set  the  color pair instead of the \fBshort\fP pair parameter.
 286 .SH NOTES
 287 Most applications would use \fBslk_noutrefresh\fP because a
 288 \fBwrefresh\fP is likely to follow soon.
 289 .SH PORTABILITY
 290 The XSI Curses standard, Issue 4, described the soft-key functions,
 291 with some differences from SVr4 curses:
 292 .bP
 293 It added functions like the SVr4
 294 attribute-manipulation functions \fBslk_attron\fP,
 295 \fBslk_attroff\fP, \fBslk_attrset\fP,
 296 but which use \fBattr_t\fP parameters (rather than \fBchtype\fP),
 297 along with a reserved \fIopts\fP parameter.
 298 .IP
 299 Two of these new functions (unlike the SVr4 functions) have no provision
 300 for color: \fBslk_attr_on\fP and \fBslk_attr_off\fP.
 301 .IP
 302 The third function (\fBslk_attr_set\fP) has a color-pair parameter.
 303 .bP
 304 It added \fBconst\fP qualifiers to parameters (unnecessarily), and
 305 .bP
 306 It added \fBslk_color\fP.
 307 .PP
 308 Although \fBslk_start\fP is declared in the curses header file,
 309 it was not documented by SVr4 other than its presence in a list
 310 of libtermlib.so.1 symbols.
 311 Reading the source code (i.e., Illumos):
 312 .bP
 313 \fBslk_start\fP has two parameters:
 314 .RS
 315 .bP
 316 \fIng\fP (number of groups) and
 317 .bP
 318 \fIgp\fP (group pointer).
 319 .RE
 320 .bP
 321 Soft-key groups are an array of \fIng\fP integers.
 322 .bP
 323 In SVr4, \fBslk_init\fP calls \fBslk_start\fP passing a null for \fIgp\fP.
 324 For this case, \fBslk_start\fP uses the number of groups \fIng\fP
 325 (3 for the 3-2-3 layout, 2 for the 4-4 layout) which \fBslk_init\fP provided.
 326 .IP
 327 If \fIng\fP is neither 2 or 3,
 328 \fBslk_start\fP checks the terminfo \fIfln\fP (label_format) capability,
 329 interpreting that as a comma-separated list of numbers,
 330 e.g., \*(``3,2,3\*('' for the 3-2-3 layout.
 331 .IP
 332 Finally, if there is no \fIfln\fP capability, \fBslk_start\fP returns ERR.
 333 .bP
 334 If \fBslk_start\fP is given a non-null \fIgp\fP,
 335 it copies the \fIng\fP elements of the group of soft-keys, up to 16.
 336 .IP
 337 If there are more than 16 elements, \fBslk_start\fP returns an error.
 338 .bP
 339 The format codes \fB2\fP and \fB3\fP for \fBslk_init\fP
 340 were added by ncurses in 1996.
 341 PDCurses 2.4 added this feature in 2001.
 342 .PP
 343 The function \fBslk_attr\fP was added by ncurses in 1996.
 344 .PP
 345 X/Open Curses does not specify a limit for the number of colors and
 346 color pairs which a terminal can support.
 347 However, in its use of \fBshort\fP for the parameters,
 348 it carries over SVr4's implementation detail for the compiled
 349 terminfo database, which uses signed 16-bit numbers.
 350 This implementation provides extended versions of those functions
 351 which use \fBint\fP parameters,
 352 allowing applications to use larger color- and pair-numbers.
 353 .SH SEE ALSO
 354 \fBcurses\fP(3X),
 355 \fBcurs_attr\fP(3X),
 356 \fBcurs_initscr\fP(3X),
 357 \fBcurs_refresh\fP(3X),
 358 \fBcurs_variables\fP(3X).