NAME
bkgrnd, bkgrndset, getbkgrnd, wbkgrnd, wbkgrndset, wgetbkgrnd — set or get background character and rendition using a complex character
SYNOPSIS
#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 set the background property of the current or specified window
based on the information in wch.
The
bkgrnd()
and
wbkgrnd()
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.
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 by wch, the value of the
window's background character and rendition.
RETURN VALUE
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.
CHANGE HISTORY
First released in X/Open Curses, Issue 4.
Printable version
