X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_slk.3x.html;h=2a823bdef65bc71e755fad8dae69282c8f4f9de7;hp=40efdb9fb814092cd798dcf54d2c2d4e9496e217;hb=3eda6f30a84d53844d2ebceadb457e2e7e9cfbf3;hpb=2e68dc325852af56f2ec6c315b323a4f9c3d62c9 diff --git a/doc/html/man/curs_slk.3x.html b/doc/html/man/curs_slk.3x.html index 40efdb9f..2a823bde 100644 --- a/doc/html/man/curs_slk.3x.html +++ b/doc/html/man/curs_slk.3x.html @@ -26,7 +26,7 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_slk.3x,v 1.29 2017/03/18 01:00:30 tom Exp @ + * @Id: curs_slk.3x,v 1.31 2017/03/31 11:09:28 tom Exp @ --> @@ -49,19 +49,19 @@ 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 - routines + slk_attr_off, slk_attr, slk_color, extended_slk_color - + curses soft label routines

SYNOPSIS

        #include <curses.h>
 
-       int slk_init(int fmt);
+       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);
+       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);
+       char *slk_label(int labnum);
 
        int slk_refresh(void);
        int slk_noutrefresh(void);
@@ -69,17 +69,19 @@
        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);
+       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);
+       int slk_color(short pair);
+       /* extension */
+       int extended_slk_color(int pair);

DESCRIPTION

@@ -163,13 +165,18 @@
        effect  only  if  soft  labels are simulated on the bottom
        line of the screen.
 
+       Because slk_color accepts only short (signed 16-bit  inte-
+       ger)   values,   this   implementation   provides  extend-
+       ed_slk_color  which  accepts  an  integer   value,   e.g.,
+       32-bits.
+

RETURN VALUE

        These routines return ERR upon failure and OK (SVr4 speci-
        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
@@ -177,38 +184,51 @@
 
           slk_attroff, slk_attron, slk_clear, slk_noutrefresh,
           slk_refresh, slk_touch
-               return an error if the terminal  or  the  softkeys
+               return  an  error  if the terminal or the softkeys
                were not initialized.
 
           slk_attrset
-               returns  an  error if the terminal or the softkeys
+               returns an error if the terminal or  the  softkeys
                were not initialized.
 
           slk_attr_set
-               returns an error if the terminal or  the  softkeys
+               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.
+               the range 0..COLOR_PAIRS-1.
 
           slk_color
-               returns an error if the terminal or  the  softkeys
+               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  out-
+               returns  an  error if the format parameter is out-
                side the range 0..3.
 
           slk_label
                returns NULL on error.
 
           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
+               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.
 
 
+

EXTENSIONS

+       X/Open Curses documents the opts argument as reserved  for
+       future use, saying that it must be null.  This implementa-
+       tion 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_at-
+       tr_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.
+
+

NOTES

        Most applications would use slk_noutrefresh because a wre-
        fresh is likely to follow soon.
@@ -218,13 +238,17 @@
        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.
+       o   It  added  functions like the SVr4 attribute-manipula-
+           tion functions slk_attron,  slk_attroff,  slk_attrset,
+           but  which use attr_t parameters (rather than chtype),
+           along with a reserved opts parameter.
+
+           Two of these new functions (unlike the SVr4 functions)
+           have  no  provision for color: slk_attr_on and slk_at-
+           tr_off.
 
-           One of these new functions (slk_attr_set) also  has  a
-           color-pair parameter.
+           The third function (slk_attr_set) has a color-pair pa-
+           rameter.
 
        o   It  added const qualifiers to parameters (unnecessari-
            ly), and
@@ -234,9 +258,18 @@
        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.  How-
+       ever,  in  its use of short for the parameters, it carries
+       over SVr4's implementation detail for the compiled termin-
+       fo  database,  which uses signed 16-bit numbers.  This im-
+       plementation provides extended versions of those functions
+       which  use  short parameters, allowing applications to use
+       larger color- and pair-numbers.
+

SEE ALSO

-       curses(3x),   curs_attr(3x),   curs_initscr(3x),  curs_re-
+       curses(3x),  curs_attr(3x),   curs_initscr(3x),   curs_re-
        fresh(3x), curs_variables(3x).
 
 
@@ -257,6 +290,7 @@
 
 
 
  • RETURN VALUE
    • 
+
  • EXTENSIONS
    • 
 
  • NOTES
    • 
 
  • PORTABILITY
    • 
 
  • SEE ALSO
    •