X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_bkgrnd.3x.html;h=e4b0143d42a66b138ddd5402a0219b61471a63ea;hb=8e397cccba0aad135cb9a8a353756f4273a7cdf6;hp=5dc6fdb16a2b205c3a895abd85b12cdb17c2e0fb;hpb=3a935d9991cdf43ebfa952073c9b555f73a3e011;p=ncurses.git diff --git a/doc/html/man/curs_bkgrnd.3x.html b/doc/html/man/curs_bkgrnd.3x.html index 5dc6fdb1..e4b0143d 100644 --- a/doc/html/man/curs_bkgrnd.3x.html +++ b/doc/html/man/curs_bkgrnd.3x.html @@ -1,7 +1,6 @@ - +
+ +- curs_bkgrnd(3x) curs_bkgrnd(3x) --
+
bkgrnd, wbkgrnd, bkgrndset, wbkgrndset, getbkgrnd, wget- bkgrnd - curses window complex background manipulation routines --
+
#include <curses.h> int bkgrnd( const cchar_t *wch); @@ -64,8 +62,9 @@ int wgetbkgrnd(WINDOW *win, cchar_t *wch); --
+
+ +
The bkgrndset and wbkgrndset routines manipulate the back- ground of the named window. The window background is a cchar_t consisting of any combination of attributes (i.e., @@ -82,47 +81,64 @@ attribute part of the background is displayed as the graphic rendition of the character put on the screen. + +
The bkgrnd and wbkgrnd functions set the background prop- erty 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. +
The getbkgrnd function returns the given window's current - background character/attribute pair via the wch pointer. + background character/attribute pair via the wch pointer. + If the given window pointer is null, the character is not + updated (but no error returned). --
+
Note that bkgrnd, bkgrndset, and getbkgrnd may be macros. --
+
The bkgrndset and wbkgrndset routines do not return a value. Upon successful completion, the other functions return OK. - Otherwise, they return ERR. A null window pointer is - treated as an error. + Otherwise, they return ERR: + o A null window pointer is treated as an error. --
+ o A null character pointer is treated as an error. + + +
curses(3x), curs_bkgd(3x) curs_bkgrnd(3x)-