31852c419f1fe9791b96ab20a21e078548833b9a
[ncurses.git] / doc / html / man / curs_attr.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2015,2016 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.47 2016/07/23 23:48:49 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>.
127
128
129 </PRE><H3><a name="h3-Window-attributes">Window attributes</a></H3><PRE>
130        The <STRONG>attr_set</STRONG> and <STRONG>wattr_set</STRONG> functions set the  current  at-
131        tributes  of  the given window to <EM>attrs</EM>, with color speci-
132        fied by <EM>pair</EM>.  X/Open specified  an  additional  parameter
133        <EM>opts</EM> which is unused in all implementations.
134
135        Use  <STRONG>attr_get</STRONG> and <STRONG>wattr_get</STRONG> to retrieve attributes for the
136        given window.
137
138        Use <STRONG>attr_on</STRONG> and <STRONG>wattr_on</STRONG> to  turn  on  window  attributes,
139        i.e., values OR'd together in <EM>attr</EM>, without affecting oth-
140        er attributes.  Use <STRONG>attr_off</STRONG> and  <STRONG>wattr_off</STRONG>  to  turn  off
141        window  attributes,  again  values  OR'd together in <EM>attr</EM>,
142        without affecting other attributes.
143
144
145 </PRE><H3><a name="h3-Legacy-window-attributes">Legacy window attributes</a></H3><PRE>
146        Most of the window attribute routines  are  extensions  of
147        older routines which assume that color pairs are OR'd into
148        the attribute parameter.  These  older  routines  use  the
149        same name, omitting an underscore (<STRONG>_</STRONG>).
150
151        The  <STRONG>attrset</STRONG>  routine  is  a legacy feature predating SVr4
152        curses but kept in X/Open Curses for the same reason  that
153        SVr4 curses kept it: compatibility.
154
155        The  remaining  <STRONG>attr</STRONG>*  functions  operate exactly like the
156        corresponding <STRONG>attr_</STRONG>* functions, except that they take  ar-
157        guments of type <STRONG>int</STRONG> rather than <STRONG>attr_t</STRONG>.
158
159        There  is  no  corresponding  <STRONG>attrget</STRONG>  function as such in
160        X/Open Curses, although  ncurses  provides  <STRONG>getattrs</STRONG>  (see
161        <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>).
162
163
164 </PRE><H3><a name="h3-Change-character-rendition">Change character rendition</a></H3><PRE>
165        The routine <STRONG>chgat</STRONG> changes the attributes of a given number
166        of characters starting at the current cursor  location  of
167        <STRONG>stdscr</STRONG>.   It  does not update the cursor and does not per-
168        form wrapping.  A character count of -1  or  greater  than
169        the  remaining window width means to change attributes all
170        the way to the end of the current line.  The <STRONG>wchgat</STRONG>  func-
171        tion generalizes this to any window; the <STRONG>mvwchgat</STRONG> function
172        does a cursor move before acting.
173
174        In these functions, the color <EM>pair</EM> argument  is  a  color-
175        pair  index  (as  in  the first argument of <EM>init</EM><STRONG>_</STRONG><EM>pair</EM>, see
176        <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>).  The <STRONG>opts</STRONG> argument is not presently used,
177        but is reserved for the future (leave it <STRONG>NULL</STRONG>).
178
179
180 </PRE><H3><a name="h3-Change-window-color">Change window color</a></H3><PRE>
181        The  routine <STRONG>color_set</STRONG> sets the current color of the given
182        window to the foreground/background combination  described
183        by  the  color  <EM>pair</EM> parameter.  The parameter <EM>opts</EM> is re-
184        served for future use; applications  must  supply  a  null
185        pointer.
186
187
188 </PRE><H3><a name="h3-Standout">Standout</a></H3><PRE>
189        The  routine  <STRONG>standout</STRONG>  is the same as <STRONG>attron(A_STANDOUT)</STRONG>.
190        The routine <STRONG>standend</STRONG> is the same as  <STRONG>attrset(A_NORMAL)</STRONG>  or
191        <STRONG>attrset(0)</STRONG>, that is, it turns off all attributes.
192
193        X/Open does not mark these "restricted", because
194
195        <STRONG>o</STRONG>   they have well established legacy use, and
196
197        <STRONG>o</STRONG>   there  is  no  ambiguity  about the way the attributes
198            might be combined with a color pair.
199
200
201 </PRE><H2><a name="h2-VIDEO-ATTRIBUTES">VIDEO ATTRIBUTES</a></H2><PRE>
202        The following video attributes, defined in <STRONG>&lt;curses.h&gt;</STRONG>, can
203        be passed to the routines <STRONG>attron</STRONG>, <STRONG>attroff</STRONG>, and <STRONG>attrset</STRONG>, or
204        OR'd with the characters passed to  <STRONG>addch</STRONG>  (see  <STRONG>curs_add-</STRONG>
205        <STRONG><A HREF="curs_addch.3x.html">ch(3x)</A></STRONG>).
206
207               <EM>Name</EM>           <EM>Description</EM>
208               -----------------------------------------------------------
209               <STRONG>A_NORMAL</STRONG>       Normal display (no highlight)
210               <STRONG>A_STANDOUT</STRONG>     Best highlighting mode of the terminal.
211               <STRONG>A_UNDERLINE</STRONG>    Underlining
212               <STRONG>A_REVERSE</STRONG>      Reverse video
213               <STRONG>A_BLINK</STRONG>        Blinking
214               <STRONG>A_DIM</STRONG>          Half bright
215               <STRONG>A_BOLD</STRONG>         Extra bright or bold
216               <STRONG>A_PROTECT</STRONG>      Protected mode
217               <STRONG>A_INVIS</STRONG>        Invisible or blank mode
218               <STRONG>A_ALTCHARSET</STRONG>   Alternate character set
219               <STRONG>A_ITALIC</STRONG>       Italics (non-X/Open extension)
220               <STRONG>A_CHARTEXT</STRONG>     Bit-mask to extract a character
221
222        These video attributes are supported by <STRONG>attr_on</STRONG> and relat-
223        ed functions (which also support the attributes recognized
224        by <STRONG>attron</STRONG>, etc.):
225
226               <EM>Name</EM>            <EM>Description</EM>
227               -----------------------------------------
228               <STRONG>WA_HORIZONTAL</STRONG>   Horizontal highlight
229               <STRONG>WA_LEFT</STRONG>         Left highlight
230               <STRONG>WA_LOW</STRONG>          Low highlight
231               <STRONG>WA_RIGHT</STRONG>        Right highlight
232               <STRONG>WA_TOP</STRONG>          Top highlight
233               <STRONG>WA_VERTICAL</STRONG>     Vertical highlight
234
235        The  return values of many of these routines are not mean-
236        ingful (they are implemented as macro-expanded assignments
237        and  simply  return their argument).  The SVr4 manual page
238        claims (falsely) that these routines always return <STRONG>1</STRONG>.
239
240
241 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
242        These functions may be macros: <STRONG>attroff</STRONG>, <STRONG>wattroff</STRONG>,  <STRONG>attron</STRONG>,
243        <STRONG>wattron</STRONG>, <STRONG>attrset</STRONG>, <STRONG>wattrset</STRONG>, <STRONG>standend</STRONG> and <STRONG>standout</STRONG>.
244
245        Color  pair values can only be OR'd with attributes if the
246        pair number is less than  256.   The  alternate  functions
247        such  as  <STRONG>color_set</STRONG>  can pass a color pair value directly.
248        However, ncurses ABI 4 and 5 simply OR this  value  within
249        the  alternate  functions.   You must use ncurses ABI 6 to
250        support more than 256 color pairs.
251
252
253 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
254        These functions are supported in the XSI Curses  standard,
255        Issue  4.   The  standard  defined  the dedicated type for
256        highlights, <STRONG>attr_t</STRONG>, which is not defined in  SVr4  curses.
257        The  functions  taking  <STRONG>attr_t</STRONG> arguments are not supported
258        under SVr4.
259
260        The XSI Curses standard states that whether the tradition-
261        al  functions  <STRONG>attron</STRONG>/<STRONG>attroff</STRONG>/<STRONG>attrset</STRONG>  can  manipulate at-
262        tributes other than  <STRONG>A_BLINK</STRONG>,  <STRONG>A_BOLD</STRONG>,  <STRONG>A_DIM</STRONG>,  <STRONG>A_REVERSE</STRONG>,
263        <STRONG>A_STANDOUT</STRONG>,  or  <STRONG>A_UNDERLINE</STRONG> is "unspecified".  Under this
264        implementation as well as  SVr4  curses,  these  functions
265        correctly  manipulate  all other highlights (specifically,
266        <STRONG>A_ALTCHARSET</STRONG>, <STRONG>A_PROTECT</STRONG>, and <STRONG>A_INVIS</STRONG>).
267
268        This implementation provides the  <STRONG>A_ITALIC</STRONG>  attribute  for
269        terminals which have the <EM>enter</EM><STRONG>_</STRONG><EM>italics</EM><STRONG>_</STRONG><EM>mode</EM> (sitm) and <EM>ex-</EM>
270        <EM>it</EM><STRONG>_</STRONG><EM>italics</EM><STRONG>_</STRONG><EM>mode</EM> (ritm) capabilities.  Italics are not men-
271        tioned  in  X/Open  Curses.   Unlike  the  other video at-
272        tributes, <STRONG>I_ITALIC</STRONG> is unrelated to the <EM>set</EM><STRONG>_</STRONG><EM>attributes</EM>  ca-
273        pabilities.  This implementation makes the assumption that
274        <EM>exit</EM><STRONG>_</STRONG><EM>attribute</EM><STRONG>_</STRONG><EM>mode</EM> may also reset italics.
275
276        XSI Curses added the new entry points, <STRONG>attr_get</STRONG>,  <STRONG>attr_on</STRONG>,
277        <STRONG>attr_off</STRONG>,  <STRONG>attr_set</STRONG>,  <STRONG>wattr_on</STRONG>, <STRONG>wattr_off</STRONG>, <STRONG>wattr_get</STRONG>, <STRONG>wat-</STRONG>
278        <STRONG>tr_set</STRONG>.  These are intended to work with a new  series  of
279        highlight macros prefixed with <STRONG>WA_</STRONG>.  The older macros have
280        direct counterparts in the newer set of names:
281
282               <EM>Name</EM>            <EM>Description</EM>
283               ------------------------------------------------------------
284               <STRONG>WA_NORMAL</STRONG>       Normal display (no highlight)
285               <STRONG>WA_STANDOUT</STRONG>     Best highlighting mode of the terminal.
286               <STRONG>WA_UNDERLINE</STRONG>    Underlining
287               <STRONG>WA_REVERSE</STRONG>      Reverse video
288               <STRONG>WA_BLINK</STRONG>        Blinking
289               <STRONG>WA_DIM</STRONG>          Half bright
290               <STRONG>WA_BOLD</STRONG>         Extra bright or bold
291               <STRONG>WA_ALTCHARSET</STRONG>   Alternate character set
292
293        Very old versions of this library did not force an  update
294        of  the screen when changing the attributes.  Use <STRONG>touchwin</STRONG>
295        to force the screen to match the updated attributes.
296
297        The XSI curses standard specifies that each pair of corre-
298        sponding  <STRONG>A_</STRONG>  and <STRONG>WA_</STRONG>-using functions operates on the same
299        current-highlight information.
300
301        The XSI standard extended conformance level adds new high-
302        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>
303        <STRONG>TICAL</STRONG> (and corresponding <STRONG>WA_</STRONG> macros for each).  As of  Au-
304        gust  2013,  no  known  terminal provides these highlights
305        (i.e., via the <STRONG>sgr1</STRONG> capability).
306
307
308 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
309        All routines return the integer <STRONG>OK</STRONG> on success, or  <STRONG>ERR</STRONG>  on
310        failure.
311
312        X/Open does not define any error conditions.
313
314        This implementation
315
316        <STRONG>o</STRONG>   returns an error if the window pointer is null.
317
318        <STRONG>o</STRONG>   returns an error if the color pair parameter for <STRONG>wcol-</STRONG>
319            <STRONG>or_set</STRONG> is outside the range 0..COLOR_PAIRS-1.
320
321        Functions with a "mv" prefix first perform a cursor  move-
322        ment  using  <STRONG>wmove</STRONG>, and return an error if the position is
323        outside the window, or if the window pointer is null.
324
325
326 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
327        <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>,
328        <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>
329
330
331
332                                                           <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
333 </PRE>
334 <div class="nav">
335 <ul>
336 <li><a href="#h2-NAME">NAME</a></li>
337 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
338 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
339 <ul>
340 <li><a href="#h3-Window-attributes">Window attributes</a></li>
341 <li><a href="#h3-Legacy-window-attributes">Legacy window attributes</a></li>
342 <li><a href="#h3-Change-character-rendition">Change character rendition</a></li>
343 <li><a href="#h3-Change-window-color">Change window color</a></li>
344 <li><a href="#h3-Standout">Standout</a></li>
345 </ul>
346 </li>
347 <li><a href="#h2-VIDEO-ATTRIBUTES">VIDEO ATTRIBUTES</a></li>
348 <li><a href="#h2-NOTES">NOTES</a></li>
349 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
350 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
351 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
352 </ul>
353 </div>
354 </BODY>
355 </HTML>