Content-type: text/html Man page of curs_bkgrnd

curs_bkgrnd

Section: C Library Functions (3)
Index Return to Main Contents
 

NAME

curs_bkgrnd, bkgrnd, wbkgrnd, bkgrndset, wbkgrndset, getbkgrnd, wgetbkgrnd - Set or get background character and rendition by using a complex character  

SYNOPSIS

#include <curses.h>

int bkgrnd( const cchar_t *wch ); int wbkgrnd( WINDOW *win, const cchar_t *wch ); void bkgrndset( const cchar_t *wch ); void wbkgrndset( WINDOW *win, const cchar_t *wch ); int getbkgrnd( cchar_t *wch ); int wgetbkgrnd( WINDOW *win, cchar_t *wch );
 

LIBRARY

Curses Library (libcurses)
 

STANDARDS

Interfaces documented on this reference page conform to industry standards as follows:

bkgrnd, wbkgrnd, bkgrndset, wbkgrndset, getbkgrnd, wgetbkgrnd:  XPG4-UNIX

Refer to the standards(5) reference page for more information about industry standards and associated tags.
 

DESCRIPTION

By using the information in wch, the bkgrndset and wbkgrndset functions set the background rendition and manipulate the window rendition of the current or specified window. These functions turn off the previous background attributes from the current window rendition and add the new background rendition from wch into the window rendition.

The bkgrnd and wbkgrnd functions set the background rendition and manipulate the window rendition of the current or specified window. These functions turn off the previous background attributes from the current window rendition and add the new background rendition from wch into the window rendition. They then apply this setting to every character position in that window as follows: 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.

If wch refers to a nonspacing complex character for bkgrnd, bkgrndset, wbkgrnd, or wbkgrndset, then wch is added to the existing spacing complex character that is the background character. If wch refers to a multicolumn 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.
 

NOTES

The header file <curses.h> automatically includes the header file <stdio.h>.

Note that bkgrnd, bkgrndset, and getbkgrnd may be macros.
 

RETURN VALUES

The bkgrndset and wbkgrndset functions do not return a value.

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

SEE ALSO

Functions: curses(3), curs_bkgd(3)

Others: standards(5)


 

Index

NAME
SYNOPSIS
LIBRARY
STANDARDS
DESCRIPTION
NOTES
RETURN VALUES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:41:30 GMT, October 02, 2010