Copyright 2018,2020 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 *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************
$Id: curs_slk.3x,v 1.37 2020/12/30 18:37:43 tom Exp $
/* extension */
int slk_wset(int labnum, const wchar_t *label, int fmt); char *slk_label(int labnum); int slk_refresh(void);
int slk_noutrefresh(void);
int slk_clear(void);
int slk_restore(void);
int slk_touch(void); int slk_attron(const chtype attrs);
int slk_attroff(const chtype attrs);
int slk_attrset(const chtype attrs);
int slk_attr_on(attr_t attrs, void* opts);
int slk_attr_off(const attr_t attrs, void * opts);
int slk_attr_set(const attr_t attrs, short pair, void* opts); attr_t slk_attr(void); int slk_color(short pair);
/* extension */
int extended_slk_color(int pair);
The slk_init routine must be called before initscr or newterm is called. If initscr eventually uses a line from stdscr to emulate the soft labels, then fmt determines how the labels are arranged on the screen:
3 0 indicates a 3-2-3 arrangement of the labels.
3 1 indicates a 4-4 arrangement
3 2 indicates the PC-like 4-4-4 mode.
3 3 is again the PC-like 4-4-4 mode, but in addition an index line is generated, helping the user to identify the key numbers easily.
The slk_set routine (and the slk_wset routine for the wide-character library) has three parameters:
5 labnum is the label number, from 1 to 8 (12 for fmt in slk_init is 2 or 3);
label is be the string to put on the label, up to eight (five for fmt in slk_init is 2 or 3) characters in length. A null string or a null pointer sets up a blank label.
fmt is either 0, 1, or 2, indicating whether the label is to be left-justified, centered, or right-justified, respectively, within the label.
The slk_label routine returns the current label for label number labnum, with leading and trailing blanks stripped.
The slk_refresh and slk_noutrefresh routines correspond to the wrefresh and wnoutrefresh routines.
The slk_clear routine clears the soft labels from the screen.
The slk_restore routine restores the soft labels to the screen after a slk_clear has been performed.
The slk_touch routine forces all the soft labels to be output the next time a slk_noutrefresh is performed.
The slk_attron, slk_attrset, slk_attroff and slk_attr routines correspond to attron, attrset, attroff and attr_get, 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).
The slk_color routine corresponds to color_set. It has an effect only if soft labels are simulated on the bottom line of the screen.
Because slk_color accepts only short (signed 16-bit integer) values, this implementation provides extended_slk_color which accepts an integer value, e.g., 32-bits. .
X/Open defines no error conditions. In this implementation
5 slk_attr returns the attribute used for the soft keys.
5 slk_attroff, slk_attron, slk_clear, slk_noutrefresh, slk_refresh, slk_touch return an error if the terminal or the softkeys were not initialized.
5 slk_attrset returns an error if the terminal or the softkeys were not initialized.
5 slk_attr_set returns an error if the terminal or the softkeys were not initialized, or the color pair is outside the range 0..COLOR_PAIRS-1.
5 slk_color returns an error if the terminal or the softkeys were not initialized, or the color pair is outside the range 0..COLOR_PAIRS-1.
5 slk_init returns an error if the format parameter is outside the range 0..3.
5 slk_label returns NULL on error.
5 slk_set returns an error if the terminal or the softkeys were not initialized, or the labnum 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.
SVr4 added these functions: slk_attroff slk_attron slk_attrset slk_start
X/Open Curses added these: slk_attr_off slk_attr_on slk_attr_set slk_color slk_wset
X/Open Curses documents the opts 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 parameter to support extended color pairs.
For functions which modify the color, e.g., slk_attr_set, if opts is set it is treated as a pointer to int, and used to set the color pair instead of the short pair parameter.
The format codes 2 and 3 for slk_init and the function slk_attr are specific to ncurses.
X/Open Curses does not specify a limit for the number of colors and color pairs which a terminal can support. However, in its use of short for the parameters, it carries over SVr4's implementation detail for the compiled terminfo database, which uses signed 16-bit numbers. This implementation provides extended versions of those functions which use short parameters, allowing applications to use larger color- and pair-numbers.