2 ****************************************************************************
3 * Copyright 2018-2022,2023 Thomas E. Dickey *
4 * Copyright 2002-2015,2017 Free Software Foundation, Inc. *
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: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
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. *
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 *
29 ****************************************************************************
30 * @Id: curs_bkgrnd.3x,v 1.21 2023/08/12 18:31:54 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_bkgrnd 3x 2023-08-12 ncurses 6.4 Library calls</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
42 <H1 class="no-header">curs_bkgrnd 3x 2023-08-12 ncurses 6.4 Library calls</H1>
44 <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>bkgrnd</STRONG>, <STRONG>wbkgrnd</STRONG>, <STRONG>bkgrndset</STRONG>, <STRONG>wbkgrndset</STRONG>, <STRONG>getbkgrnd</STRONG>, <STRONG>wgetbkgrnd</STRONG> - <STRONG>curses</STRONG>
51 window complex background manipulation routines
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
57 <STRONG>int</STRONG> <STRONG>bkgrnd(</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
58 <STRONG>int</STRONG> <STRONG>wbkgrnd(</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
60 <STRONG>void</STRONG> <STRONG>bkgrndset(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
61 <STRONG>void</STRONG> <STRONG>wbkgrndset(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
63 <STRONG>int</STRONG> <STRONG>getbkgrnd(cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
64 <STRONG>int</STRONG> <STRONG>wgetbkgrnd(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
67 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
69 </PRE><H3><a name="h3-bkgrndset">bkgrndset</a></H3><PRE>
70 The <STRONG>bkgrndset</STRONG> and <STRONG>wbkgrndset</STRONG> routines manipulate the background of the
71 named window. The window background is a <STRONG>cchar_t</STRONG> consisting of any
72 combination of attributes (i.e., rendition) and a complex character.
74 <STRONG>o</STRONG> The attribute part of the background is combined (OR'ed) with all
75 non-blank characters that are written into the window with <STRONG>waddch</STRONG>.
77 <STRONG>o</STRONG> Both the character and attribute parts of the background are
78 combined with the blank characters.
80 The background becomes a property of the character and moves with the
81 character through any scrolling and insert/delete line/character
84 To the extent possible on a particular terminal, the attribute part of
85 the background is displayed as the graphic rendition of the character
89 </PRE><H3><a name="h3-bkgrnd">bkgrnd</a></H3><PRE>
90 The <STRONG>bkgrnd</STRONG> and <STRONG>wbkgrnd</STRONG> functions set the background property of the
91 current or specified window and then apply this setting to every
92 character position in that window:
94 <STRONG>o</STRONG> The rendition of every character on the screen is changed to the
95 new background rendition.
97 <STRONG>o</STRONG> Wherever the former background character appears, it is changed to
98 the new background character.
101 </PRE><H3><a name="h3-getbkgrnd">getbkgrnd</a></H3><PRE>
102 The <STRONG>getbkgrnd</STRONG> function returns the given window's current background
103 character/attribute pair via the <STRONG>wch</STRONG> pointer. If the given window
104 pointer is null, the character is not updated (but no error returned).
107 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
108 Note that <STRONG>bkgrnd</STRONG>, <STRONG>bkgrndset</STRONG>, and <STRONG>getbkgrnd</STRONG> may be macros.
110 X/Open Curses does not provide details on how the rendition is changed.
111 This implementation follows the approach used in SVr4 curses, which is
112 explained in the manual page for <STRONG>wbkgd</STRONG>.
115 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
116 The <STRONG>bkgrndset</STRONG> and <STRONG>wbkgrndset</STRONG> routines do not return a value.
118 Upon successful completion, the other functions return <STRONG>OK</STRONG>. Otherwise,
119 they return <STRONG>ERR</STRONG>:
121 <STRONG>o</STRONG> A null window pointer is treated as an error.
123 <STRONG>o</STRONG> A null character pointer is treated as an error.
126 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
127 These functions are described in the XSI Curses standard, Issue 4
131 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
132 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
136 ncurses 6.4 2023-08-12 <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>
140 <li><a href="#h2-NAME">NAME</a></li>
141 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
142 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
144 <li><a href="#h3-bkgrndset">bkgrndset</a></li>
145 <li><a href="#h3-bkgrnd">bkgrnd</a></li>
146 <li><a href="#h3-getbkgrnd">getbkgrnd</a></li>
149 <li><a href="#h2-NOTES">NOTES</a></li>
150 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
151 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
152 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>