ncurses 6.0 - patch 20160326
[ncurses.git] / doc / html / man / curs_bkgd.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2010,2015 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_bkgd.3x,v 1.24 2015/11/21 01:53:42 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_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">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">curs_bkgd 3x</H1>
42 <PRE>
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>
44
45
46
47
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
50        background manipulation routines
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
55
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>
61
62
63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
64
65 </PRE><H3><a name="h3-bkgdset">bkgdset</a></H3><PRE>
66        The <STRONG>bkgdset</STRONG> and <STRONG>wbkgdset</STRONG>  routines  manipulate  the  back-
67        ground  of  the  named window.  The window background is a
68        <STRONG>chtype</STRONG> consisting of any combination of attributes  (i.e.,
69        rendition)  and  a  character.   The attribute part of the
70        background is combined (OR'ed) with all non-blank  charac-
71        ters  that  are written into the window with <STRONG>waddch</STRONG>.  Both
72        the character and attribute parts of  the  background  are
73        combined   with  the  blank  characters.   The  background
74        becomes a property of the character  and  moves  with  the
75        character   through   any   scrolling   and  insert/delete
76        line/character operations.
77
78        To the extent  possible  on  a  particular  terminal,  the
79        attribute  part  of  the  background  is  displayed as the
80        graphic rendition of the character put on the screen.
81
82
83 </PRE><H3><a name="h3-bkgd">bkgd</a></H3><PRE>
84        The <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> functions set the  background  property
85        of  the  current  or  specified window and then apply this
86        setting to every character position in that window:
87
88        <STRONG>o</STRONG>   The rendition of every  character  on  the  screen  is
89            changed to the new background rendition.
90
91        <STRONG>o</STRONG>   Wherever  the  former background character appears, it
92            is changed to the new background character.
93
94
95 </PRE><H3><a name="h3-getbkgd">getbkgd</a></H3><PRE>
96        The <STRONG>getbkgd</STRONG> function returns the  given  window's  current
97        background character/attribute pair.
98
99
100 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
101        The  routines  <STRONG>bkgd</STRONG>  and <STRONG>wbkgd</STRONG> return the integer <STRONG>OK</STRONG>.  The
102        SVr4.0 manual says "or a non-negative integer  if  <STRONG>immedok</STRONG>
103        is set", but this appears to be an error.
104
105
106 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
107        Note that <STRONG>bkgdset</STRONG> and <STRONG>bkgd</STRONG> may be macros.
108
109
110 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
111        These  functions are described in the XSI Curses standard,
112        Issue 4.  It specifies that <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> return  <STRONG>ERR</STRONG>  on
113        failure, but gives no failure conditions.
114
115
116 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
117        <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>curs_out-</STRONG>
118        <STRONG><A HREF="curs_outopts.3x.html">opts(3x)</A></STRONG>
119
120
121
122                                                           <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
123 </PRE>
124 <div class="nav">
125 <ul>
126 <li><a href="#h2-NAME">NAME</a></li>
127 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
128 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
129 <ul>
130 <li><a href="#h3-bkgdset">bkgdset</a></li>
131 <li><a href="#h3-bkgd">bkgd</a></li>
132 <li><a href="#h3-getbkgd">getbkgd</a></li>
133 </ul>
134 </li>
135 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
136 <li><a href="#h2-NOTES">NOTES</a></li>
137 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
138 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
139 </ul>
140 </div>
141 </BODY>
142 </HTML>