X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_bkgd.3x.html;h=0f830ea91103d6e34231c9203e0c11a172b31b41;hp=d498f465c74a9bbf605a80293b71735badee883f;hb=c6cfd97b8beaf0f6deafbf8aac7281cf6aa7f012;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34;ds=sidebyside diff --git a/doc/html/man/curs_bkgd.3x.html b/doc/html/man/curs_bkgd.3x.html index d498f465..0f830ea9 100644 --- a/doc/html/man/curs_bkgd.3x.html +++ b/doc/html/man/curs_bkgd.3x.html @@ -1,33 +1,76 @@ + + +
+ + +- +curs_bkgd(3x) curs_bkgd(3x) + + +-
- bkgdset, wbkgdset, bkgd, wbkgd, getbkgd - curses window +NAME
+ bkgdset, wbkgdset, bkgd, wbkgd, getbkgd - curses window background manipulation routines-SYNOPSIS
- #include <curses.h> +SYNOPSIS
+ #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);-DESCRIPTION
- The bkgdset and wbkgdset routines manipulate the back- +DESCRIPTION
+ 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,7 +81,7 @@ 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: @@ -48,87 +91,48 @@ 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.-RETURN VALUE
- The routines bkgd and wbkgd return the integer OK. The - SVr4.0 manual says "or a non-negative integer if immedok +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
- Note that bkgdset and bkgd may be macros. +NOTES
+ Note that bkgdset and bkgd may be macros.-PORTABILITY
+PORTABILITY
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. + 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_outopts(3x) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +SEE ALSO
+ curses(3x), curs_addch(3x), curs_attr(3x), curs_out- + opts(3x) + curs_bkgd(3x)-
- -Man(1) output converted with -man2html - +