ncurses 6.0 - patch 20160514
[ncurses.git] / man / curs_slk.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2007,2010 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: curs_slk.3x,v 1.22 2010/12/04 18:38:55 tom Exp $
30 .TH curs_slk 3X ""
31 .na
32 .hy 0
33 .SH NAME
34 \fBslk_init\fR,
35 \fBslk_set\fR,
36 \fBslk_wset\fR,
37 \fBslk_refresh\fR,
38 \fBslk_noutrefresh\fR,
39 \fBslk_label\fR,
40 \fBslk_clear\fR,
41 \fBslk_restore\fR,
42 \fBslk_touch\fR,
43 \fBslk_attron\fR,
44 \fBslk_attrset\fR,
45 \fBslk_attroff\fR,
46 \fBslk_attr_on\fR,
47 \fBslk_attr_set\fR,
48 \fBslk_attr_off\fR,
49 \fBslk_attr\fR,
50 \fBslk_color\fR \- \fBcurses\fR soft label routines
51 .ad
52 .hy
53 .SH SYNOPSIS
54 \fB#include <curses.h>\fR
55 .sp
56 \fBint slk_init(int fmt);\fR
57 .br
58 \fBint slk_set(int labnum, const char *label, int fmt);\fR
59 .br
60 \fBint slk_refresh(void);\fR
61 .br
62 \fBint slk_noutrefresh(void);\fR
63 .br
64 \fBchar *slk_label(int labnum);\fR
65 .br
66 \fBint slk_clear(void);\fR
67 .br
68 \fBint slk_restore(void);\fR
69 .br
70 \fBint slk_touch(void);\fR
71 .br
72 \fBint slk_attron(const chtype attrs);\fR
73 .br
74 \fBint slk_attroff(const chtype attrs);\fR
75 .br
76 \fBint slk_attrset(const chtype attrs);\fR
77 .br
78 \fBint slk_attr_on(attr_t attrs, void* opts);\fR
79 .br
80 \fBint slk_attr_off(const attr_t attrs, void * opts);\fR
81 .br
82 \fBint slk_attr_set(const attr_t attrs, short color_pair, void* opts);\fR
83 .br
84 \fBattr_t slk_attr(void);\fR
85 .br
86 \fBint slk_color(short color_pair);\fR
87 .br
88 \fBint slk_wset(int labnum, const wchar_t *label, int fmt);\fR
89 .br
90 .SH DESCRIPTION
91 The slk* functions manipulate the set of soft function-key labels that exist on
92 many terminals.
93 For those terminals that do not have soft labels,
94 \fBcurses\fR takes over the bottom line of \fBstdscr\fR, reducing the size of
95 \fBstdscr\fR and the variable \fBLINES\fR.
96 \fBcurses\fR standardizes on eight
97 labels of up to eight characters each.
98 In addition to this, the ncurses
99 implementation supports a mode where it simulates 12 labels of up to five
100 characters each.
101 This is useful for today's PC-like enduser devices.
102 ncurses simulates this mode by taking over up to two lines at
103 the bottom of the screen;
104 it does not try to use any hardware support for this
105 mode.
106 .PP
107 The \fBslk_init\fR routine must be called before \fBinitscr\fR or \fBnewterm\fR
108 is called.
109 If \fBinitscr\fR eventually uses a line from \fBstdscr\fR to
110 emulate the soft labels,
111 then \fIfmt\fR determines how the labels are arranged on the screen:
112 .RS
113 .TP 3
114 .B 0
115 indicates a 3\-2\-3 arrangement of
116 the labels.
117 .TP 3
118 .B 1
119 indicates a 4\-4 arrangement
120 .TP 3
121 .B 2
122 indicates the PC-like 4\-4\-4 mode.
123 .TP 3
124 .B 3
125 is again the PC-like 4\-4\-4 mode,
126 but in addition an index line is generated, helping the user to
127 identify the key numbers easily.
128 .RE
129 .PP
130 The \fBslk_set\fR routine
131 (and the \fBslk_wset\fR routine for the wide-character library)
132 has three parameters:
133 .RS
134 .TP 5
135 .I labnum
136 is the label number, from \fB1\fR to \fB8\fR
137 (12 for \fIfmt\fP in \fBslk_init\fP is \fB2\fP or \fB3\fP);
138 .TP
139 .I label
140 is be the string to put on the label,
141 up to eight
142 (five for \fIfmt\fP in \fBslk_init\fP is \fB2\fP or \fB3\fP)
143 characters in length.
144 A null string or a null pointer sets up a blank label.
145 .TP
146 .I fmt
147 is either
148 \fB0\fR, \fB1\fR, or \fB2\fR, indicating whether the label is to be
149 left-justified, centered, or right-justified, respectively, within the
150 label.
151 .RE
152 .PP
153 The \fBslk_refresh\fR and \fBslk_noutrefresh\fR routines correspond to
154 the \fBwrefresh\fR and \fBwnoutrefresh\fR routines.
155 .PP
156 The \fBslk_label\fR routine returns the current label for label number
157 \fIlabnum\fR, with leading and trailing blanks stripped.
158 .PP
159 The \fBslk_clear\fR routine clears the soft labels from the screen.
160 .PP
161 The \fBslk_restore\fR routine restores the soft labels to the screen
162 after a \fBslk_clear\fR has been performed.
163 .PP
164 The \fBslk_touch\fR routine forces all the soft labels to be output
165 the next time a \fBslk_noutrefresh\fR is performed.
166 .PP
167 The \fBslk_attron\fR, \fBslk_attrset\fR, \fBslk_attroff\fR and \fBslk_attr\fR
168 routines correspond to \fBattron\fR, \fBattrset\fR, \fBattroff\fR and \fBattr_get\fR.
169 They have an effect only if soft labels are simulated on the bottom line of
170 the screen.
171 The default highlight for soft keys is A_STANDOUT (as in
172 System V curses, which does not document this fact).
173 .PP
174 The \fBslk_color\fR routine corresponds to \fBcolor_set\fR.
175 It has an effect only
176 if soft labels are simulated on the bottom line of the screen.
177 .
178 .SH RETURN VALUE
179 These routines return \fBERR\fR upon failure and OK (SVr4 specifies only "an
180 integer value other than \fBERR\fR") upon successful completion.
181 .PP
182 X/Open defines no error conditions.
183 In this implementation
184 .RS
185 .TP 5
186 \fBslk_attr\fR
187 returns the attribute used for the soft keys.
188 .TP 5
189 .na
190 .hy 0
191 \fBslk_attroff\fP, \fBslk_attron\fP, \fBslk_clear\fP, \fBslk_noutrefresh\fP, \fBslk_refresh\fP, \fBslk_touch\fP
192 .ad
193 .hy
194 return an error
195 if the terminal or the softkeys were not initialized.
196 .TP 5
197 \fBslk_attrset\fP
198 returns an error
199 if the terminal or the softkeys were not initialized.
200 .TP 5
201 \fBslk_attr_set\fP
202 returns an error
203 if the terminal or the softkeys were not initialized, or
204 the color pair is outside the range 0..COLOR_PAIRS\-1,
205 or opts is not null.
206 .TP 5
207 \fBslk_color\fP
208 returns an error
209 if the terminal or the softkeys were not initialized, or
210 the color pair is outside the range 0..COLOR_PAIRS\-1.
211 .TP 5
212 \fBslk_init\fR
213 returns an error
214 if the format parameter is outside the range 0..3.
215 .TP 5
216 \fBslk_label\fR
217 returns \fBNULL\fR on error.
218 .TP 5
219 \fBslk_set\fP
220 returns an error
221 if the terminal or the softkeys were not initialized, or
222 the \fIlabnum\fP parameter is outside the range of label counts, or
223 if the format parameter is outside the range 0..2, or if
224 memory for the labels cannot be allocated.
225 .RE
226 .SH NOTES
227 Most applications would use \fBslk_noutrefresh\fR because a
228 \fBwrefresh\fR is likely to follow soon.
229 .SH PORTABILITY
230 The XSI Curses standard, Issue 4, describes these functions.
231 It changes the
232 argument type of the attribute-manipulation functions \fBslk_attron\fR,
233 \fBslk_attroff\fR, \fBslk_attrset\fR to be \fBattr_t\fR, and adds \fBconst\fR
234 qualifiers.
235 The format codes \fB2\fR and \fB3\fR for \fBslk_init()\fR and the
236 function \fBslk_attr\fR are specific to ncurses.
237 .SH SEE ALSO
238 \fBcurses\fR(3X),
239 \fBcurs_attr\fR(3X),
240 \fBcurs_initscr\fR(3X),
241 \fBcurs_refresh\fR(3X),
242 \fBcurs_variables\fR(3X).