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