X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_bkgd.3x.html;h=fd3f228958f1c99309e9fad0bd808087ef931975;hp=cbb0904765bda9599c84d3ed2d09650df5d8361d;hb=bca50d0d8592defee6c584fdedd25f4b1a31345b;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/doc/html/man/curs_bkgd.3x.html b/doc/html/man/curs_bkgd.3x.html index cbb09047..fd3f2289 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) +curs_bkgd(3x) curs_bkgd(3x) --
- bkgdset, wbkgdset, bkgd, wbkgd, getbkgd - curses window - background manipulation routines +
+ bkgdset, wbkgdset, bkgd, wbkgd, getbkgd - curses window background + manipulation routines --
+
#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); --
- 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., - rendition) and a character. The attribute part of the - background is combined (OR'ed) with all non-blank charac- - ters that are written into the window with waddch. Both - the character and attribute parts of the background are - combined with the blank characters. The background - becomes a property of the character and moves with the - character through any scrolling and insert/delete +
+ +
+ The bkgdset and wbkgdset routines manipulate the background of the + named window. The window background is a chtype consisting of any com- + bination of attributes (i.e., rendition) and a character. The + attribute part of the background is combined (OR'ed) with all non-blank + characters that are written into the window with waddch. Both the + character and attribute parts of the background are combined with the + blank characters. The background becomes a property of the character + and moves with the character through any scrolling and insert/delete line/character operations. - To the extent possible on a particular terminal, the - attribute part of the background is displayed as the - graphic rendition of the character put on the screen. + To the extent possible on a particular terminal, the attribute part of + the background is displayed as the graphic rendition of the character + put on the screen. - 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. +
+ 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: - Wherever the former background character appears, - it is changed to the new background character. + o The rendition of every character on the screen is changed to the + new background rendition. - The getbkgd function returns the given window's current - background character/attribute pair. + o Wherever the former background character appears, it is changed to + the new background character. --
- 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. +
+ The getbkgd function returns the given window's current background + character/attribute pair. --
+
+ 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. + + +
Note that bkgdset and bkgd may be macros. --
- 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. +
+ These functions are described in the XSI Curses standard, Issue 4. It + specifies that bkgd and wbkgd return ERR on failure, but gives no fail- + ure conditions. --
- curses(3x), curs_addch(3x), curs_attr(3x), curs_out- - opts(3x) +
+ curses(3x), curs_addch(3x), curs_attr(3x), curs_outopts(3x) - curs_bkgd(3x) + curs_bkgd(3x)-