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