2 ****************************************************************************
3 * Copyright (c) 1998-2015,2017 Free Software Foundation, Inc. *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
28 ****************************************************************************
29 * @Id: curs_bkgd.3x,v 1.25 2017/11/18 23:56:00 tom Exp @
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_bkgd 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 <H1 class="no-header">curs_bkgd 3x</H1>
43 <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG> <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49 <STRONG>bkgdset</STRONG>, <STRONG>wbkgdset</STRONG>, <STRONG>bkgd</STRONG>, <STRONG>wbkgd</STRONG>, <STRONG>getbkgd</STRONG> - <STRONG>curses</STRONG> window background
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
56 <STRONG>void</STRONG> <STRONG>bkgdset(chtype</STRONG> <EM>ch</EM><STRONG>);</STRONG>
57 <STRONG>void</STRONG> <STRONG>wbkgdset(WINDOW</STRONG> <STRONG>*</STRONG><EM>win,</EM> <EM>chtype</EM> <EM>ch</EM><STRONG>);</STRONG>
58 <STRONG>int</STRONG> <STRONG>bkgd(chtype</STRONG> <EM>ch</EM><STRONG>);</STRONG>
59 <STRONG>int</STRONG> <STRONG>wbkgd(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>ch</EM><STRONG>);</STRONG>
60 <STRONG>chtype</STRONG> <STRONG>getbkgd(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
65 </PRE><H3><a name="h3-bkgdset">bkgdset</a></H3><PRE>
66 The <STRONG>bkgdset</STRONG> and <STRONG>wbkgdset</STRONG> routines manipulate the background of the
67 named window. The window background is a <STRONG>chtype</STRONG> consisting of any com-
68 bination of attributes (i.e., rendition) and a character. The
69 attribute part of the background is combined (OR'ed) with all non-blank
70 characters that are written into the window with <STRONG>waddch</STRONG>. Both the
71 character and attribute parts of the background are combined with the
72 blank characters. The background becomes a property of the character
73 and moves with the character through any scrolling and insert/delete
74 line/character operations.
76 To the extent possible on a particular terminal, the attribute part of
77 the background is displayed as the graphic rendition of the character
81 </PRE><H3><a name="h3-bkgd">bkgd</a></H3><PRE>
82 The <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> functions set the background property of the current
83 or specified window and then apply this setting to every character
84 position in that window:
86 <STRONG>o</STRONG> The rendition of every character on the screen is changed to the
87 new background rendition.
89 <STRONG>o</STRONG> Wherever the former background character appears, it is changed to
90 the new background character.
93 </PRE><H3><a name="h3-getbkgd">getbkgd</a></H3><PRE>
94 The <STRONG>getbkgd</STRONG> function returns the given window's current background
95 character/attribute pair.
98 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
99 The routines <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> return the integer <STRONG>OK</STRONG>. The SVr4.0 manual
100 says "or a non-negative integer if <STRONG>immedok</STRONG> is set", but this appears to
104 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
105 Note that <STRONG>bkgdset</STRONG> and <STRONG>bkgd</STRONG> may be macros.
108 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
109 These functions are described in the XSI Curses standard, Issue 4. It
110 specifies that <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> return <STRONG>ERR</STRONG> on failure, but gives no fail-
114 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
115 <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_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
119 <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
123 <li><a href="#h2-NAME">NAME</a></li>
124 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
125 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
127 <li><a href="#h3-bkgdset">bkgdset</a></li>
128 <li><a href="#h3-bkgd">bkgd</a></li>
129 <li><a href="#h3-getbkgd">getbkgd</a></li>
132 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
133 <li><a href="#h2-NOTES">NOTES</a></li>
134 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
135 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>