1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
4 ****************************************************************************
5 * Copyright (c) 1998-2010,2013 Free Software Foundation, Inc. *
7 * Permission is hereby granted, free of charge, to any person obtaining a *
8 * copy of this software and associated documentation files (the *
9 * "Software"), to deal in the Software without restriction, including *
10 * without limitation the rights to use, copy, modify, merge, publish, *
11 * distribute, distribute with modifications, sublicense, and/or sell *
12 * copies of the Software, and to permit persons to whom the Software is *
13 * furnished to do so, subject to the following conditions: *
15 * The above copyright notice and this permission notice shall be included *
16 * in all copies or substantial portions of the Software. *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
21 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
22 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
23 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
24 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
26 * Except as contained in this notice, the name(s) of the above copyright *
27 * holders shall not be used in advertising or otherwise to promote the *
28 * sale, use or other dealings in this Software without prior written *
30 ****************************************************************************
31 * @Id: curs_attr.3x,v 1.39 2013/09/21 20:39:49 Sven.Joachim Exp @
35 <TITLE>curs_attr 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
43 <!-- Manpage converted by man2html 3.0.1 -->
44 <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
51 <STRONG>attroff</STRONG>, <STRONG>wattroff</STRONG>, <STRONG>attron</STRONG>, <STRONG>wattron</STRONG>, <STRONG>attrset</STRONG>, <STRONG>wattrset</STRONG>,
52 <STRONG>color_set</STRONG>, <STRONG>wcolor_set</STRONG>, <STRONG>standend</STRONG>, <STRONG>wstandend</STRONG>, <STRONG>standout</STRONG>,
53 <STRONG>wstandout</STRONG>, <STRONG>attr_get</STRONG>, <STRONG>wattr_get</STRONG>, <STRONG>attr_off</STRONG>, <STRONG>wattr_off</STRONG>,
54 <STRONG>attr_on</STRONG>, <STRONG>wattr_on</STRONG>, <STRONG>attr_set</STRONG>, <STRONG>wattr_set</STRONG>, <STRONG>chgat</STRONG>, <STRONG>wchgat</STRONG>,
55 <STRONG>mvchgat</STRONG>, <STRONG>mvwchgat</STRONG>, <STRONG>PAIR_NUMBER</STRONG> - <STRONG>curses</STRONG> character and
56 window attribute control routines
60 <H2>SYNOPSIS</H2><PRE>
61 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
62 <STRONG>int</STRONG> <STRONG>attroff(int</STRONG> <STRONG>attrs);</STRONG>
63 <STRONG>int</STRONG> <STRONG>wattroff(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>attrs);</STRONG>
64 <STRONG>int</STRONG> <STRONG>attron(int</STRONG> <STRONG>attrs);</STRONG>
65 <STRONG>int</STRONG> <STRONG>wattron(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>attrs);</STRONG>
66 <STRONG>int</STRONG> <STRONG>attrset(int</STRONG> <STRONG>attrs);</STRONG>
67 <STRONG>int</STRONG> <STRONG>wattrset(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>attrs);</STRONG>
68 <STRONG>int</STRONG> <STRONG>color_set(short</STRONG> <STRONG>color_pair_number,</STRONG> <STRONG>void*</STRONG> <STRONG>opts);</STRONG>
69 <STRONG>int</STRONG> <STRONG>wcolor_set(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>short</STRONG> <STRONG>color_pair_number,</STRONG>
70 <STRONG>void*</STRONG> <STRONG>opts);</STRONG>
71 <STRONG>int</STRONG> <STRONG>standend(void);</STRONG>
72 <STRONG>int</STRONG> <STRONG>wstandend(WINDOW</STRONG> <STRONG>*win);</STRONG>
73 <STRONG>int</STRONG> <STRONG>standout(void);</STRONG>
74 <STRONG>int</STRONG> <STRONG>wstandout(WINDOW</STRONG> <STRONG>*win);</STRONG>
75 <STRONG>int</STRONG> <STRONG>attr_get(attr_t</STRONG> <STRONG>*attrs,</STRONG> <STRONG>short</STRONG> <STRONG>*pair,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
76 <STRONG>int</STRONG> <STRONG>wattr_get(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>attr_t</STRONG> <STRONG>*attrs,</STRONG> <STRONG>short</STRONG> <STRONG>*pair,</STRONG>
77 <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
78 <STRONG>int</STRONG> <STRONG>attr_off(attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
79 <STRONG>int</STRONG> <STRONG>wattr_off(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
80 <STRONG>int</STRONG> <STRONG>attr_on(attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
81 <STRONG>int</STRONG> <STRONG>wattr_on(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
82 <STRONG>int</STRONG> <STRONG>attr_set(attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>short</STRONG> <STRONG>pair,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
83 <STRONG>int</STRONG> <STRONG>wattr_set(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>short</STRONG> <STRONG>pair,</STRONG> <STRONG>void</STRONG>
84 <STRONG>*opts);</STRONG>
85 <STRONG>int</STRONG> <STRONG>chgat(int</STRONG> <STRONG>n,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attr,</STRONG> <STRONG>short</STRONG> <STRONG>color,</STRONG>
86 <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*opts)</STRONG>
87 <STRONG>int</STRONG> <STRONG>wchgat(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>n,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attr,</STRONG>
88 <STRONG>short</STRONG> <STRONG>color,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*opts)</STRONG>
89 <STRONG>int</STRONG> <STRONG>mvchgat(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>int</STRONG> <STRONG>n,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attr,</STRONG>
90 <STRONG>short</STRONG> <STRONG>color,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*opts)</STRONG>
91 <STRONG>int</STRONG> <STRONG>mvwchgat(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>int</STRONG> <STRONG>n,</STRONG>
92 <STRONG>attr_t</STRONG> <STRONG>attr,</STRONG> <STRONG>short</STRONG> <STRONG>color,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*opts)</STRONG>
96 <H2>DESCRIPTION</H2><PRE>
97 These routines manipulate the current attributes of the
98 named window. The current attributes of a window apply to
99 all characters that are written into the window with <STRONG>wadd-</STRONG>
100 <STRONG>ch</STRONG>, <STRONG>waddstr</STRONG> and <STRONG>wprintw</STRONG>. Attributes are a property of the
101 character, and move with the character through any
102 scrolling and insert/delete line/character operations. To
103 the extent possible, they are displayed as appropriate
104 modifications to the graphic rendition of characters put
107 The routine <STRONG>attrset</STRONG> sets the current attributes of the
108 given window to <EM>attrs</EM>. The routine <STRONG>attroff</STRONG> turns off the
109 named attributes without turning any other attributes on
110 or off. The routine <STRONG>attron</STRONG> turns on the named attributes
111 without affecting any others. The routine <STRONG>standout</STRONG> is the
112 same as <STRONG>attron(A_STANDOUT)</STRONG>. The routine <STRONG>standend</STRONG> is the
113 same as <STRONG>attrset(A_NORMAL)</STRONG> or <STRONG>attrset(0)</STRONG>, that is, it turns
116 The <STRONG>attrset</STRONG> and related routines do not affect the at-
117 tributes used when erasing portions of the window. See
118 <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG> for functions which modify the attributes
119 used for erasing and clearing.
121 The routine <STRONG>color_set</STRONG> sets the current color of the given
122 window to the foreground/background combination described
123 by the color_pair_number. The parameter opts is reserved
124 for future use, applications must supply a null pointer.
126 The routine <STRONG>wattr_get</STRONG> returns the current attribute and
127 color pair for the given window; <STRONG>attr_get</STRONG> returns the cur-
128 rent attribute and color pair for <STRONG>stdscr</STRONG>. The remaining
129 <STRONG>attr_</STRONG>* functions operate exactly like the corresponding
130 <STRONG>attr</STRONG>* functions, except that they take arguments of type
131 <STRONG>attr_t</STRONG> rather than <STRONG>int</STRONG>.
133 The routine <STRONG>chgat</STRONG> changes the attributes of a given number
134 of characters starting at the current cursor location of
135 <STRONG>stdscr</STRONG>. It does not update the cursor and does not per-
136 form wrapping. A character count of -1 or greater than
137 the remaining window width means to change attributes all
138 the way to the end of the current line. The <STRONG>wchgat</STRONG> func-
139 tion generalizes this to any window; the <STRONG>mvwchgat</STRONG> function
140 does a cursor move before acting. In these functions, the
141 color argument is a color-pair index (as in the first ar-
142 gument of <EM>init</EM><STRONG>_</STRONG><EM>pair</EM>, see <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>). The <STRONG>opts</STRONG> argu-
143 ment is not presently used, but is reserved for the future
144 (leave it <STRONG>NULL</STRONG>).
146 <STRONG>Attributes</STRONG>
147 The following video attributes, defined in <STRONG><curses.h></STRONG>, can
148 be passed to the routines <STRONG>attron</STRONG>, <STRONG>attroff</STRONG>, and <STRONG>attrset</STRONG>, or
149 OR'd with the characters passed to <STRONG>addch</STRONG>.
151 <EM>Name</EM> <EM>Description</EM>
152 ------------------------------------------------------------
153 <STRONG>A_NORMAL</STRONG> Normal display (no highlight)
154 <STRONG>A_STANDOUT</STRONG> Best highlighting mode of the terminal.
155 <STRONG>A_UNDERLINE</STRONG> Underlining
156 <STRONG>A_REVERSE</STRONG> Reverse video
157 <STRONG>A_BLINK</STRONG> Blinking
158 <STRONG>A_DIM</STRONG> Half bright
159 <STRONG>A_BOLD</STRONG> Extra bright or bold
160 <STRONG>A_PROTECT</STRONG> Protected mode
161 <STRONG>A_INVIS</STRONG> Invisible or blank mode
162 <STRONG>A_ALTCHARSET</STRONG> Alternate character set
163 <STRONG>A_ITALIC</STRONG> Italics (non-X/Open extension)
164 <STRONG>A_CHARTEXT</STRONG> Bit-mask to extract a character
165 <STRONG>COLOR_PAIR(</STRONG><EM>n</EM><STRONG>)</STRONG> Color-pair number <EM>n</EM>
167 These video attributes are supported by <STRONG>attr_on</STRONG> and relat-
168 ed functions (which also support the attributes recognized
169 by <STRONG>attron</STRONG>, etc.):
171 <EM>Name</EM> <EM>Description</EM>
172 -----------------------------------------
173 <STRONG>WA_HORIZONTAL</STRONG> Horizontal highlight
174 <STRONG>WA_LEFT</STRONG> Left highlight
175 <STRONG>WA_LOW</STRONG> Low highlight
176 <STRONG>WA_RIGHT</STRONG> Right highlight
177 <STRONG>WA_TOP</STRONG> Top highlight
178 <STRONG>WA_VERTICAL</STRONG> Vertical highlight
182 The following macro is the reverse of <STRONG>COLOR_PAIR(</STRONG><EM>n</EM><STRONG>)</STRONG>:
184 <STRONG>PAIR_NUMBER(</STRONG><EM>attrs</EM>) Returns the pair number associated
185 with the <STRONG>COLOR_PAIR(</STRONG><EM>n</EM><STRONG>)</STRONG> attribute.
187 The return values of many of these routines are not mean-
188 ingful (they are implemented as macro-expanded assignments
189 and simply return their argument). The SVr4 manual page
190 claims (falsely) that these routines always return <STRONG>1</STRONG>.
195 Note that <STRONG>attroff</STRONG>, <STRONG>wattroff</STRONG>, <STRONG>attron</STRONG>, <STRONG>wattron</STRONG>, <STRONG>attrset</STRONG>,
196 <STRONG>wattrset</STRONG>, <STRONG>standend</STRONG> and <STRONG>standout</STRONG> may be macros.
198 <STRONG>COLOR_PAIR</STRONG> values can only be OR'd with attributes if the
199 pair number is less than 256. The alternate functions
200 such as <STRONG>color_set</STRONG> can pass a color pair value directly.
201 However, ncurses ABI 4 and 5 simply OR this value within
202 the alternate functions. You must use ncurses ABI 6 to
203 support more than 256 color pairs.
207 <H2>PORTABILITY</H2><PRE>
208 These functions are supported in the XSI Curses standard,
209 Issue 4. The standard defined the dedicated type for
210 highlights, <STRONG>attr_t</STRONG>, which is not defined in SVr4 curses.
211 The functions taking <STRONG>attr_t</STRONG> arguments are not supported
214 The XSI Curses standard states that whether the tradition-
215 al functions <STRONG>attron</STRONG>/<STRONG>attroff</STRONG>/<STRONG>attrset</STRONG> can manipulate at-
216 tributes other than <STRONG>A_BLINK</STRONG>, <STRONG>A_BOLD</STRONG>, <STRONG>A_DIM</STRONG>, <STRONG>A_REVERSE</STRONG>,
217 <STRONG>A_STANDOUT</STRONG>, or <STRONG>A_UNDERLINE</STRONG> is "unspecified". Under this
218 implementation as well as SVr4 curses, these functions
219 correctly manipulate all other highlights (specifically,
220 <STRONG>A_ALTCHARSET</STRONG>, <STRONG>A_PROTECT</STRONG>, and <STRONG>A_INVIS</STRONG>).
222 This implementation provides the <STRONG>A_ITALIC</STRONG> attribute for
223 terminals which have the <EM>enter</EM><STRONG>_</STRONG><EM>italics</EM><STRONG>_</STRONG><EM>mode</EM> (sitm) and <EM>ex-</EM>
224 <EM>it</EM><STRONG>_</STRONG><EM>italics</EM><STRONG>_</STRONG><EM>mode</EM> (ritm) capabilities. Italics are not men-
225 tioned in X/Open Curses. Unlike the other video at-
226 tributes, <STRONG>I_ITALIC</STRONG> is unrelated to the <EM>set</EM><STRONG>_</STRONG><EM>attributes</EM> ca-
227 pabilities. This implementation makes the assumption that
228 <EM>exit</EM><STRONG>_</STRONG><EM>attribute</EM><STRONG>_</STRONG><EM>mode</EM> may also reset italics.
230 XSI Curses added the new entry points, <STRONG>attr_get</STRONG>, <STRONG>attr_on</STRONG>,
231 <STRONG>attr_off</STRONG>, <STRONG>attr_set</STRONG>, <STRONG>wattr_on</STRONG>, <STRONG>wattr_off</STRONG>, <STRONG>wattr_get</STRONG>, <STRONG>wat-</STRONG>
232 <STRONG>tr_set</STRONG>. These are intended to work with a new series of
233 highlight macros prefixed with <STRONG>WA_</STRONG>. The older macros have
234 direct counterparts in the newer set of names:
236 <EM>Name</EM> <EM>Description</EM>
237 ------------------------------------------------------------
238 <STRONG>WA_NORMAL</STRONG> Normal display (no highlight)
239 <STRONG>WA_STANDOUT</STRONG> Best highlighting mode of the terminal.
240 <STRONG>WA_UNDERLINE</STRONG> Underlining
241 <STRONG>WA_REVERSE</STRONG> Reverse video
242 <STRONG>WA_BLINK</STRONG> Blinking
243 <STRONG>WA_DIM</STRONG> Half bright
244 <STRONG>WA_BOLD</STRONG> Extra bright or bold
245 <STRONG>WA_ALTCHARSET</STRONG> Alternate character set
247 Older versions of this library did not force an update of
248 the screen when changing the attributes. Use <STRONG>touchwin</STRONG> to
249 force the screen to match the updated attributes.
251 The XSI curses standard specifies that each pair of corre-
252 sponding <STRONG>A_</STRONG> and <STRONG>WA_</STRONG>-using functions operates on the same
253 current-highlight information.
255 The XSI standard extended conformance level adds new high-
256 lights <STRONG>A_HORIZONTAL</STRONG>, <STRONG>A_LEFT</STRONG>, <STRONG>A_LOW</STRONG>, <STRONG>A_RIGHT</STRONG>, <STRONG>A_TOP</STRONG>, <STRONG>A_VER-</STRONG>
257 <STRONG>TICAL</STRONG> (and corresponding <STRONG>WA_</STRONG> macros for each). As of Au-
258 gust 2013, no known terminal provides these highlights
259 (i.e., via the <STRONG>sgr1</STRONG> capability).
263 <H2>RETURN VALUE</H2><PRE>
264 All routines return the integer <STRONG>OK</STRONG> on success, or <STRONG>ERR</STRONG> on
267 X/Open does not define any error conditions.
269 This implementation returns an error if the window pointer
270 is null. The <STRONG>wcolor_set</STRONG> function returns an error if the
271 color pair parameter is outside the range 0..COL-
272 OR_PAIRS-1. This implementation also provides <STRONG>getattrs</STRONG>
273 for compatibility with older versions of curses.
275 Functions with a "mv" prefix first perform a cursor move-
276 ment using <STRONG>wmove</STRONG>, and return an error if the position is
277 outside the window, or if the window pointer is null.
281 <H2>SEE ALSO</H2><PRE>
282 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>, <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>,
283 <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>, <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
287 <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
291 Man(1) output converted with
292 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>