ncurses 6.2 - patch 20210626
[ncurses.git] / doc / html / man / curs_slk.3x.html
index c1ec8075d604b0bf477d671215ce48b2a7f7ebcb..1e4f954b474dc050e727d211e44b2a7ca0425b05 100644 (file)
 <HEAD>
 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>curs_slk 3X</TITLE>
+<TITLE>curs_slk 3x</TITLE>
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 </HEAD>
 <BODY>
-<H1 class="no-header">curs_slk 3X</H1>
+<H1 class="no-header">curs_slk 3x</H1>
 <PRE>
-<B><A HREF="curs_slk.3X.html">curs_slk(3X)</A></B>                                                      <B><A HREF="curs_slk.3X.html">curs_slk(3X)</A></B>
+<STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>                                                      <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
 
 
 
 
 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
-       <B>slk_init</B>, <B>slk_set</B>, <B>slk_wset</B>, <B>slk_refresh</B>, <B>slk_noutrefresh</B>, <B>slk_label</B>,
-       <B>slk_clear</B>, <B>slk_restore</B>, <B>slk_touch</B>, <B>slk_attron</B>, <B>slk_attrset</B>,
-       <B>slk_attroff</B>, <B>slk_attr_on</B>, <B>slk_attr_set</B>, <B>slk_attr_off</B>, <B>slk_attr</B>,
-       <B>slk_color</B>, <B>extended_slk_color</B> - <B>curses</B> soft label routines
+       <STRONG>slk_init</STRONG>, <STRONG>slk_set</STRONG>, <STRONG>slk_wset</STRONG>, <STRONG>slk_refresh</STRONG>, <STRONG>slk_noutrefresh</STRONG>, <STRONG>slk_label</STRONG>,
+       <STRONG>slk_clear</STRONG>, <STRONG>slk_restore</STRONG>, <STRONG>slk_touch</STRONG>, <STRONG>slk_attron</STRONG>, <STRONG>slk_attrset</STRONG>,
+       <STRONG>slk_attroff</STRONG>, <STRONG>slk_attr_on</STRONG>, <STRONG>slk_attr_set</STRONG>, <STRONG>slk_attr_off</STRONG>, <STRONG>slk_attr</STRONG>,
+       <STRONG>slk_color</STRONG>, <STRONG>extended_slk_color</STRONG> - <STRONG>curses</STRONG> soft label routines
 
 
 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
-       <B>#include</B> <B>&lt;curses.h&gt;</B>
+       <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
 
-       <B>int</B> <B>slk_init(int</B> <I>fmt</I><B>);</B>
+       <STRONG>int</STRONG> <STRONG>slk_init(int</STRONG> <EM>fmt</EM><STRONG>);</STRONG>
 
-       <B>int</B> <B>slk_set(int</B> <I>labnum</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>label</I><B>,</B> <B>int</B> <I>fmt</I><B>);</B>
+       <STRONG>int</STRONG> <STRONG>slk_set(int</STRONG> <EM>labnum</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>label</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>fmt</EM><STRONG>);</STRONG>
        /* extension */
-       <B>int</B> <B>slk_wset(int</B> <I>labnum</I><B>,</B> <B>const</B> <B>wchar_t</B> <B>*</B><I>label</I><B>,</B> <B>int</B> <I>fmt</I><B>);</B>
+       <STRONG>int</STRONG> <STRONG>slk_wset(int</STRONG> <EM>labnum</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>label</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>fmt</EM><STRONG>);</STRONG>
 
-       <B>char</B> <B>*slk_label(int</B> <I>labnum</I><B>);</B>
+       <STRONG>char</STRONG> <STRONG>*slk_label(int</STRONG> <EM>labnum</EM><STRONG>);</STRONG>
 
-       <B>int</B> <B>slk_refresh(void);</B>
-       <B>int</B> <B>slk_noutrefresh(void);</B>
-       <B>int</B> <B>slk_clear(void);</B>
-       <B>int</B> <B>slk_restore(void);</B>
-       <B>int</B> <B>slk_touch(void);</B>
+       <STRONG>int</STRONG> <STRONG>slk_refresh(void);</STRONG>
+       <STRONG>int</STRONG> <STRONG>slk_noutrefresh(void);</STRONG>
+       <STRONG>int</STRONG> <STRONG>slk_clear(void);</STRONG>
+       <STRONG>int</STRONG> <STRONG>slk_restore(void);</STRONG>
+       <STRONG>int</STRONG> <STRONG>slk_touch(void);</STRONG>
 
-       <B>int</B> <B>slk_attron(const</B> <B>chtype</B> <I>attrs</I><B>);</B>
-       <B>int</B> <B>slk_attroff(const</B> <B>chtype</B> <I>attrs</I><B>);</B>
-       <B>int</B> <B>slk_attrset(const</B> <B>chtype</B> <I>attrs</I><B>);</B>
-       <B>int</B> <B>slk_attr_on(attr_t</B> <I>attrs</I><B>,</B> <B>void*</B> <I>opts</I><B>);</B>
-       <B>int</B> <B>slk_attr_off(const</B> <B>attr_t</B> <I>attrs</I><B>,</B> <B>void</B> <B>*</B> <I>opts</I><B>);</B>
-       <B>int</B> <B>slk_attr_set(const</B> <B>attr_t</B> <I>attrs</I><B>,</B> <B>short</B> <I>pair</I><B>,</B> <B>void*</B> <I>opts</I><B>);</B>
+       <STRONG>int</STRONG> <STRONG>slk_attron(const</STRONG> <STRONG>chtype</STRONG> <EM>attrs</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>slk_attroff(const</STRONG> <STRONG>chtype</STRONG> <EM>attrs</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>slk_attrset(const</STRONG> <STRONG>chtype</STRONG> <EM>attrs</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>slk_attr_on(attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>void*</STRONG> <EM>opts</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>slk_attr_off(const</STRONG> <STRONG>attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG> <EM>opts</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>slk_attr_set(const</STRONG> <STRONG>attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>void*</STRONG> <EM>opts</EM><STRONG>);</STRONG>
 
-       <B>attr_t</B> <B>slk_attr(void);</B>
+       <STRONG>attr_t</STRONG> <STRONG>slk_attr(void);</STRONG>
 
-       <B>int</B> <B>slk_color(short</B> <I>pair</I><B>);</B>
+       <STRONG>int</STRONG> <STRONG>slk_color(short</STRONG> <EM>pair</EM><STRONG>);</STRONG>
        /* extension */
-       <B>int</B> <B>extended_slk_color(int</B> <I>pair</I><B>);</B>
+       <STRONG>int</STRONG> <STRONG>extended_slk_color(int</STRONG> <EM>pair</EM><STRONG>);</STRONG>
 
 
 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
        The slk* functions manipulate the set of soft function-key labels  that
        exist on many terminals.  For those terminals that do not have soft la-
-       bels, <B>curses</B> takes over the bottom line of <B>stdscr</B>, reducing the size of
-       <B>stdscr</B>  and the variable <B>LINES</B>.  <B>curses</B> standardizes on eight labels of
+       bels, <STRONG>curses</STRONG> takes over the bottom line of <STRONG>stdscr</STRONG>, reducing the size of
+       <STRONG>stdscr</STRONG>  and the variable <STRONG>LINES</STRONG>.  <STRONG>curses</STRONG> standardizes on eight labels of
        up to eight characters each.  In addition to this, the  ncurses  imple-
        mentation  supports  a  mode where it simulates 12 labels of up to five
        characters each.  This is useful for PC-like enduser devices.   ncurses
 
 
 </PRE><H3><a name="h3-Initialization">Initialization</a></H3><PRE>
-       The <B>slk_init</B> routine must  be  called  before  <B>initscr</B>  or  <B>newterm</B>  is
-       called.   If  <B>initscr</B> eventually uses a line from <B>stdscr</B> to emulate the
-       soft labels, then <I>fmt</I> determines how the labels  are  arranged  on  the
+       The <STRONG>slk_init</STRONG> routine must  be  called  before  <STRONG>initscr</STRONG>  or  <STRONG>newterm</STRONG>  is
+       called.   If  <STRONG>initscr</STRONG> eventually uses a line from <STRONG>stdscr</STRONG> to emulate the
+       soft labels, then <EM>fmt</EM> determines how the labels  are  arranged  on  the
        screen:
 
-          <B>0</B>  indicates a 3-2-3 arrangement of the labels.
+          <STRONG>0</STRONG>  indicates a 3-2-3 arrangement of the labels.
 
-          <B>1</B>  indicates a 4-4 arrangement
+          <STRONG>1</STRONG>  indicates a 4-4 arrangement
 
-          <B>2</B>  indicates the PC-like 4-4-4 mode.
+          <STRONG>2</STRONG>  indicates the PC-like 4-4-4 mode.
 
-          <B>3</B>  is again the PC-like 4-4-4 mode, but in addition an index line is
+          <STRONG>3</STRONG>  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.
 
 
 </PRE><H3><a name="h3-Labels">Labels</a></H3><PRE>
-       The <B>slk_set</B> routine (and the <B>slk_wset</B> routine  for  the  wide-character
+       The <STRONG>slk_set</STRONG> routine (and the <STRONG>slk_wset</STRONG> routine  for  the  wide-character
        library) has three parameters:
 
-          <I>labnum</I>
-               is  the  label number, from <B>1</B> to <B>8</B> (12 for <I>fmt</I> in <B>slk_init</B> is <B>2</B>
-               or <B>3</B>);
+          <EM>labnum</EM>
+               is  the  label number, from <STRONG>1</STRONG> to <STRONG>8</STRONG> (12 for <EM>fmt</EM> in <STRONG>slk_init</STRONG> is <STRONG>2</STRONG>
+               or <STRONG>3</STRONG>);
 
-          <I>label</I>
-               is be the string to put on the label, up to eight (five for <I>fmt</I>
-               in  <B>slk_init</B> is <B>2</B> or <B>3</B>) characters in length.  A null string or
+          <EM>label</EM>
+               is be the string to put on the label, up to eight (five for <EM>fmt</EM>
+               in  <STRONG>slk_init</STRONG> is <STRONG>2</STRONG> or <STRONG>3</STRONG>) characters in length.  A null string or
                a null pointer sets up a blank label.
 
-          <I>fmt</I>  is either <B>0</B>, <B>1</B>, or <B>2</B>, indicating whether the  label  is  to  be
+          <EM>fmt</EM>  is either <STRONG>0</STRONG>, <STRONG>1</STRONG>, or <STRONG>2</STRONG>, indicating whether the  label  is  to  be
                left-justified,  centered,  or  right-justified,  respectively,
                within the label.
 
-       The <B>slk_label</B> routine returns the current label for label  number  <I>lab-</I>
-       <I>num</I>, with leading and trailing blanks stripped.
+       The <STRONG>slk_label</STRONG> routine returns the current label for label  number  <EM>lab-</EM>
+       <EM>num</EM>, with leading and trailing blanks stripped.
 
 
 </PRE><H3><a name="h3-Screen-updates">Screen updates</a></H3><PRE>
-       The <B>slk_refresh</B> and <B>slk_noutrefresh</B> routines correspond to the <B>wrefresh</B>
-       and <B>wnoutrefresh</B> routines.
+       The <STRONG>slk_refresh</STRONG> and <STRONG>slk_noutrefresh</STRONG> routines correspond to the <STRONG>wrefresh</STRONG>
+       and <STRONG>wnoutrefresh</STRONG> routines.
 
-       The <B>slk_clear</B> routine clears the soft labels from the screen.
+       The <STRONG>slk_clear</STRONG> routine clears the soft labels from the screen.
 
-       The <B>slk_restore</B> routine restores the soft labels to the screen after  a
-       <B>slk_clear</B> has been performed.
+       The <STRONG>slk_restore</STRONG> routine restores the soft labels to the screen after  a
+       <STRONG>slk_clear</STRONG> has been performed.
 
-       The  <B>slk_touch</B> routine forces all the soft labels to be output the next
-       time a <B>slk_noutrefresh</B> is performed.
+       The  <STRONG>slk_touch</STRONG> routine forces all the soft labels to be output the next
+       time a <STRONG>slk_noutrefresh</STRONG> is performed.
 
 
 </PRE><H3><a name="h3-Video-attributes">Video attributes</a></H3><PRE>
-       The <B>slk_attron</B>, <B>slk_attrset</B>, <B>slk_attroff</B> and <B>slk_attr</B>  routines  corre-
-       spond  to  <B>attron</B>,  <B>attrset</B>,  <B>attroff</B> and <B>attr_get</B>, respectively.  They
+       The <STRONG>slk_attron</STRONG>, <STRONG>slk_attrset</STRONG>, <STRONG>slk_attroff</STRONG> and <STRONG>slk_attr</STRONG>  routines  corre-
+       spond  to  <STRONG>attron</STRONG>,  <STRONG>attrset</STRONG>,  <STRONG>attroff</STRONG> and <STRONG>attr_get</STRONG>, respectively.  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).
 
 
 </PRE><H3><a name="h3-Colors">Colors</a></H3><PRE>
-       The <B>slk_color</B> routine corresponds to <B>color_set</B>.  It has an effect  only
+       The <STRONG>slk_color</STRONG> routine corresponds to <STRONG>color_set</STRONG>.  It has an effect  only
        if soft labels are simulated on the bottom line of the screen.
 
-       Because  <B>slk_color</B>  accepts  only <B>short</B> (signed 16-bit integer) values,
-       this implementation provides <B>extended_slk_color</B> which accepts an  inte-
+       Because  <STRONG>slk_color</STRONG>  accepts  only <STRONG>short</STRONG> (signed 16-bit integer) values,
+       this implementation provides <STRONG>extended_slk_color</STRONG> which accepts an  inte-
        ger value, e.g., 32-bits.
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
-       These  routines return <B>ERR</B> upon failure and <B>OK</B> (SVr4 specifies only "an
-       integer value other than <B>ERR</B>") upon successful completion.
+       These  routines return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 specifies only "an
+       integer value other than <STRONG>ERR</STRONG>") upon successful completion.
 
        X/Open defines no error conditions.  In this implementation
 
-          <B>slk_attr</B>
+          <STRONG>slk_attr</STRONG>
                returns the attribute used for the soft keys.
 
-          <B>slk_attroff</B>, <B>slk_attron</B>, <B>slk_clear</B>, <B>slk_noutrefresh</B>, <B>slk_refresh</B>,
-          <B>slk_touch</B>
+          <STRONG>slk_attroff</STRONG>, <STRONG>slk_attron</STRONG>, <STRONG>slk_clear</STRONG>, <STRONG>slk_noutrefresh</STRONG>, <STRONG>slk_refresh</STRONG>,
+          <STRONG>slk_touch</STRONG>
                return  an  error if the terminal or the softkeys were not ini-
                tialized.
 
-          <B>slk_attrset</B>
+          <STRONG>slk_attrset</STRONG>
                returns an error if the terminal or the softkeys were not  ini-
                tialized.
 
-          <B>slk_attr_set</B>
+          <STRONG>slk_attr_set</STRONG>
                returns  an error if the terminal or the softkeys were not ini-
                tialized, or the  color  pair  is  outside  the  range  0..COL-
                OR_PAIRS-1.
 
-          <B>slk_color</B>
+          <STRONG>slk_color</STRONG>
                returns  an error if the terminal or the softkeys were not ini-
                tialized, or the  color  pair  is  outside  the  range  0..COL-
                OR_PAIRS-1.
 
-          <B>slk_init</B>
+          <STRONG>slk_init</STRONG>
                returns  an  error if the format parameter is outside the range
                0..3.
 
-          <B>slk_label</B>
-               returns <B>NULL</B> on error.
+          <STRONG>slk_label</STRONG>
+               returns <STRONG>NULL</STRONG> on error.
 
-          <B>slk_set</B>
+          <STRONG>slk_set</STRONG>
                returns an error if the terminal or the softkeys were not  ini-
-               tialized, or the <I>labnum</I> parameter is outside the range of label
+               tialized, or the <EM>labnum</EM> parameter 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.
 
 
 
 </PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
-       X/Open  Curses  documents the <I>opts</I> argument as reserved for future use,
+       X/Open  Curses  documents the <EM>opts</EM> argument as reserved for future use,
        saying that it must be null.  This implementation 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., <B>slk_attr_set</B>, if <I>opts</I>  is
-       set  it  is  treated  as a pointer to <B>int</B>, and used to  set  the  color
-       pair instead of the <B>short</B> pair parameter.
+       For  functions  which modify the color, e.g., <STRONG>slk_attr_set</STRONG>, if <EM>opts</EM>  is
+       set  it  is  treated  as a pointer to <STRONG>int</STRONG>, and used to  set  the  color
+       pair instead of the <STRONG>short</STRONG> pair parameter.
 
 
 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
-       Most applications would use <B>slk_noutrefresh</B> because a <B>wrefresh</B> is like-
+       Most applications would use <STRONG>slk_noutrefresh</STRONG> because a <STRONG>wrefresh</STRONG> is like-
        ly to follow soon.
 
 
        The  XSI  Curses  standard,  Issue 4, described the soft-key functions,
        with some differences from SVr4 curses:
 
-       <B>o</B>   It added functions like the SVr4  attribute-manipulation  functions
-           <B>slk_attron</B>,  <B>slk_attroff</B>, <B>slk_attrset</B>, but which use <B>attr_t</B> parame-
-           ters (rather than <B>chtype</B>), along with a reserved <I>opts</I> parameter.
+       <STRONG>o</STRONG>   It added functions like the SVr4  attribute-manipulation  functions
+           <STRONG>slk_attron</STRONG>,  <STRONG>slk_attroff</STRONG>, <STRONG>slk_attrset</STRONG>, but which use <STRONG>attr_t</STRONG> parame-
+           ters (rather than <STRONG>chtype</STRONG>), along with a reserved <EM>opts</EM> parameter.
 
            Two of these new functions (unlike the SVr4 functions) have no pro-
-           vision for color: <B>slk_attr_on</B> and <B>slk_attr_off</B>.
+           vision for color: <STRONG>slk_attr_on</STRONG> and <STRONG>slk_attr_off</STRONG>.
 
-           The third function (<B>slk_attr_set</B>) has a color-pair parameter.
+           The third function (<STRONG>slk_attr_set</STRONG>) has a color-pair parameter.
 
-       <B>o</B>   It added <B>const</B> qualifiers to parameters (unnecessarily), and
+       <STRONG>o</STRONG>   It added <STRONG>const</STRONG> qualifiers to parameters (unnecessarily), and
 
-       <B>o</B>   It added <B>slk_color</B>.
+       <STRONG>o</STRONG>   It added <STRONG>slk_color</STRONG>.
 
-       The  format  codes  <B>2</B>  and <B>3</B> for <B>slk_init</B> and the function <B>slk_attr</B> are
+       The  format  codes  <STRONG>2</STRONG>  and <STRONG>3</STRONG> for <STRONG>slk_init</STRONG> and the function <STRONG>slk_attr</STRONG> 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.  However, in its use of <B>short</B>
+       color pairs which a terminal can support.  However, in its use of <STRONG>short</STRONG>
        for the parameters, it carries over SVr4's  implementation  detail  for
        the compiled terminfo database, which uses signed 16-bit numbers.  This
        implementation provides extended versions of those functions which  use
-       <B>short</B>  parameters, allowing applications to use larger color- and pair-
+       <STRONG>short</STRONG>  parameters, allowing applications to use larger color- and pair-
        numbers.
 
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
-       <B><A HREF="curses.3X.html">curses(3X)</A></B>,    <B><A HREF="curs_attr.3X.html">curs_attr(3X)</A></B>,    <B><A HREF="curs_initscr.3X.html">curs_initscr(3X)</A></B>,    <B><A HREF="curs_refresh.3X.html">curs_refresh(3X)</A></B>,
-       <B><A HREF="curs_variables.3X.html">curs_variables(3X)</A></B>.
+       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,    <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>,    <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>,    <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>,
+       <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
 
 
 
-                                                                  <B><A HREF="curs_slk.3X.html">curs_slk(3X)</A></B>
+                                                                  <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
 </PRE>
 <div class="nav">
 <ul>