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