bkgd(3curses)
bkgd --
background attribute manipulation
Synopsis
cc [options] file -lcurses
#include <curses.h>
int bkgd(chtype ch);
void bkgdset(chtype ch);
chtype getbkgd(WINDOW *win);
int wbkgd(WINDOW *win, chtype ch);
void wbkgdset(WINDOW *win, chtype ch);
Description
The
bkgdset(3curses)
and
wbkgdset(3curses)
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 ch.
If ch refers to a multi-column character, the results are undefined.
The
bkgd(3curses)
and
wbkgd(3curses)
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:
-
The rendition of every character on the screen is changed to the new
window rendition.
-
Wherever the former background character appears, it is changed to the new
background character.
The
getbkgd(3curses)
function extracts the specified window's background character and rendition.
Return value
Upon successful completion,
bkgd(3curses)
and
wbkgd(3curses)
return OK. Otherwise, they return ERR.
The
bkgdset(3curses)
and
wbkgdset(3curses)
functions do not return a value.
Upon successful completion,
getbkgd(3curses)
returns the specified window's background character and rendition.
Otherwise, it returns (chtype)ERR.
Errors
No errors are defined.
Usage
These functions are only guaranteed to operate reliably on character sets in
which each character fits into a single byte, whose attributes can be
expressed using only constants with the A_ prefix.
Standards Conformance
The Single UNIX Specification, Version 2; The Open Group.
References
``Rendition'',
curses(4)
© 2004 The SCO Group, Inc. All rights reserved.
UnixWare 7 Release 7.1.4 - 25 April 2004