Lines Matching +full:out +full:- +full:of +full:- +full:window
2 .\" Copyright 2018-2023,2024 Thomas E. Dickey *
3 .\" Copyright 1998-2015,2017 Free Software Foundation, Inc. *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a *
6 .\" copy of this software and associated documentation files (the *
10 .\" copies of the Software, and to permit persons to whom the Software is *
14 .\" in all copies or substantial portions of the Software. *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
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 *
24 .\" Except as contained in this notice, the name(s) of the above copyright *
31 .TH curs_bkgd 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
52 \fB\%getbkgd\fP \-
53 manipulate background of a \fIcurses\fR window of characters
59 \fBint wbkgd(WINDOW *\fIwin\fP, chtype \fIch\fP);
62 \fBvoid wbkgdset(WINDOW *\fIwin\fP, chtype \fIch\fP);
64 \fBchtype getbkgd(WINDOW *\fIwin\fP);
71 window
72 (in the library's non-\*(``wide\*('' configuration)
75 combining a set of attributes
80 The blank character is a spacing character that populates a window's
82 The background's attributes are combined with all non-blank characters
83 written to the window,
84 as with the \fB\%waddch\fP(3X) and \fB\%winsch\fP(3X) families of
87 The blank character and attributes of the background combine with
88 characters written to the window as described below.
89 The background becomes a property of the character and moves with it
93 the attribute part of the background is displayed as the graphic
94 rendition of the character put on the screen.
96 \fB\%bkgd\fP and \fB\%wbkgd\fP set the background property of
97 \fB\%stdscr\fP or the specified window and then apply this setting to
98 every character cell in that window.
100 The rendition of every character in the window changes to the new
107 updates the rendition of each character cell by comparing the character,
108 non-color attributes,
110 The library applies to following procedure to each cell in the window,
129 and its background color matches that of the current window background,
133 It finishes by setting the cell's background to use the new window
137 and its background color does not match that of the current window
140 updates only the non-color attributes,
145 treats a background character value of zero (0) as a blank character.
152 \fB\%bkgdset\fP and \fB\%wbkgdset\fP manipulate the background of
153 the applicable window,
158 \fB\%getbkgd\fP obtains the given window's background character and
163 \fB\%wbkgd\fP and \fB\%getbkgd\fP return \fBERR\fP if a \fI\%WINDOW\fP
168 \fB\%getbkgd\fP returns a window's background character and attribute
174 accepting a \fI\%WINDOW\fP pointer argument.
180 X/Open Curses mentions that the character part of the background must
181 be a single-byte value.
195 (in the case of the last,
202 \*(``or a non-negative integer if \fB\%immedok\fP is set\*('',
205 SVr4 \fIcurses\fP's \fB\%wrefresh\fP returns the number of characters
216 (in its non-\*(``wide\*('' configuration)
217 store the background and window attribute contributions to each
221 \*(``wide\*('' configuration of