X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_slk.3x.html;h=e76dcc7e3f5c64043905b6c429002152dd9c2940;hp=9a0a29a4a6ef5814507b1b9ffb98090eaa9a8772;hb=ca276baf720e3a44721b9e18955d3f546955c6c8;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/doc/html/man/curs_slk.3x.html b/doc/html/man/curs_slk.3x.html index 9a0a29a4..e76dcc7e 100644 --- a/doc/html/man/curs_slk.3x.html +++ b/doc/html/man/curs_slk.3x.html @@ -1,7 +1,7 @@ @@ -40,14 +40,18 @@ 
 
+curs_slk(3x)                                               curs_slk(3x)
+
+
+

NAME

-       slk_init,     slk_set,    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 rou-
-       tines
+       slk_init, slk_set, 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
+       routines
@@ -81,11 +85,11 @@ line of stdscr, reducing the size of stdscr and the vari- able LINES. curses standardizes on eight labels of up to eight characters each. In addition to this, the ncurses - implementation supports a mode where it simulates 12 - labels of up to five characters each. This is most common + implementation supports a mode where it simulates 12 la- + bels of up to five characters each. This is most common for todays PC like enduser devices. Please note that ncurses simulates this mode by taking over up to two lines - at the bottom of the screen, it doesn't try to use any + 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 @@ -115,7 +119,7 @@ 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 @@ -133,15 +137,52 @@ line of the screen. -

RETURN VALUE

        These routines return ERR upon failure and OK (SVr4 speci-
        fies only "an integer value other than ERR") upon success-
-       ful  completion.  slk_attr  returns the attribute used for
-       the soft keys.
+       ful completion.
+
+       X/Open  defines  no error conditions.  In this implementa-
+       tion
+
+              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_attrset
+                   returns an error if the terminal or the  soft-
+                   keys were not initialized.
 
-       slk_label returns NULL on error.
+              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_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_init
+                   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
+                   range 0..2, or if memory for the labels cannot
+                   be allocated.
@@ -153,69 +194,21 @@

PORTABILITY

        The  XSI  Curses  standard, Issue 4, describes these func-
-       tions.  It changes the argument  type  of  the  attribute-
-       manipulation     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 specific to ncurses.
-
+       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-
+       cific to ncurses.

SEE ALSO

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