ncurses 5.7 - patch 20090221
[ncurses.git] / man / curs_slk.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2006,2007 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.16 2007/06/02 20:40:07 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_refresh\fR,
37 \fBslk_noutrefresh\fR,
38 \fBslk_label\fR,
39 \fBslk_clear\fR,
40 \fBslk_restore\fR,
41 \fBslk_touch\fR,
42 \fBslk_attron\fR,
43 \fBslk_attrset\fR,
44 \fBslk_attroff\fR,
45 \fBslk_attr_on\fR,
46 \fBslk_attr_set\fR,
47 \fBslk_attr_off\fR,
48 \fBslk_attr\fR,
49 \fBslk_color\fR - \fBcurses\fR soft label routines
50 .ad
51 .hy
52 .SH SYNOPSIS
53 \fB#include <curses.h>\fR
54 .sp
55 \fBint slk_init(int fmt);\fR
56 .br
57 \fBint slk_set(int labnum, const char *label, int fmt);\fR
58 .br
59 \fBint slk_refresh(void);\fR
60 .br
61 \fBint slk_noutrefresh(void);\fR
62 .br
63 \fBchar *slk_label(int labnum);\fR
64 .br
65 \fBint slk_clear(void);\fR
66 .br
67 \fBint slk_restore(void);\fR
68 .br
69 \fBint slk_touch(void);\fR
70 .br
71 \fBint slk_attron(const chtype attrs);\fR
72 .br
73 \fBint slk_attroff(const chtype attrs);\fR
74 .br
75 \fBint slk_attrset(const chtype attrs);\fR
76 .br
77 \fBint slk_attr_on(attr_t attrs, void* opts);\fR
78 .br
79 \fBint slk_attr_off(const attr_t attrs, void * opts);\fR
80 .br
81 \fBint slk_attr_set(const attr_t attrs,\fR
82 .br
83         \fBshort color_pair_number, void* opts);\fR
84 .br
85 \fBattr_t slk_attr(void);\fR
86 .br
87 \fBint slk_color(short color_pair_number);\fR
88 .br
89 .SH DESCRIPTION
90 The slk* functions manipulate the set of soft function-key labels that exist on
91 many terminals.  For those terminals that do not have soft labels,
92 \fBcurses\fR takes over the bottom line of \fBstdscr\fR, reducing the size of
93 \fBstdscr\fR and the variable \fBLINES\fR.  \fBcurses\fR standardizes on eight
94 labels of up to eight characters each. In addition to this, the ncurses
95 implementation supports a mode where it simulates 12 labels of up to five
96 characters each. This is most common for todays PC like enduser devices.
97 Please note that ncurses simulates this mode by taking over up to two lines at
98 the bottom of the screen, it does not try to use any hardware support for this
99 mode.
100 .PP
101 The \fBslk_init\fR routine must be called before \fBinitscr\fR or \fBnewterm\fR
102 is called.  If \fBinitscr\fR eventually uses a line from \fBstdscr\fR to
103 emulate the soft labels, then \fIfmt\fR determines how the labels are arranged
104 on the screen.  Setting \fIfmt\fR to \fB0\fR indicates a 3-2-3 arrangement of
105 the labels, \fB1\fR indicates a 4-4 arrangement and \fB2\fR indicates the
106 PC like 4-4-4 mode. If \fBfmt\fR is set to \fB3\fR, it is again the PC like
107 4-4-4 mode, but in addition an index line is generated, helping the user to
108 identify the key numbers easily.
109 .PP
110 The \fBslk_set\fR routine requires \fIlabnum\fR to be a label number,
111 from \fB1\fR to \fB8\fR (resp. \fB12\fR); \fIlabel\fR must be the string
112 to be put on the label, up to eight (resp. five) characters in length.
113 A null string or a null pointer sets up a blank label. \fIfmt\fR is either
114 \fB0\fR, \fB1\fR, or \fB2\fR, indicating whether the label is  to be
115 left-justified, centered, or right-justified, respectively, within the
116 label.
117 .PP
118 The \fBslk_refresh\fR and \fBslk_noutrefresh\fR routines correspond to
119 the \fBwrefresh\fR and \fBwnoutrefresh\fR routines.
120 .PP
121 The \fBslk_label\fR routine returns the current label for label number
122 \fIlabnum\fR, with leading and trailing blanks stripped.
123 .PP
124 The \fBslk_clear\fR routine clears the soft labels from the screen.
125 .PP
126 The \fBslk_restore\fR routine restores the soft labels to the screen
127 after a \fBslk_clear\fR has been performed.
128 .PP
129 The \fBslk_touch\fR routine forces all the soft labels to be output
130 the next time a \fBslk_noutrefresh\fR is performed.
131 .PP
132 The \fBslk_attron\fR, \fBslk_attrset\fR, \fBslk_attroff\fR and \fBslk_attr\fR
133 routines correspond to \fBattron\fR, \fBattrset\fR, \fBattroff\fR and \fBattr_get\fR.
134 They have an effect only if soft labels are simulated on the bottom line of
135 the screen.  The default highlight for soft keys is A_STANDOUT (as in
136 System V curses, which does not document this fact).
137 .PP
138 The \fBslk_color\fR routine corresponds to \fBcolor_set\fR. It has an effect only
139 if soft labels are simulated on the bottom line of the screen.
140 .
141 .SH RETURN VALUE
142 These routines return \fBERR\fR upon failure and OK (SVr4 specifies only "an
143 integer value other than \fBERR\fR") upon successful completion.
144 .PP
145 X/Open defines no error conditions.
146 In this implementation
147 .RS
148 .TP 5
149 \fBslk_attr\fR
150 returns the attribute used for the soft keys.
151 .TP 5
152 .na
153 .hy 0
154 \fBslk_attroff\fP, \fBslk_attron\fP, \fBslk_clear\fP, \fBslk_noutrefresh\fP, \fBslk_refresh\fP, \fBslk_touch\fP
155 .ad
156 .hy
157 return an error
158 if the terminal or the softkeys were not initialized.
159 .TP 5
160 \fBslk_attrset\fP
161 returns an error
162 if the terminal or the softkeys were not initialized.
163 .TP 5
164 \fBslk_attr_set\fP
165 returns an error
166 if the terminal or the softkeys were not initialized, or
167 the color pair is outside the range 0..COLOR_PAIRS-1,
168 or opts is not null.
169 .TP 5
170 \fBslk_color\fP
171 returns an error
172 if the terminal or the softkeys were not initialized, or
173 the color pair is outside the range 0..COLOR_PAIRS-1.
174 .TP 5
175 \fBslk_init\fR
176 returns an error
177 if the format parameter is outside the range 0..3.
178 .TP 5
179 \fBslk_label\fR
180 returns \fBNULL\fR on error.
181 .TP 5
182 \fBslk_set\fP
183 returns an error
184 if the terminal or the softkeys were not initialized, or
185 the \fIlabnum\fP parameter is outside the range of label counts, or
186 if the format parameter is outside the range 0..2, or if
187 memory for the labels cannot be allocated.
188 .RE
189 .SH NOTES
190 Most applications would use \fBslk_noutrefresh\fR because a
191 \fBwrefresh\fR is likely to follow soon.
192 .SH PORTABILITY
193 The XSI Curses standard, Issue 4, describes these functions.  It changes the
194 argument type of the attribute-manipulation functions \fBslk_attron\fR,
195 \fBslk_attroff\fR, \fBslk_attrset\fR to be \fBattr_t\fR, and adds \fBconst\fR
196 qualifiers. The format codes \fB2\fR and \fB3\fR for \fBslk_init()\fR and the
197 function \fBslk_attr\fR are specific to ncurses.
198 .SH SEE ALSO
199 \fBcurses\fR(3X), \fBcurs_attr\fR(3X), \fBcurs_initscr\fR(3X), \fBcurs_refresh\fR(3X)
200 .\"#
201 .\"# The following sets edit modes for GNU EMACS
202 .\"# Local Variables:
203 .\"# mode:nroff
204 .\"# fill-column:79
205 .\"# End: