ncurses 5.7 - patch 20100731
[ncurses.git] / man / curs_bkgrnd.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 2002-2004,2006 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_bkgrnd.3x,v 1.3 2006/02/25 21:49:19 tom Exp $
30 .TH curs_bkgrnd 3X ""
31 .SH NAME
32 \fBbkgrnd\fR,
33 \fBwbkgrnd\fR,
34 \fBbkgrndset\fR,
35 \fBwbkgrndset\fR,
36 \fBgetbkgrnd\fR,
37 \fBwgetbkgrnd\fR \- \fBcurses\fR window complex background manipulation routines
38 .SH SYNOPSIS
39 .PP
40 .B #include <curses.h>
41 .sp
42 \fBint bkgrnd(\fR\fB const cchar_t *\fR\fIwch\fR\fB);\fR
43 .br
44 \fBint wbkgrnd(\fR\fB WINDOW *\fR\fIwin\fR\fB, const cchar_t *\fR\fIwch\fR\fB);\fR
45 .br
46 \fBvoid bkgrndset(const cchar_t *\fR\fIwch\fR \fB);\fR
47 .br
48 \fBvoid wbkgrndset(WINDOW *\fR\fIwin\fR\fB, const cchar_t *\fR\fIwch\fR\fB);\fR
49 .br
50 \fBint getbkgrnd(cchar_t *\fR\fIwch\fR\fB);\fR
51 .br
52 \fBint wgetbkgrnd(WINDOW *\fR\fIwin\fR\fB, cchar_t *\fR\fIwch\fR\fB);\fR
53 .br
54 .SH DESCRIPTION
55 The \fBbkgrndset\fR and \fBwbkgrndset\fR routines manipulate the
56 background of the named window.
57 The window background is a \fBcchar_t\fR consisting of
58 any combination of attributes (i.e., rendition) and a complex character.
59 The attribute part of the background is combined (OR'ed) with all non-blank
60 characters that are written into the window with \fBwaddch\fR.  Both
61 the character and attribute parts of the background are combined with
62 the blank characters.
63 The background becomes a property of the
64 character and moves with the character through any scrolling and
65 insert/delete line/character operations.
66 .PP
67 To the extent possible on a
68 particular terminal, the attribute part of the background is displayed
69 as the graphic rendition of the character put on the screen.
70 .PP
71 The \fBbkgrnd\fR and \fBwbkgrnd\fR functions
72 set the background property of the current or specified window
73 and then apply this setting to every character position in that window:
74 .RS
75 .PP
76 The rendition of every character on the screen is changed to
77 the new background rendition.
78 .PP
79 Wherever the former background character
80 appears, it is changed to the new background character.
81 .RE
82 .PP
83 The \fBgetbkgrnd\fR function returns the given window's current background
84 character/attribute pair via the \fBwch\fR pointer.
85 .
86 .SH NOTES
87 Note that
88 \fBbkgrnd\fR,
89 \fBbkgrndset\fR, and
90 \fBgetbkgrnd\fR
91 may be macros.
92 .SH RETURN VALUES
93 The \fBbkgrndset\fR and \fBwbkgrndset\fR routines do not return a value.
94 .PP
95 Upon successful completion, the other functions return \fBOK\fR.
96 Otherwise, they return \fBERR\fR.
97 A null window pointer is treated as an error.
98 .SH SEE ALSO
99 \fBcurses\fR(3X),
100 \fBcurs_bkgd\fR(3X)
101 .\"#
102 .\"# The following sets edit modes for GNU EMACS
103 .\"# Local Variables:
104 .\"# mode:nroff
105 .\"# fill-column:79
106 .\"# End: