Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

bkgdset(3) [netbsd man page]

CURSES_BACKGROUND(3)					   BSD Library Functions Manual 				      CURSES_BACKGROUND(3)

curses_background, bkgd, bkgdset, getbkgd, wbkgd, wbkgdset -- curses attribute manipulation routines LIBRARY
Curses Library (libcurses, -lcurses) SYNOPSIS
#include <curses.h> int bkgd(chtype); int bkgdset(chtype); chtype getbkgd(WINDOW *); int wbkgd(chtype); int wbkgdset(chtype); DESCRIPTION
These functions manipulate the background attributes on stdscr or on the specified window. The function wbkgdset(win, ch) sets the background attributes of the specified window win to ch. When the background attributes are set on a window, characters are added to the window with the logical OR of the background attributes and the character's attributes. If both the background attribute and the character attribute contain color, the color of the character attribute is rendered. If the background attribute contains a non-space character, then this character is added where the foreground character is a space character. Note that subwindows created from win inherit the background attributes of win. The function wbkgd(win, ch) sets the background attributes of the specified window win to ch and also sets the rendition of every character position on that window, as if the characters had been newly added to win. The rendition of characters on subwindows of win is also set to ch. The functions bkgdset(ch) and bkgd(ch) are equivalent to wbkgdset(stdscr, ch) and wbkgd(stdscr, ch), respectively. The function getbkgd(win) returns the background attributes for the window win. RETURN VALUES
The functions wbkgdset() and wbkgd() return OK on success and ERR on failure. SEE ALSO
curses_attributes(3), curses_color(3), curses_window(3) STANDARDS
The NetBSD Curses library complies with the X/Open Curses specification, part of the Single Unix Specification. HISTORY
These functions first appeared in NetBSD 1.6. BSD
January 15, 2006 BSD

Check Out this Related Man Page

curs_bkgd(3X)															     curs_bkgd(3X)

bkgdset, wbkgdset, bkgd, wbkgd, getbkgd - curses window background manipulation routines 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); DESCRIPTION
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 charac- ter 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. Wherever the former background character appears, it is changed to the new background character. 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 is set", but this appears to be an error. NOTES
Note that bkgdset and bkgd may be macros. 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_outopts(3X) curs_bkgd(3X)
Man Page