ncurses 5.7 - patch 20100731
[ncurses.git] / doc / html / man / curs_bkgd.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 1998-2003,2010 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_bkgd.3x,v 1.21 2010/07/31 14:36:04 tom Exp @
31 -->
32 <HTML>
33 <HEAD>
34 <TITLE>curs_bkgd 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
37 </HEAD>
38 <BODY>
39 <H1>curs_bkgd 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
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>NAME</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>SYNOPSIS</H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58        <STRONG>void</STRONG> <STRONG>bkgdset(chtype</STRONG> <STRONG>ch);</STRONG>
59        <STRONG>void</STRONG> <STRONG>wbkgdset(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
60        <STRONG>int</STRONG> <STRONG>bkgd(chtype</STRONG> <STRONG>ch);</STRONG>
61        <STRONG>int</STRONG> <STRONG>wbkgd(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
62        <STRONG>chtype</STRONG> <STRONG>getbkgd(WINDOW</STRONG> <STRONG>*win);</STRONG>
63
64
65 </PRE>
66 <H2>DESCRIPTION</H2><PRE>
67        The <STRONG>bkgdset</STRONG> and <STRONG>wbkgdset</STRONG>  routines  manipulate  the  back-
68        ground  of  the  named window.  The window background is a
69        <STRONG>chtype</STRONG> consisting of any combination of attributes  (i.e.,
70        rendition)  and  a  character.   The attribute part of the
71        background is combined (OR'ed) with all non-blank  charac-
72        ters  that  are written into the window with <STRONG>waddch</STRONG>.  Both
73        the character and attribute parts of  the  background  are
74        combined   with  the  blank  characters.   The  background
75        becomes a property of the character  and  moves  with  the
76        character   through   any   scrolling   and  insert/delete
77        line/character operations.
78
79        To the extent  possible  on  a  particular  terminal,  the
80        attribute  part  of  the  background  is  displayed as the
81        graphic rendition of the character put on the screen.
82
83        The <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> functions set the  background  property
84        of  the  current  or  specified window and then apply this
85        setting to every character position in that window:
86
87               The rendition of every character on the  screen  is
88               changed to the new background rendition.
89
90               Wherever  the  former background character appears,
91               it is changed to the new background character.
92
93        The <STRONG>getbkgd</STRONG> function returns the  given  window's  current
94        background character/attribute pair.
95
96
97 </PRE>
98 <H2>RETURN VALUE</H2><PRE>
99        The  routines  <STRONG>bkgd</STRONG>  and <STRONG>wbkgd</STRONG> return the integer <STRONG>OK</STRONG>.  The
100        SVr4.0 manual says "or a non-negative integer  if  <STRONG>immedok</STRONG>
101        is set", but this appears to be an error.
102
103
104 </PRE>
105 <H2>NOTES</H2><PRE>
106        Note that <STRONG>bkgdset</STRONG> and <STRONG>bkgd</STRONG> may be macros.
107
108
109 </PRE>
110 <H2>PORTABILITY</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>
117 <H2>SEE ALSO</H2><PRE>
118        <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>
119        <STRONG><A HREF="curs_outopts.3x.html">opts(3x)</A></STRONG>
120
121
122
123                                                           <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
124 </PRE>
125 <HR>
126 <ADDRESS>
127 Man(1) output converted with
128 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
129 </ADDRESS>
130 </BODY>
131 </HTML>