ef00f7e7ba403c4ce5d3b3aba6487c5bf1d38f3e
[ncurses.git] / man / curs_bkgd.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: curs_bkgd.3x,v 1.24 2015/11/21 01:53:42 tom Exp $
30 .de bP
31 .IP \(bu 4
32 ..
33 .TH curs_bkgd 3X ""
34 .SH NAME
35 \fBbkgdset\fR, \fBwbkgdset\fR,
36 \fBbkgd\fR, \fBwbkgd\fR,
37 \fBgetbkgd\fR \- \fBcurses\fR window background manipulation routines
38 .SH SYNOPSIS
39 \fB#include <curses.h>\fR
40 .PP
41 \fBvoid bkgdset(chtype \fP\fIch\fP\fB);\fR
42 .br
43 \fBvoid wbkgdset(WINDOW *\fP\fIwin, chtype \fP\fIch\fP\fB);\fR
44 .br
45 \fBint bkgd(chtype \fP\fIch\fP\fB);\fR
46 .br
47 \fBint wbkgd(WINDOW *\fP\fIwin\fP\fB, chtype \fP\fIch\fP\fB);\fR
48 .br
49 \fBchtype getbkgd(WINDOW *\fP\fIwin\fP\fB);\fR
50 .br
51 .SH DESCRIPTION
52 .SS bkgdset
53 The \fBbkgdset\fR and \fBwbkgdset\fR routines manipulate the
54 background of the named window.
55 The window background is a \fBchtype\fR consisting of
56 any combination of attributes (i.e., rendition) and a character.
57 The attribute part of the background is combined (OR'ed) with all non-blank
58 characters that are written into the window with \fBwaddch\fR.  Both
59 the character and attribute parts of the background are combined with
60 the blank characters.  The background becomes a property of the
61 character and moves with the character through any scrolling and
62 insert/delete line/character operations.
63 .PP
64 To the extent possible on a particular terminal,
65 the attribute part of the background is displayed
66 as the graphic rendition of the character put on the screen.
67 .SS bkgd
68 .PP
69 The \fBbkgd\fR and \fBwbkgd\fR functions
70 set the background property of the current or specified window
71 and then apply this setting to every character position in that window:
72 .PP
73 .bP
74 The rendition of every character on the screen is changed to
75 the new background rendition.
76 .bP
77 Wherever the former background character
78 appears, it is changed to the new background character.
79 .SS getbkgd
80 .PP
81 The \fBgetbkgd\fR function returns the given window's current background
82 character/attribute pair.
83 .SH RETURN VALUE
84 .PP
85 The routines \fBbkgd\fR and \fBwbkgd\fR return the integer \fBOK\fR.
86 The SVr4.0 manual says "or a non-negative integer if \fBimmedok\fR is set",
87 but this appears to be an error.
88 .SH NOTES
89 .PP
90 Note that \fBbkgdset\fR and \fBbkgd\fR may be macros.
91 .SH PORTABILITY
92 .PP
93 These functions are described in the XSI Curses standard, Issue 4.
94 It specifies that \fBbkgd\fR and \fBwbkgd\fR return \fBERR\fR on failure,
95 but gives no failure conditions.
96 .SH SEE ALSO
97 .na
98 .PP
99 \fBcurses\fR(3X),
100 \fBcurs_addch\fR(3X),
101 \fBcurs_attr\fR(3X),
102 \fBcurs_outopts\fR(3X)