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