3c9e054abafaf52cb2e20bfab06326b3803edbb8
[ncurses.git] / doc / html / man / curs_slk.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: curs_slk.3x,v 1.22 2010/12/04 18:38:55 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_slk 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">curs_slk 3x</H1>
42 <PRE>
43 <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>                                               <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
44
45
46
47
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        <STRONG>slk_init</STRONG>, <STRONG>slk_set</STRONG>, <STRONG>slk_wset</STRONG>, <STRONG>slk_refresh</STRONG>, <STRONG>slk_noutrefresh</STRONG>,
50        <STRONG>slk_label</STRONG>, <STRONG>slk_clear</STRONG>, <STRONG>slk_restore</STRONG>, <STRONG>slk_touch</STRONG>, <STRONG>slk_attron</STRONG>,
51        <STRONG>slk_attrset</STRONG>, <STRONG>slk_attroff</STRONG>, <STRONG>slk_attr_on</STRONG>, <STRONG>slk_attr_set</STRONG>,
52        <STRONG>slk_attr_off</STRONG>, <STRONG>slk_attr</STRONG>, <STRONG>slk_color</STRONG> - <STRONG>curses</STRONG> soft label
53        routines
54
55
56 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
57        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
58
59        <STRONG>int</STRONG> <STRONG>slk_init(int</STRONG> <STRONG>fmt);</STRONG>
60        <STRONG>int</STRONG> <STRONG>slk_set(int</STRONG> <STRONG>labnum,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*label,</STRONG> <STRONG>int</STRONG> <STRONG>fmt);</STRONG>
61        <STRONG>int</STRONG> <STRONG>slk_refresh(void);</STRONG>
62        <STRONG>int</STRONG> <STRONG>slk_noutrefresh(void);</STRONG>
63        <STRONG>char</STRONG> <STRONG>*slk_label(int</STRONG> <STRONG>labnum);</STRONG>
64        <STRONG>int</STRONG> <STRONG>slk_clear(void);</STRONG>
65        <STRONG>int</STRONG> <STRONG>slk_restore(void);</STRONG>
66        <STRONG>int</STRONG> <STRONG>slk_touch(void);</STRONG>
67        <STRONG>int</STRONG> <STRONG>slk_attron(const</STRONG> <STRONG>chtype</STRONG> <STRONG>attrs);</STRONG>
68        <STRONG>int</STRONG> <STRONG>slk_attroff(const</STRONG> <STRONG>chtype</STRONG> <STRONG>attrs);</STRONG>
69        <STRONG>int</STRONG> <STRONG>slk_attrset(const</STRONG> <STRONG>chtype</STRONG> <STRONG>attrs);</STRONG>
70        <STRONG>int</STRONG> <STRONG>slk_attr_on(attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void*</STRONG> <STRONG>opts);</STRONG>
71        <STRONG>int</STRONG> <STRONG>slk_attr_off(const</STRONG> <STRONG>attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG> <STRONG>opts);</STRONG>
72        <STRONG>int</STRONG>  <STRONG>slk_attr_set(const</STRONG>  <STRONG>attr_t</STRONG>  <STRONG>attrs,</STRONG>  <STRONG>short</STRONG> <STRONG>color_pair,</STRONG>
73        <STRONG>void*</STRONG> <STRONG>opts);</STRONG>
74        <STRONG>attr_t</STRONG> <STRONG>slk_attr(void);</STRONG>
75        <STRONG>int</STRONG> <STRONG>slk_color(short</STRONG> <STRONG>color_pair);</STRONG>
76        <STRONG>int</STRONG> <STRONG>slk_wset(int</STRONG> <STRONG>labnum,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*label,</STRONG> <STRONG>int</STRONG> <STRONG>fmt);</STRONG>
77
78
79 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
80        The slk* functions manipulate the set of soft function-key
81        labels  that exist on many terminals.  For those terminals
82        that do not have soft labels, <STRONG>curses</STRONG> takes over the bottom
83        line  of <STRONG>stdscr</STRONG>, reducing the size of <STRONG>stdscr</STRONG> and the vari-
84        able <STRONG>LINES</STRONG>.  <STRONG>curses</STRONG> standardizes on eight labels of up  to
85        eight  characters  each.  In addition to this, the ncurses
86        implementation supports a mode where it simulates  12  la-
87        bels  of  up  to five characters each.  This is useful for
88        today's PC-like enduser devices.  ncurses  simulates  this
89        mode  by  taking over up to two lines at the bottom of the
90        screen; it does not try to use any  hardware  support  for
91        this mode.
92
93        The  <STRONG>slk_init</STRONG>  routine  must  be  called before <STRONG>initscr</STRONG> or
94        <STRONG>newterm</STRONG> is called.  If <STRONG>initscr</STRONG> eventually uses a line from
95        <STRONG>stdscr</STRONG> to emulate the soft labels, then <EM>fmt</EM> determines how
96        the labels are arranged on the screen:
97
98               <STRONG>0</STRONG>  indicates a 3-2-3 arrangement of the labels.
99
100               <STRONG>1</STRONG>  indicates a 4-4 arrangement
101
102               <STRONG>2</STRONG>  indicates the PC-like 4-4-4 mode.
103
104               <STRONG>3</STRONG>  is again the PC-like 4-4-4 mode, but in addition
105                  an  index line is generated, helping the user to
106                  identify the key numbers easily.
107
108        The <STRONG>slk_set</STRONG> routine (and  the  <STRONG>slk_wset</STRONG>  routine  for  the
109        wide-character library) has three parameters:
110
111               <EM>labnum</EM>
112                    is  the  label number, from <STRONG>1</STRONG> to <STRONG>8</STRONG> (12 for <EM>fmt</EM>
113                    in <STRONG>slk_init</STRONG> is <STRONG>2</STRONG> or <STRONG>3</STRONG>);
114
115               <EM>label</EM>
116                    is be the string to put on the  label,  up  to
117                    eight  (five  for  <EM>fmt</EM>  in <STRONG>slk_init</STRONG> is <STRONG>2</STRONG> or <STRONG>3</STRONG>)
118                    characters in length.  A null string or a null
119                    pointer sets up a blank label.
120
121               <EM>fmt</EM>  is  either  <STRONG>0</STRONG>, <STRONG>1</STRONG>, or <STRONG>2</STRONG>, indicating whether the
122                    label is to be  left-justified,  centered,  or
123                    right-justified,  respectively, within the la-
124                    bel.
125
126        The <STRONG>slk_refresh</STRONG> and <STRONG>slk_noutrefresh</STRONG> routines correspond to
127        the <STRONG>wrefresh</STRONG> and <STRONG>wnoutrefresh</STRONG> routines.
128
129        The  <STRONG>slk_label</STRONG> routine returns the current label for label
130        number <EM>labnum</EM>, with leading and trailing blanks stripped.
131
132        The <STRONG>slk_clear</STRONG> routine clears  the  soft  labels  from  the
133        screen.
134
135        The  <STRONG>slk_restore</STRONG>  routine  restores the soft labels to the
136        screen after a <STRONG>slk_clear</STRONG> has been performed.
137
138        The <STRONG>slk_touch</STRONG> routine forces all the  soft  labels  to  be
139        output the next time a <STRONG>slk_noutrefresh</STRONG> is performed.
140
141        The <STRONG>slk_attron</STRONG>, <STRONG>slk_attrset</STRONG>, <STRONG>slk_attroff</STRONG> and <STRONG>slk_attr</STRONG> rou-
142        tines correspond to <STRONG>attron</STRONG>, <STRONG>attrset</STRONG>, <STRONG>attroff</STRONG> and <STRONG>attr_get</STRONG>.
143        They  have  an effect only if soft labels are simulated on
144        the bottom line of the screen.  The default highlight  for
145        soft keys is A_STANDOUT (as in System V curses, which does
146        not document this fact).
147
148        The <STRONG>slk_color</STRONG> routine corresponds to <STRONG>color_set</STRONG>.  It has an
149        effect  only  if  soft  labels are simulated on the bottom
150        line of the screen.
151
152
153 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
154        These routines return <STRONG>ERR</STRONG> upon failure and OK (SVr4 speci-
155        fies only "an integer value other than <STRONG>ERR</STRONG>") upon success-
156        ful completion.
157
158        X/Open defines no error conditions.  In  this  implementa-
159        tion
160
161               <STRONG>slk_attr</STRONG>
162                    returns the attribute used for the soft keys.
163
164               <STRONG>slk_attroff</STRONG>, <STRONG>slk_attron</STRONG>, <STRONG>slk_clear</STRONG>,
165               <STRONG>slk_noutrefresh</STRONG>, <STRONG>slk_refresh</STRONG>, <STRONG>slk_touch</STRONG>
166                    return an error if the terminal or  the  soft-
167                    keys were not initialized.
168
169               <STRONG>slk_attrset</STRONG>
170                    returns  an error if the terminal or the soft-
171                    keys were not initialized.
172
173               <STRONG>slk_attr_set</STRONG>
174                    returns an error if the terminal or the  soft-
175                    keys  were  not initialized, or the color pair
176                    is outside the range 0..COLOR_PAIRS-1, or opts
177                    is not null.
178
179               <STRONG>slk_color</STRONG>
180                    returns  an error if the terminal or the soft-
181                    keys were not initialized, or the  color  pair
182                    is outside the range 0..COLOR_PAIRS-1.
183
184               <STRONG>slk_init</STRONG>
185                    returns  an  error  if the format parameter is
186                    outside the range 0..3.
187
188               <STRONG>slk_label</STRONG>
189                    returns <STRONG>NULL</STRONG> on error.
190
191               <STRONG>slk_set</STRONG>
192                    returns an error if the terminal or the  soft-
193                    keys  were  not initialized, or the <EM>labnum</EM> pa-
194                    rameter is outside the range of label  counts,
195                    or  if  the  format  parameter  is outside the
196                    range 0..2, or if memory for the labels cannot
197                    be allocated.
198
199
200 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
201        Most applications would use <STRONG>slk_noutrefresh</STRONG> because a <STRONG>wre-</STRONG>
202        <STRONG>fresh</STRONG> is likely to follow soon.
203
204
205 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
206        The XSI Curses standard, Issue 4,  describes  these  func-
207        tions.   It changes the argument type of the attribute-ma-
208        nipulation functions <STRONG>slk_attron</STRONG>, <STRONG>slk_attroff</STRONG>,  <STRONG>slk_attrset</STRONG>
209        to be <STRONG>attr_t</STRONG>, and adds <STRONG>const</STRONG> qualifiers.  The format codes
210        <STRONG>2</STRONG> and <STRONG>3</STRONG> for <STRONG>slk_init()</STRONG> and the function <STRONG>slk_attr</STRONG> are  spe-
211        cific to ncurses.
212
213
214 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
215        <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>curs_re-</STRONG>
216        <STRONG><A HREF="curs_refresh.3x.html">fresh(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
217
218
219
220                                                            <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
221 </PRE>
222 <div class="nav">
223 <ul>
224 <li><a href="#h2-NAME">NAME</a></li>
225 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
226 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
227 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
228 <li><a href="#h2-NOTES">NOTES</a></li>
229 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
230 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
231 </ul>
232 </div>
233 </BODY>
234 </HTML>