ncurses 6.0 - patch 20170401
[ncurses.git] / doc / html / man / curs_attr.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2016,2017 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_attr.3x,v 1.53 2017/03/28 23:31:39 tom Exp @
31   * attr_get
32   * .br
33   * .br
34   * .br
35   * .br
36   * .br
37   * ---------------------------------------------------------------------------
38   * ---------------------------------------------------------------------------
39   * ---------------------------------------------------------------------------
40   * ---------------------------------------------------------------------------
41   * ---------------------------------------------------------------------------
42   * ---------------------------------------------------------------------------
43 -->
44 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
45 <HTML>
46 <HEAD>
47 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
48 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
49 <TITLE>curs_attr 3x</TITLE>
50 <link rev=made href="mailto:bug-ncurses@gnu.org">
51 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
52 </HEAD>
53 <BODY>
54 <H1 class="no-header">curs_attr 3x</H1>
55 <PRE>
56 <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>                                             <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
57
58
59
60
61 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
62        <STRONG>attr_get</STRONG>, <STRONG>wattr_get</STRONG>, <STRONG>attr_set</STRONG>, <STRONG>wattr_set</STRONG>, <STRONG>attr_off</STRONG>,
63        <STRONG>wattr_off</STRONG>, <STRONG>attr_on</STRONG>, <STRONG>wattr_on</STRONG>, <STRONG>attroff</STRONG>, <STRONG>wattroff</STRONG>, <STRONG>attron</STRONG>,
64        <STRONG>wattron</STRONG>, <STRONG>attrset</STRONG>, <STRONG>wattrset</STRONG>, <STRONG>chgat</STRONG>, <STRONG>wchgat</STRONG>, <STRONG>mvchgat</STRONG>,
65        <STRONG>mvwchgat</STRONG>, <STRONG>color_set</STRONG>, <STRONG>wcolor_set</STRONG>, <STRONG>standend</STRONG>, <STRONG>wstandend</STRONG>,
66        <STRONG>standout</STRONG>, <STRONG>wstandout</STRONG> - <STRONG>curses</STRONG> character and window
67        attribute control routines
68
69
70 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
71        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
72
73        <STRONG>int</STRONG> <STRONG>attr_get(attr_t</STRONG> <STRONG>*</STRONG><EM>attrs</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <STRONG>*</STRONG><EM>pair</EM><STRONG>,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM><STRONG>);</STRONG>
74        <STRONG>int</STRONG> <STRONG>wattr_get(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG>  <STRONG>attr_t</STRONG>  <STRONG>*</STRONG><EM>attrs</EM><STRONG>,</STRONG>  <STRONG>short</STRONG>  <STRONG>*</STRONG><EM>pair</EM><STRONG>,</STRONG>
75        <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM><STRONG>);</STRONG>
76        <STRONG>int</STRONG> <STRONG>attr_set(attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM><STRONG>);</STRONG>
77        <STRONG>int</STRONG>  <STRONG>wattr_set(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>void</STRONG>
78        <STRONG>*</STRONG><EM>opts</EM><STRONG>);</STRONG>
79
80        <STRONG>int</STRONG> <STRONG>attr_off(attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM><STRONG>);</STRONG>
81        <STRONG>int</STRONG> <STRONG>wattr_off(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM><STRONG>);</STRONG>
82        <STRONG>int</STRONG> <STRONG>attr_on(attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM><STRONG>);</STRONG>
83        <STRONG>int</STRONG> <STRONG>wattr_on(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM><STRONG>);</STRONG>
84
85        <STRONG>int</STRONG> <STRONG>attroff(int</STRONG> <EM>attrs);</EM>
86        <STRONG>int</STRONG> <STRONG>wattroff(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>attrs</EM><STRONG>);</STRONG>
87        <STRONG>int</STRONG> <STRONG>attron(int</STRONG> <EM>attrs</EM><STRONG>);</STRONG>
88        <STRONG>int</STRONG> <STRONG>wattron(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>attrs</EM><STRONG>);</STRONG>
89        <STRONG>int</STRONG> <STRONG>attrset(int</STRONG> <EM>attrs</EM><STRONG>);</STRONG>
90        <STRONG>int</STRONG> <STRONG>wattrset(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>attrs</EM><STRONG>);</STRONG>
91
92        <STRONG>int</STRONG> <STRONG>chgat(int</STRONG> <EM>n</EM><STRONG>,</STRONG>  <STRONG>attr_t</STRONG>  <EM>attr</EM><STRONG>,</STRONG>  <STRONG>short</STRONG>  <EM>pair</EM><STRONG>,</STRONG>  <STRONG>const</STRONG>  <STRONG>void</STRONG>
93        <STRONG>*</STRONG><EM>opts</EM><STRONG>);</STRONG>
94        <STRONG>int</STRONG> <STRONG>wchgat(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG>
95              <STRONG>int</STRONG> <EM>n</EM><STRONG>,</STRONG> <STRONG>attr_t</STRONG> <EM>attr</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM><STRONG>);</STRONG>
96        <STRONG>int</STRONG> <STRONG>mvchgat(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG>
97              <STRONG>int</STRONG> <EM>n</EM><STRONG>,</STRONG> <STRONG>attr_t</STRONG> <EM>attr</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM><STRONG>);</STRONG>
98        <STRONG>int</STRONG> <STRONG>mvwchgat(WINDOW</STRONG> <STRONG>*</STRONG><EM>win,</EM> <EM>int</EM> <EM>y,</EM> <EM>int</EM> <EM>x</EM><STRONG>,</STRONG>
99              <STRONG>int</STRONG> <EM>n,</EM> <STRONG>attr_t</STRONG> <EM>attr</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM><STRONG>);</STRONG>
100
101        <STRONG>int</STRONG> <STRONG>color_set(short</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>void*</STRONG> <EM>opts</EM><STRONG>);</STRONG>
102        <STRONG>int</STRONG> <STRONG>wcolor_set(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>void*</STRONG> <EM>opts);</EM>
103
104        <STRONG>int</STRONG> <STRONG>standend(void);</STRONG>
105        <STRONG>int</STRONG> <STRONG>wstandend(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
106        <STRONG>int</STRONG> <STRONG>standout(void);</STRONG>
107        <STRONG>int</STRONG> <STRONG>wstandout(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
108
109
110 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
111        These  routines  manipulate  the current attributes of the
112        named window, which then apply to all characters that  are
113        written  into the window with <STRONG>waddch</STRONG>, <STRONG>waddstr</STRONG> and <STRONG>wprintw</STRONG>.
114        Attributes are a property of the character, and move  with
115        the  character  through  any  scrolling  and insert/delete
116        line/character operations.  To the extent  possible,  they
117        are  displayed as appropriate modifications to the graphic
118        rendition of characters put on the screen.
119
120        These routines do not  affect  the  attributes  used  when
121        erasing  portions  of  the  window.  See <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG> for
122        functions which modify the attributes used for erasing and
123        clearing.
124
125        Routines  which  do  not have a <STRONG>WINDOW*</STRONG> parameter apply to
126        <STRONG>stdscr</STRONG>.  For example, <STRONG>attr_set</STRONG> is the  <STRONG>stdscr</STRONG>  variant  of
127        <STRONG>wattr_set</STRONG>.
128
129
130 </PRE><H3><a name="h3-Window-attributes">Window attributes</a></H3><PRE>
131        There are two sets of functions:
132
133        <STRONG>o</STRONG>   functions  for  manipulating the window attributes and
134            color: <STRONG>wattr_set</STRONG> and <STRONG>wattr_get</STRONG>.
135
136        <STRONG>o</STRONG>   functions for manipulating only the window  attributes
137            (not color): <STRONG>wattr_on</STRONG> and <STRONG>wattr_off</STRONG>.
138
139        The  <STRONG>wattr_set</STRONG> function sets the current attributes of the
140        given window to <EM>attrs</EM>, with color specified by <EM>pair</EM>.
141
142        Use <STRONG>wattr_get</STRONG> to retrieve attributes for the given window.
143
144        Use <STRONG>attr_on</STRONG> and <STRONG>wattr_on</STRONG> to  turn  on  window  attributes,
145        i.e., values OR'd together in <EM>attr</EM>, without affecting oth-
146        er attributes.  Use <STRONG>attr_off</STRONG> and  <STRONG>wattr_off</STRONG>  to  turn  off
147        window  attributes,  again  values  OR'd together in <EM>attr</EM>,
148        without affecting other attributes.
149
150
151 </PRE><H3><a name="h3-Legacy-window-attributes">Legacy window attributes</a></H3><PRE>
152        Most of the window attribute routines  are  extensions  of
153        older routines which assume that color pairs are OR'd into
154        the attribute parameter.  These  older  routines  use  the
155        same name, omitting an underscore (<STRONG>_</STRONG>).
156
157        The  <STRONG>attrset</STRONG>  routine  is  a legacy feature predating SVr4
158        curses but kept in X/Open Curses for the same reason  that
159        SVr4 curses kept it: compatibility.
160
161        The  remaining  <STRONG>attr</STRONG>*  functions  operate exactly like the
162        corresponding <STRONG>attr_</STRONG>* functions, except that they take  ar-
163        guments of type <STRONG>int</STRONG> rather than <STRONG>attr_t</STRONG>.
164
165        There  is  no  corresponding  <STRONG>attrget</STRONG>  function as such in
166        X/Open Curses, although  ncurses  provides  <STRONG>getattrs</STRONG>  (see
167        <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>).
168
169
170 </PRE><H3><a name="h3-Change-character-rendition">Change character rendition</a></H3><PRE>
171        The routine <STRONG>chgat</STRONG> changes the attributes of a given number
172        of characters starting at the current cursor  location  of
173        <STRONG>stdscr</STRONG>.   It  does not update the cursor and does not per-
174        form wrapping.  A character count of -1  or  greater  than
175        the  remaining window width means to change attributes all
176        the way to the end of the current line.  The <STRONG>wchgat</STRONG>  func-
177        tion generalizes this to any window; the <STRONG>mvwchgat</STRONG> function
178        does a cursor move before acting.
179
180        In these functions, the color <EM>pair</EM> argument  is  a  color-
181        pair  index  (as  in  the first argument of <STRONG>init_pair</STRONG>, see
182        <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>).
183
184
185 </PRE><H3><a name="h3-Change-window-color">Change window color</a></H3><PRE>
186        The routine <STRONG>color_set</STRONG> sets the current color of the  given
187        window  to the foreground/background combination described
188        by the color <EM>pair</EM> parameter.
189
190
191 </PRE><H3><a name="h3-Standout">Standout</a></H3><PRE>
192        The routine <STRONG>standout</STRONG> is the  same  as  <STRONG>attron(A_STANDOUT)</STRONG>.
193        The  routine  <STRONG>standend</STRONG> is the same as <STRONG>attrset(A_NORMAL)</STRONG> or
194        <STRONG>attrset(0)</STRONG>, that is, it turns off all attributes.
195
196        X/Open does not mark these "restricted", because
197
198        <STRONG>o</STRONG>   they have well established legacy use, and
199
200        <STRONG>o</STRONG>   there is no ambiguity about  the  way  the  attributes
201            might be combined with a color pair.
202
203
204 </PRE><H2><a name="h2-VIDEO-ATTRIBUTES">VIDEO ATTRIBUTES</a></H2><PRE>
205        The following video attributes, defined in <STRONG>&lt;curses.h&gt;</STRONG>, can
206        be passed to the routines <STRONG>attron</STRONG>, <STRONG>attroff</STRONG>, and <STRONG>attrset</STRONG>, or
207        OR'd  with  the  characters passed to <STRONG>addch</STRONG> (see <STRONG>curs_add-</STRONG>
208        <STRONG><A HREF="curs_addch.3x.html">ch(3x)</A></STRONG>).
209
210               <EM>Name</EM>           <EM>Description</EM>
211               -----------------------------------------------------------
212               <STRONG>A_NORMAL</STRONG>       Normal display (no highlight)
213               <STRONG>A_STANDOUT</STRONG>     Best highlighting mode of the terminal.
214               <STRONG>A_UNDERLINE</STRONG>    Underlining
215               <STRONG>A_REVERSE</STRONG>      Reverse video
216               <STRONG>A_BLINK</STRONG>        Blinking
217               <STRONG>A_DIM</STRONG>          Half bright
218               <STRONG>A_BOLD</STRONG>         Extra bright or bold
219               <STRONG>A_PROTECT</STRONG>      Protected mode
220               <STRONG>A_INVIS</STRONG>        Invisible or blank mode
221               <STRONG>A_ALTCHARSET</STRONG>   Alternate character set
222               <STRONG>A_ITALIC</STRONG>       Italics (non-X/Open extension)
223               <STRONG>A_CHARTEXT</STRONG>     Bit-mask to extract a character
224
225        These video attributes are supported by <STRONG>attr_on</STRONG> and relat-
226        ed functions (which also support the attributes recognized
227        by <STRONG>attron</STRONG>, etc.):
228
229               <EM>Name</EM>            <EM>Description</EM>
230               -----------------------------------------
231               <STRONG>WA_HORIZONTAL</STRONG>   Horizontal highlight
232               <STRONG>WA_LEFT</STRONG>         Left highlight
233               <STRONG>WA_LOW</STRONG>          Low highlight
234               <STRONG>WA_RIGHT</STRONG>        Right highlight
235               <STRONG>WA_TOP</STRONG>          Top highlight
236               <STRONG>WA_VERTICAL</STRONG>     Vertical highlight
237
238        The return values of many of these routines are not  mean-
239        ingful (they are implemented as macro-expanded assignments
240        and simply return their argument).  The SVr4  manual  page
241        claims (falsely) that these routines always return <STRONG>1</STRONG>.
242
243
244 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
245        These functions may be macros:
246
247               <STRONG>attroff</STRONG>,  <STRONG>wattroff</STRONG>,  <STRONG>attron</STRONG>, <STRONG>wattron</STRONG>, <STRONG>attrset</STRONG>, <STRONG>wat-</STRONG>
248               <STRONG>trset</STRONG>, <STRONG>standend</STRONG> and <STRONG>standout</STRONG>.
249
250        Color pair values can only be OR'd with attributes if  the
251        pair  number  is  less  than 256.  The alternate functions
252        such as <STRONG>color_set</STRONG> can pass a color  pair  value  directly.
253        However,  ncurses  ABI 4 and 5 simply OR this value within
254        the alternate functions.  You must use ncurses  ABI  6  to
255        support more than 256 color pairs.
256
257
258 </PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
259        This  implementation  provides  the <STRONG>A_ITALIC</STRONG> attribute for
260        terminals which have the <STRONG>enter_italics_mode</STRONG> (<STRONG>sitm</STRONG>) and <STRONG>ex-</STRONG>
261        <STRONG>it_italics_mode</STRONG> (<STRONG>ritm</STRONG>) capabilities.  Italics are not men-
262        tioned in X/Open  Curses.   Unlike  the  other  video  at-
263        tributes,  <STRONG>A_ITALIC</STRONG> is unrelated to the <STRONG>set_attributes</STRONG> ca-
264        pabilities.  This implementation makes the assumption that
265        <STRONG>exit_attribute_mode</STRONG> may also reset italics.
266
267        Each  of the functions added by XSI Curses has a parameter
268        <EM>opts</EM>, which X/Open Curses still (after  more  than  twenty
269        years)  documents  as reserved for future use, saying that
270        it should be <STRONG>NULL</STRONG>.  This implementation uses that  parame-
271        ter in ABI 6 for the functions which have a color-pair pa-
272        rameter to support <EM>extended</EM> <EM>color</EM> <EM>pairs</EM>:
273
274        <STRONG>o</STRONG>   For functions which modify the color, e.g., <STRONG>wattr_set</STRONG>,
275            if  <EM>opts</EM> is set it is treated as a pointer to <STRONG>int</STRONG>, and
276            used to set the color pair instead of the  <STRONG>short</STRONG>  <EM>pair</EM>
277            parameter.
278
279        <STRONG>o</STRONG>   For  functions  which  retrieve  the color, e.g., <STRONG>wat-</STRONG>
280            <STRONG>tr_get</STRONG>, if <EM>opts</EM> is set it is treated as a  pointer  to
281            <STRONG>int</STRONG>,  and  used  to  retrieve the color pair as an <STRONG>int</STRONG>
282            value, in addition  retrieving  it  via  the  standard
283            pointer to <STRONG>short</STRONG> parameter.
284
285        The remaining functions which have <EM>opts</EM>, but do not manip-
286        ulate color, e.g., <STRONG>wattr_on</STRONG> and <STRONG>wattr_off</STRONG> are not used  by
287        this implementation except to check that they are <STRONG>NULL</STRONG>.
288
289
290 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
291        These  functions are supported in the XSI Curses standard,
292        Issue 4.  The standard  defined  the  dedicated  type  for
293        highlights,  <STRONG>attr_t</STRONG>, which was not defined in SVr4 curses.
294        The functions taking <STRONG>attr_t</STRONG> arguments were  not  supported
295        under SVr4.
296
297        Very  old versions of this library did not force an update
298        of the screen when changing the attributes.  Use  <STRONG>touchwin</STRONG>
299        to force the screen to match the updated attributes.
300
301        The XSI Curses standard states that whether the tradition-
302        al functions  <STRONG>attron</STRONG>/<STRONG>attroff</STRONG>/<STRONG>attrset</STRONG>  can  manipulate  at-
303        tributes  other  than  <STRONG>A_BLINK</STRONG>,  <STRONG>A_BOLD</STRONG>, <STRONG>A_DIM</STRONG>, <STRONG>A_REVERSE</STRONG>,
304        <STRONG>A_STANDOUT</STRONG>, or <STRONG>A_UNDERLINE</STRONG> is "unspecified".   Under  this
305        implementation  as  well  as  SVr4 curses, these functions
306        correctly manipulate all other  highlights  (specifically,
307        <STRONG>A_ALTCHARSET</STRONG>, <STRONG>A_PROTECT</STRONG>, and <STRONG>A_INVIS</STRONG>).
308
309        XSI Curses added these entry points:
310
311               <STRONG>attr_get</STRONG>,  <STRONG>attr_on</STRONG>,  <STRONG>attr_off</STRONG>,  <STRONG>attr_set</STRONG>, <STRONG>wattr_on</STRONG>,
312               <STRONG>wattr_off</STRONG>, <STRONG>wattr_get</STRONG>, <STRONG>wattr_set</STRONG>
313
314        The new functions are intended to work with a  new  series
315        of  highlight  macros prefixed with <STRONG>WA_</STRONG>.  The older macros
316        have direct counterparts in the newer set of names:
317
318               <EM>Name</EM>            <EM>Description</EM>
319               ------------------------------------------------------------
320               <STRONG>WA_NORMAL</STRONG>       Normal display (no highlight)
321               <STRONG>WA_STANDOUT</STRONG>     Best highlighting mode of the terminal.
322               <STRONG>WA_UNDERLINE</STRONG>    Underlining
323               <STRONG>WA_REVERSE</STRONG>      Reverse video
324               <STRONG>WA_BLINK</STRONG>        Blinking
325               <STRONG>WA_DIM</STRONG>          Half bright
326               <STRONG>WA_BOLD</STRONG>         Extra bright or bold
327               <STRONG>WA_ALTCHARSET</STRONG>   Alternate character set
328
329        The XSI curses standard specifies that each pair of corre-
330        sponding  <STRONG>A_</STRONG>  and <STRONG>WA_</STRONG>-using functions operates on the same
331        current-highlight information.
332
333        The XSI standard extended conformance level adds new high-
334        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>
335        <STRONG>TICAL</STRONG> (and corresponding <STRONG>WA_</STRONG> macros for each).  As of  Au-
336        gust  2013,  no  known  terminal provides these highlights
337        (i.e., via the <STRONG>sgr1</STRONG> capability).
338
339
340 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
341        All routines return the integer <STRONG>OK</STRONG> on success, or  <STRONG>ERR</STRONG>  on
342        failure.
343
344        X/Open does not define any error conditions.
345
346        This implementation
347
348        <STRONG>o</STRONG>   returns an error if the window pointer is null.
349
350        <STRONG>o</STRONG>   returns an error if the color pair parameter for <STRONG>wcol-</STRONG>
351            <STRONG>or_set</STRONG> is outside the range 0..COLOR_PAIRS-1.
352
353        <STRONG>o</STRONG>   does not return an error if either of  the  parameters
354            of  <STRONG>wattr_get</STRONG>  used for retrieving attribute or color-
355            pair values is <STRONG>NULL</STRONG>.
356
357        Functions with a "mv" prefix first perform a cursor  move-
358        ment  using  <STRONG>wmove</STRONG>, and return an error if the position is
359        outside the window, or if the window pointer is null.
360
361
362 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
363        <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>,
364        <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>
365
366
367
368                                                           <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
369 </PRE>
370 <div class="nav">
371 <ul>
372 <li><a href="#h2-NAME">NAME</a></li>
373 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
374 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
375 <ul>
376 <li><a href="#h3-Window-attributes">Window attributes</a></li>
377 <li><a href="#h3-Legacy-window-attributes">Legacy window attributes</a></li>
378 <li><a href="#h3-Change-character-rendition">Change character rendition</a></li>
379 <li><a href="#h3-Change-window-color">Change window color</a></li>
380 <li><a href="#h3-Standout">Standout</a></li>
381 </ul>
382 </li>
383 <li><a href="#h2-VIDEO-ATTRIBUTES">VIDEO ATTRIBUTES</a></li>
384 <li><a href="#h2-NOTES">NOTES</a></li>
385 <li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li>
386 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
387 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
388 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
389 </ul>
390 </div>
391 </BODY>
392 </HTML>