X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_bkgd.3x.html;h=81cdf90cf26111ceb7303bca27359d3f441f91d7;hb=5461fc336d03fbfea6b85ac21c6d49c528f6752d;hp=d498f465c74a9bbf605a80293b71735badee883f;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34;p=ncurses.git diff --git a/doc/html/man/curs_bkgd.3x.html b/doc/html/man/curs_bkgd.3x.html index d498f465..81cdf90c 100644 --- a/doc/html/man/curs_bkgd.3x.html +++ b/doc/html/man/curs_bkgd.3x.html @@ -1,33 +1,74 @@ + + +
+ + +- +curs_bkgd(3x) curs_bkgd(3x) --
- bkgdset, wbkgdset, bkgd, wbkgd, getbkgd - curses window + + + +
+ bkgdset, wbkgdset, bkgd, wbkgd, getbkgd - curses window background manipulation routines --
- #include <curses.h> +
+ #include <curses.h> - void bkgdset(const chtype ch); - void wbkgdset(WINDOW *win, const chtype ch); - int bkgd(const chtype ch); - int wbkgd(WINDOW *win, const 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- +
+ +
+ 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., + 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 + 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 @@ -38,97 +79,64 @@ 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 + +
+ 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. - Wherever the former background character appears, - it is changed to the new background character. + o Wherever the former background character appears, it + is changed to the new background character. - The getbkgd function returns the given window's current + +
+ 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 +
+ 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. +
+ Note that bkgdset and bkgd may be macros. --
+
These functions are described in the XSI Curses standard, - Issue 4. The draft does not include const qualifiers on - the arguments. The standard specifies that bkgd and wbkgd - return ERR, on failure. but gives no failure conditions. - - --
- curses(3x), curs_addch(3x), curs_outopts(3x) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + Issue 4. It specifies that bkgd and wbkgd return ERR on + failure, but gives no failure conditions. +
+ curses(3x), curs_addch(3x), curs_attr(3x), curs_out- + opts(3x) + curs_bkgd(3x)-