X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fhtml%2Fman%2Fcurs_slk.3x.html;h=772937b927bb5d8473d9b779ceabcf53635523c5;hb=0ac2306dd3aaab1338d8b1458c15a7e476cfc3ff;hp=0fa3049ed3813aec39ddad3c16dffdf526231264;hpb=f9d358b4f3cf9b44727a0ee5c08f8ca6ae4e3821;p=ncurses.git diff --git a/doc/html/man/curs_slk.3x.html b/doc/html/man/curs_slk.3x.html index 0fa3049e..772937b9 100644 --- a/doc/html/man/curs_slk.3x.html +++ b/doc/html/man/curs_slk.3x.html @@ -27,7 +27,7 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_slk.3x,v 1.17 2010/01/30 21:29:04 tom Exp @ + * @Id: curs_slk.3x,v 1.19 2010/09/11 22:35:11 tom Exp @ --> @@ -47,7 +47,7 @@

NAME

-       slk_init, slk_set, slk_refresh, slk_noutrefresh,
+       slk_init, slk_set, slk_wset, slk_refresh, slk_noutrefresh,
        slk_label, slk_clear, slk_restore, slk_touch, slk_attron,
        slk_attrset, slk_attroff, slk_attr_on, slk_attr_set,
        slk_attr_off, slk_attr, slk_color - curses soft label
@@ -75,6 +75,7 @@
             short color_pair_number, void* opts);
        attr_t slk_attr(void);
        int slk_color(short color_pair_number);
+       int slk_wset (int labnum, const wchar_t *label, int fmt);
@@ -107,47 +108,48 @@ an index line is generated, helping the user to identify the key numbers easily. - The slk_set routine has three parameters: + 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 + 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) + 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 la- + 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 + 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 + The slk_clear routine clears the soft labels from the screen. - The slk_restore routine restores the soft labels to the + 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 + 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 - the bottom line of the screen. The default highlight for + 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 + effect only if soft labels are simulated on the bottom line of the screen. @@ -157,7 +159,7 @@ fies only "an integer value other than ERR") upon success- ful completion. - X/Open defines no error conditions. In this implementa- + X/Open defines no error conditions. In this implementa- tion slk_attr @@ -165,36 +167,36 @@ slk_attroff, slk_attron, slk_clear, slk_noutrefresh, slk_refresh, slk_touch - return an error if the terminal or the soft- + return an error if the terminal or the soft- keys were not initialized. slk_attrset - returns an error if the terminal or the soft- + returns an error if the terminal or the soft- keys were not initialized. slk_attr_set - returns an error if the terminal or the soft- - keys were not initialized, or the color pair + 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_color - returns an error if the terminal or the soft- - keys were not initialized, or the color pair + 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_init - returns an error if the format parameter is + returns an error if the format parameter is outside the range 0..3. 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 + 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. @@ -207,17 +209,17 @@

PORTABILITY

-       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
+       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  spe-
+       2  and 3 for slk_init() and the function slk_attr are spe-
        cific to ncurses.

SEE ALSO

-       curses(3x),   curs_attr(3x),   curs_initscr(3x),  curs_re-
+       curses(3x),  curs_attr(3x),   curs_initscr(3x),   curs_re-
        fresh(3x)