ncurses 6.0 - patch 20170401
[ncurses.git] / doc / html / man / curs_bkgrnd.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 2002-2015,2017 Free Software Foundation, Inc.              *
4   *                                                                          *
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:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
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.                               *
23   *                                                                          *
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       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: curs_bkgrnd.3x,v 1.7 2017/03/25 21:49:00 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_bkgrnd 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">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">curs_bkgrnd 3x</H1>
42 <PRE>
43 <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>                                         <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>
44
45
46
47
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        <STRONG>bkgrnd</STRONG>,  <STRONG>wbkgrnd</STRONG>,  <STRONG>bkgrndset</STRONG>, <STRONG>wbkgrndset</STRONG>, <STRONG>getbkgrnd</STRONG>, <STRONG>wget-</STRONG>
50        <STRONG>bkgrnd</STRONG> - <STRONG>curses</STRONG>  window  complex  background  manipulation
51        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 back-
69        ground of the named window.  The window  background  is  a
70        <STRONG>cchar_t</STRONG> consisting of any combination of attributes (i.e.,
71        rendition) and a complex character.  The attribute part of
72        the  background  is  combined  (OR'ed)  with all non-blank
73        characters that are written into the window  with  <STRONG>waddch</STRONG>.
74        Both  the  character and attribute parts of the background
75        are combined with the blank  characters.   The  background
76        becomes  a  property  of  the character and moves with the
77        character  through   any   scrolling   and   insert/delete
78        line/character operations.
79
80        To  the  extent  possible  on  a  particular terminal, the
81        attribute part of  the  background  is  displayed  as  the
82        graphic rendition of the character put on the screen.
83
84
85 </PRE><H3><a name="h3-bkgrnd">bkgrnd</a></H3><PRE>
86        The  <STRONG>bkgrnd</STRONG> and <STRONG>wbkgrnd</STRONG> functions set the background prop-
87        erty of the current or specified  window  and  then  apply
88        this setting to every character position in that window:
89
90        <STRONG>o</STRONG>   The  rendition  of  every  character  on the screen is
91            changed to the new background rendition.
92
93        <STRONG>o</STRONG>   Wherever the former background character  appears,  it
94            is changed to the new background character.
95
96
97 </PRE><H3><a name="h3-getbkgrnd">getbkgrnd</a></H3><PRE>
98        The  <STRONG>getbkgrnd</STRONG> function returns the given window's current
99        background character/attribute pair via the  <STRONG>wch</STRONG>  pointer.
100        If  the given window pointer is null, the character is not
101        updated (but no error returned).
102
103
104 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
105        Note that <STRONG>bkgrnd</STRONG>, <STRONG>bkgrndset</STRONG>, and <STRONG>getbkgrnd</STRONG> may be macros.
106
107
108 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
109        The <STRONG>bkgrndset</STRONG> and <STRONG>wbkgrndset</STRONG>  routines  do  not  return  a
110        value.
111
112        Upon successful completion, the other functions return <STRONG>OK</STRONG>.
113        Otherwise, 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-SEE-ALSO">SEE ALSO</a></H2><PRE>
121        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
122
123
124
125                                                         <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>
126 </PRE>
127 <div class="nav">
128 <ul>
129 <li><a href="#h2-NAME">NAME</a></li>
130 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
131 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
132 <ul>
133 <li><a href="#h3-bkgrndset">bkgrndset</a></li>
134 <li><a href="#h3-bkgrnd">bkgrnd</a></li>
135 <li><a href="#h3-getbkgrnd">getbkgrnd</a></li>
136 </ul>
137 </li>
138 <li><a href="#h2-NOTES">NOTES</a></li>
139 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
140 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
141 </ul>
142 </div>
143 </BODY>
144 </HTML>