X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_bkgd.3x.html;h=59db83f6e471e4398b3a5c656242fd348b7ec8c1;hp=6a4758e2fd4cc3324a8d5810d81932c30b3b0f8c;hb=a0b91dc27f0c411e343161b0a4b5459d15a43f85;hpb=71c0306f0824ef2b10c4c5813fb003db48f3012e diff --git a/doc/html/man/curs_bkgd.3x.html b/doc/html/man/curs_bkgd.3x.html index 6a4758e2..59db83f6 100644 --- a/doc/html/man/curs_bkgd.3x.html +++ b/doc/html/man/curs_bkgd.3x.html @@ -1,7 +1,6 @@ - +
+ +- curs_bkgd(3x) curs_bkgd(3x)-
+NAME
bkgdset, wbkgdset, bkgd, wbkgd, getbkgd - curses window background manipulation routines-SYNOPSIS
+SYNOPSIS
#include <curses.h> - void bkgdset(chtype ch); - void wbkgdset(WINDOW *win, chtype ch); - int bkgd(chtype ch); - int wbkgd(WINDOW *win, chtype ch); - chtype getbkgd(WINDOW *win); + void bkgdset(chtype ch); + void wbkgdset(WINDOW *win, chtype ch); + int bkgd(chtype ch); + int wbkgd(WINDOW *win, chtype ch); + chtype getbkgd(WINDOW *win);-DESCRIPTION
+DESCRIPTION
+ ++bkgdset
The bkgdset and wbkgdset routines manipulate the back- ground of the named window. The window background is a chtype consisting of any combination of attributes (i.e., @@ -80,52 +83,70 @@ attribute part of the background is displayed as the graphic rendition of the character put on the screen. + ++bkgd
The bkgd and wbkgd functions set the background property of the current or specified window and then apply this setting to every character position in that window: - The rendition of every character on the screen is - changed to the new background rendition. + o The rendition of every character on the screen is + changed to the new background rendition. + + o Wherever the former background character appears, it + is changed to the new background character. - Wherever the former background character appears, - it is changed to the new background character. ++getbkgd
The getbkgd function returns the given window's current background character/attribute pair.-RETURN VALUE
+RETURN VALUE
The routines bkgd and wbkgd return the integer OK. The SVr4.0 manual says "or a non-negative integer if immedok is set", but this appears to be an error.-NOTES
+NOTES
Note that bkgdset and bkgd may be macros.-PORTABILITY
+PORTABILITY
These functions are described in the XSI Curses standard, Issue 4. It specifies that bkgd and wbkgd return ERR on failure, but gives no failure conditions.-SEE ALSO
- curses(3x), curs_addch(3x), curs_attr(3x), curs_out- +SEE ALSO
+ curses(3x), curs_addch(3x), curs_attr(3x), curs_out- opts(3x) curs_bkgd(3x)-
- -Man(1) output converted with -man2html - +