ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / curs_bkgrnd.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright 2018,2020 Thomas E. Dickey                                     *
4   * Copyright 2002-2015,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_bkgrnd.3x,v 1.11 2020/02/02 23:34:34 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
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</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">curs_bkgrnd 3x</H1>
43 <PRE>
44 <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>                                                <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>
45
46
47
48
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
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
56
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>
59        <STRONG>void</STRONG> <STRONG>bkgrndset(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
60        <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>
61        <STRONG>int</STRONG> <STRONG>getbkgrnd(cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
62        <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>
63
64
65 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
66
67 </PRE><H3><a name="h3-bkgrndset">bkgrndset</a></H3><PRE>
68        The <STRONG>bkgrndset</STRONG> and <STRONG>wbkgrndset</STRONG> routines manipulate the background of  the
69        named  window.   The  window  background is a <STRONG>cchar_t</STRONG> consisting of any
70        combination of attributes (i.e., rendition) and  a  complex  character.
71        The  attribute part of the background is combined (OR'ed) with all non-
72        blank characters that are written into the window  with  <STRONG>waddch</STRONG>.   Both
73        the  character  and attribute parts of the background are combined with
74        the blank characters.  The background becomes a property of the charac-
75        ter   and   moves   with   the  character  through  any  scrolling  and
76        insert/delete line/character operations.
77
78        To the extent possible on a particular terminal, the attribute part  of
79        the  background  is displayed as the graphic rendition of the character
80        put on the screen.
81
82
83 </PRE><H3><a name="h3-bkgrnd">bkgrnd</a></H3><PRE>
84        The <STRONG>bkgrnd</STRONG> and <STRONG>wbkgrnd</STRONG> functions set the  background  property  of  the
85        current  or specified window and then apply this setting to every char-
86        acter position in that window:
87
88        <STRONG>o</STRONG>   The rendition of every character on the screen is  changed  to  the
89            new background rendition.
90
91        <STRONG>o</STRONG>   Wherever  the former background character appears, it is changed to
92            the new background character.
93
94
95 </PRE><H3><a name="h3-getbkgrnd">getbkgrnd</a></H3><PRE>
96        The <STRONG>getbkgrnd</STRONG> function returns the given  window's  current  background
97        character/attribute  pair  via  the  <STRONG>wch</STRONG>  pointer.  If the given window
98        pointer is null, the character is not updated (but no error returned).
99
100
101 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
102        Note that <STRONG>bkgrnd</STRONG>, <STRONG>bkgrndset</STRONG>, and <STRONG>getbkgrnd</STRONG> may be macros.
103
104        X/Open Curses does not provide details on how the rendition is changed.
105        This  implementation follows the approach used in SVr4 curses, which is
106        explained in the manual page for <STRONG>wbkgd</STRONG>.
107
108
109 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
110        The <STRONG>bkgrndset</STRONG> and <STRONG>wbkgrndset</STRONG> routines do not return a value.
111
112        Upon successful completion, the other functions return <STRONG>OK</STRONG>.   Otherwise,
113        they return <STRONG>ERR</STRONG>:
114
115        <STRONG>o</STRONG>   A null window pointer is treated as an error.
116
117        <STRONG>o</STRONG>   A null character pointer is treated as an error.
118
119
120 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
121        These  functions  are  described  in  the  XSI Curses standard, Issue 4
122        (X/Open Curses).
123
124
125 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
126        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
127
128
129
130                                                                <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>
131 </PRE>
132 <div class="nav">
133 <ul>
134 <li><a href="#h2-NAME">NAME</a></li>
135 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
136 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
137 <ul>
138 <li><a href="#h3-bkgrndset">bkgrndset</a></li>
139 <li><a href="#h3-bkgrnd">bkgrnd</a></li>
140 <li><a href="#h3-getbkgrnd">getbkgrnd</a></li>
141 </ul>
142 </li>
143 <li><a href="#h2-NOTES">NOTES</a></li>
144 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
145 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
146 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
147 </ul>
148 </div>
149 </BODY>
150 </HTML>