ncurses 5.0
[ncurses.git] / man / curs_slk.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998 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.9 1998/03/11 21:12:53 juergen Exp $
30 .TH curs_slk 3X ""
31 .SH NAME
32 \fBslk_init\fR, \fBslk_set\fR, \fBslk_refresh\fR,
33 \fBslk_noutrefresh\fR, \fBslk_label\fR, \fBslk_clear\fR, \fBslk_restore\fR,
34 \fBslk_touch\fR, \fBslk_attron\fR, \fBslk_attrset\fR, \fBslk_attroff\fR, \fBslk_color\fR -
35 \fBcurses\fR soft label routines
36 .SH SYNOPSIS
37 \fB#include <curses.h>\fR
38
39 \fBint slk_init(int fmt);\fR
40 .br
41 \fBint slk_set(int labnum, const char *label, int fmt);\fR
42 .br
43 \fBint slk_refresh(void);\fR
44 .br
45 \fBint slk_noutrefresh(void);\fR
46 .br
47 \fBchar *slk_label(int labnum);\fR
48 .br
49 \fBint slk_clear(void);\fR
50 .br
51 \fBint slk_restore(void);\fR
52 .br
53 \fBint slk_touch(void);\fR
54 .br
55 \fBint slk_attron(const chtype attrs);\fR
56 .br
57 \fBint slk_attrset(const chtype attrs);\fR
58 .br
59 \fBattr_t slk_attr(void);\fR
60 .br
61 \fBint slk_attroff(const chtype attrs);\fR
62 .br
63 \fBint slk_color(short color_pair_number);\fR
64 .br
65 .SH DESCRIPTION
66 The slk* functions manipulate the set of soft function-key labels that exist on
67 many terminals.  For those terminals that do not have soft labels,
68 \fBcurses\fR takes over the bottom line of \fBstdscr\fR, reducing the size of
69 \fBstdscr\fR and the variable \fBLINES\fR.  \fBcurses\fR standardizes on eight
70 labels of up to eight characters each. In addition to this, the ncurses 
71 implementation supports a mode where it simulates 12 labels of up to five
72 characters each. This is most common for todays PC like enduser devices.
73 Please note that ncurses simulates this mode by taking over up to two lines at
74 the bottom of the screen, it doesn't try to use any hardware support for this
75 mode.
76
77 The \fBslk_init\fR routine must be called before \fBinitscr\fR or \fBnewterm\fR
78 is called.  If \fBinitscr\fR eventually uses a line from \fBstdscr\fR to
79 emulate the soft labels, then \fIfmt\fR determines how the labels are arranged
80 on the screen.  Setting \fIfmt\fR to \fB0\fR indicates a 3-2-3 arrangement of
81 the labels, \fB1\fR indicates a 4-4 arrangement and \fB2\fR indicates the
82 PC like 4-4-4 mode. If \fBfmt\fR is set to \fB3\fR, it is again the PC like
83 4-4-4 mode, but in addition an index line is generated, helping the user to
84 identify the key numbers easily.
85
86 The \fBslk_set\fR routine requires \fIlabnum\fR to be a label number,
87 from \fB1\fR to \fB8\fR (resp. \fB12\fR); \fIlabel\fR must be the string 
88 to be put on the label, up to eight (resp. five) characters in length.
89 A null string or a null pointer sets up a blank label. \fIfmt\fR is either
90 \fB0\fR, \fB1\fR, or \fB2\fR, indicating whether the label is  to be 
91 left-justified, centered, or right-justified, respectively, within the
92 label.
93
94 The \fBslk_refresh\fR and \fBslk_noutrefresh\fR routines correspond to
95 the \fBwrefresh\fR and \fBwnoutrefresh\fR routines.
96
97 The \fBslk_label\fR routine returns the current label for label number
98 \fIlabnum\fR, with leading and trailing blanks stripped.
99
100 The \fBslk_clear\fR routine clears the soft labels from the screen.
101
102 The \fBslk_restore\fR routine, restores the soft labels to the screen
103 after a \fBslk_clear\fR has been performed.
104
105 The \fBslk_touch\fR routine forces all the soft labels to be output
106 the next time a \fBslk_noutrefresh\fR is performed.
107
108 The \fBslk_attron\fR, \fBslk_attrset\fR, \fBslk_attroff\fR and \fBslk_attr\fR
109 routines correspond to \fBattron\fR, \fBattrset\fR, \fBattroff\fR and \fBattr_get\fR.
110 They have an effect only if soft labels are simulated on the bottom line of
111 the screen.  The default highlight for soft keys is A_STANDOUT (as in 
112 System V curses, which does not document this fact).
113
114 The \fBslk_color\fR routine corresponds to \fBcolor_set\fR. It has an effect only
115 if soft labels are simulated on the bottom line of the screen.
116
117 .SH RETURN VALUE
118 These routines return \fBERR\fR upon failure and OK (SVr4 specifies only "an
119 integer value other than \fBERR\fR") upon successful completion. \fBslk_attr\fR
120 returns the attribute used for the soft keys.
121
122 \fBslk_label\fR returns \fBNULL\fR on error.
123 .SH NOTES
124 Most applications would use \fBslk_noutrefresh\fR because a
125 \fBwrefresh\fR is likely to follow soon.
126 .SH PORTABILITY
127 The XSI Curses standard, Issue 4, describes these functions.  It changes the
128 argument type of the attribute-manipulation functions \fBslk_attron\fR,
129 \fBslk_attroff\fR, \fBslk_attrset\fR to be \fBattr_t\fR, and adds \fBconst\fR
130 qualifiers. The format codes \fB2\fR and \fB3\fR for \fBslk_init()\fR and the
131 function \fBslk_attr\fR are specific to ncurses.
132 .SH SEE ALSO
133 \fBcurses\fR(3X), \fBcurs_attr\fR(3X), \fBcurs_initscr\fR(3X), \fBcurs_refresh\fR(3X)
134 .\"#
135 .\"# The following sets edit modes for GNU EMACS
136 .\"# Local Variables:
137 .\"# mode:nroff
138 .\"# fill-column:79
139 .\"# End: