X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_slk.3x.html;h=d2f0d98c9fa717916c1c247fd5fb65d2dbe27687;hp=72ceb115fc9080c50060e61be1dba8efa658e2a6;hb=refs%2Ftags%2Fv5.5;hpb=a8987e73ec254703634802b4f7ee30d3a485524d
diff --git a/doc/html/man/curs_slk.3x.html b/doc/html/man/curs_slk.3x.html
index 72ceb115..d2f0d98c 100644
--- a/doc/html/man/curs_slk.3x.html
+++ b/doc/html/man/curs_slk.3x.html
@@ -1,7 +1,7 @@
@@ -40,18 +40,18 @@
-curs_slk(3x) curs_slk(3x)
+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
@@ -85,8 +85,8 @@
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
@@ -142,10 +142,48 @@
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.
- slk_label returns NULL on error.
+ 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_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.
@@ -157,21 +195,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)
+ curs_slk(3x)