wgetbkgrnd(3) [osf1 man page]

curs_bkgrnd(3)						     Library Functions Manual						    curs_bkgrnd(3)

NAME

       curs_bkgrnd,  bkgrnd, wbkgrnd, bkgrndset, wbkgrndset, getbkgrnd, wgetbkgrnd - Set or get background character and rendition by using a com-
       plex 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:  XCURSES4.2

       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 back-
       ground 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)

																    curs_bkgrnd(3)

Check Out this Related Man Page

curs_bkgrnd(3X) 														   curs_bkgrnd(3X)

NAME

       bkgrnd, wbkgrnd, bkgrndset, wbkgrndset, getbkgrnd, wgetbkgrnd - curses window complex background manipulation routines

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);

DESCRIPTION

       The  bkgrndset and wbkgrndset routines manipulate the background of the named window.  The window background is a cchar_t consisting of any
       combination of attributes (i.e., rendition) and a complex 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 bkgrnd and wbkgrnd functions set the background property of the current or specified window and then apply this setting to every  char-
       acter 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 getbkgrnd function returns the given window's current background character/attribute pair via the wch pointer.

NOTES

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

RETURN VALUE

       The bkgrndset and wbkgrndset routines do not return a value.

       Upon successful completion, the other functions return OK.  Otherwise, they return ERR.	A null window pointer is treated as an error.

SEE ALSO

       curses(3X), curs_bkgd(3X)

																   curs_bkgrnd(3X)

Linux and UNIX Man Pages

wgetbkgrnd(3) [osf1 man page]

Check Out this Related Man Page