X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_slk.3x.html;fp=doc%2Fhtml%2Fman%2Fcurs_slk.3x.html;h=40efdb9fb814092cd798dcf54d2c2d4e9496e217;hp=bb6758c1eed7166d07a0b1801da6d1cca892aa2a;hb=5eb177874dea59107a1a2ea44f5d8f5bb99550b2;hpb=90d42867e1296bc79021006a92032c76e59068b6 diff --git a/doc/html/man/curs_slk.3x.html b/doc/html/man/curs_slk.3x.html index bb6758c1..40efdb9f 100644 --- a/doc/html/man/curs_slk.3x.html +++ b/doc/html/man/curs_slk.3x.html @@ -1,6 +1,6 @@ @@ -57,23 +57,29 @@ #include <curses.h> int slk_init(int fmt); + int slk_set(int labnum, const char *label, int fmt); + int slk_wset(int labnum, const wchar_t *label, int fmt); + + char *slk_label(int labnum); + int slk_refresh(void); int slk_noutrefresh(void); - char *slk_label(int labnum); 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 color_pair, - void* opts); + int slk_attr_set(const attr_t attrs, short pair, void* + opts); + attr_t slk_attr(void); - int slk_color(short color_pair); - int slk_wset(int labnum, const wchar_t *label, int fmt); + + int slk_color(short pair);
@@ -85,50 +91,54 @@ eight characters each. In addition to this, the ncurses implementation supports a mode where it simulates 12 la- bels of up to five characters each. This is useful for - today's PC-like enduser devices. ncurses simulates this - mode by taking over up to two lines at the bottom of the - screen; it does not try to use any hardware support for - this mode. + PC-like enduser devices. ncurses simulates this mode by + taking over up to two lines at the bottom of the screen; + it does not try to use any hardware support for this mode. - The slk_init routine must be called before initscr or + +
+ 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: - 0 indicates a 3-2-3 arrangement of the labels. + 0 indicates a 3-2-3 arrangement of the labels. + + 1 indicates a 4-4 arrangement - 1 indicates a 4-4 arrangement + 2 indicates the PC-like 4-4-4 mode. - 2 indicates the PC-like 4-4-4 mode. + 3 is again the PC-like 4-4-4 mode, but in addition an + index line is generated, helping the user to identi- + fy the key numbers easily. - 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 +
+ The slk_set routine (and the slk_wset routine for the wide-character library) has three parameters: - labnum - is the label number, from 1 to 8 (12 for fmt - in slk_init is 2 or 3); + 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. - 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-justi- + fied, respectively, within the label. + + The slk_label routine returns the current label for label + number labnum, with leading and trailing blanks stripped. - fmt is either 0, 1, or 2, indicating whether the - label is to be left-justified, centered, or - right-justified, respectively, within the la- - bel. +
The slk_refresh and slk_noutrefresh routines correspond to the wrefresh and wnoutrefresh routines. - The slk_label routine returns the current label for label - number labnum, with leading and trailing blanks stripped. - The slk_clear routine clears the soft labels from the screen. @@ -138,6 +148,8 @@ 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 rou- tines correspond to attron, attrset, attroff and attr_get. They have an effect only if soft labels are simulated on @@ -145,6 +157,8 @@ 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. @@ -158,43 +172,41 @@ X/Open defines no error conditions. In this implementa- tion - slk_attr - returns the attribute used for the soft keys. + slk_attr + returns the attribute used for the soft keys. - slk_attroff, slk_attron, slk_clear, - slk_noutrefresh, slk_refresh, slk_touch - return an error if the terminal or the soft- - keys were not initialized. + slk_attroff, slk_attron, slk_clear, slk_noutrefresh, + slk_refresh, slk_touch + return an error if the terminal or the softkeys + were not initialized. - slk_attrset - returns an error if the terminal or the soft- - keys were not initialized. + slk_attrset + returns an error if the terminal or the softkeys + were not initialized. - slk_attr_set - returns an error if the terminal or the soft- - keys were not initialized, or the color pair - is outside the range 0..COLOR_PAIRS-1, or opts - is not null. + 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, or opts is not null. - slk_color - returns an error if the terminal or the soft- - keys were not initialized, or the color pair - is outside the range 0..COLOR_PAIRS-1. + 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. - slk_init - returns an error if the format parameter is - outside the range 0..3. + slk_init + returns an error if the format parameter is out- + side the range 0..3. - slk_label - returns NULL on error. + slk_label + returns NULL on error. - slk_set - returns an error if the terminal or the soft- - keys were not initialized, or the labnum pa- - rameter 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. + 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 for- + mat parameter is outside the range 0..2, or if + memory for the labels cannot be allocated.
@@ -203,12 +215,24 @@
- The XSI Curses standard, Issue 4, describes these func- - tions. It changes the argument type of the attribute-ma- - nipulation functions slk_attron, slk_attroff, slk_attrset - to be attr_t, and adds const qualifiers. The format codes - 2 and 3 for slk_init and the function slk_attr are specif- - ic to ncurses. + The XSI Curses standard, Issue 4, described the soft-key + functions, with some differences from SVr4 curses: + + o It added functions like the SVr4 the attribute-manipu- + lation functions slk_attron, slk_attroff, slk_attrset + which use attr_t parameters, along with a reserved + opts parameter. + + One of these new functions (slk_attr_set) also has a + color-pair parameter. + + o It added const qualifiers to parameters (unnecessari- + ly), and + + o It added slk_color. + + The format codes 2 and 3 for slk_init and the function + slk_attr are specific to ncurses.
@@ -223,7 +247,15 @@