BKGRND(3XCURSES) X/Open Curses Library Functions BKGRND(3XCURSES)

NAME

bkgrnd, bkgrndset, getbkgrnd, wbkgrnd, wbkgrndset, wgetbkgrnd - set or
get the background character (and rendition) of window using a complex
character

SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include -L /usr/xpg4/lib \
-R /usr/xpg4/lib -lcurses [ library... ]

c89 [ flag... ] file... -lcurses [ library... ]

#include <curses.h>

int bkgrnd(const cchar_t *wch);


void bkgrndset(const cchar_t *wch);


int getbkgrnd(cchar_t *wch);


int wbkgrnd(WINDOW *win, const cchar_t *wch);


void wbkgrndset(WINDOW *win, const cchar_t *wch);


int wgetbkgrnd(WINDOW *win, cchar_t *wch);

DESCRIPTION

The bkgrndset() and wbkgrndset() functions turn off the previous
background attributes, logical OR the requested attributes into the
window rendition, and set the background property of the current or
specified window based on the information in wch.


The bkgrnd() and wbkgrnd() functions turn off the previous background
attributes, logical OR the requested attributes into the window
rendition, and set the background property of the current or specified
window and then apply this setting to every character position in that
window:

o The rendition of every character on the screen is changed to
the new window rendition.

o Wherever the former background character appears, it is
changed to the new background character.


If wch refers to a non-spacing complex character for bkgrnd(),
bkgrndset(), wbkgrnd(), and wbkgrndset(), then wch is added to the
existing spacing complex character that is the background character. If
wch refers to a multi-column character, the results are unspecified.


The getbkgrnd() and wgetbkgrnd() functions store, into the area pointed
to buy wch, the window's background character and rendition.

PARAMETERS

wch
Is a pointer to the complex background character to be set.


win
Is a pointer to the window in which the complex background
character is to be set.

RETURN VALUES

The bkgrndset() and wbkgrndset() functions do not return a value.


Upon successful completion, the other functions return OK. Otherwise,
they return ERR.

ERRORS

No errors are defined.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:


+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Standard |
+--------------------+-----------------+
|MT-Level | Unsafe |
+--------------------+-----------------+

SEE ALSO

add_wch(3XCURSES), add_wchnstr(3XCURSES), addch(3XCURSES),
addchstr(3XCURSES), attroff(3XCURSES), bkgd(3XCURSES), clear(3XCURSES),
clrtobot(3XCURSES), clrtoeol(3XCURSES), erase(3XCURSES), inch(3XCURSES),
libcurses(3XCURSES), mvprintw(3XCURSES), attributes(7), standards(7)

June 5, 2002 BKGRND(3XCURSES)