wbkgd(3) [osf1 man page]

curs_bkgd(3)						     Library Functions Manual						      curs_bkgd(3)

NAME

       curs_bkgd, bkgd, wbkgd, bkgdset, wbkgdset, getbkgd - Routines for manipulating the background in a Curses window

SYNOPSIS

       #include <curses.h>

       int bkgd(
	       chtype ch ); int wbkgd(
	       WINDOW *win,
	       chtype ch ); void bkgdset(
	       chtype ch ); voidwbkgdset(
	       WINDOW *win,
	       chtype ch ); chtypegetbkgd(
	       WINDOW *win );

LIBRARY

       Curses Library (libcurses)

STANDARDS

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

       bkgd, wbkgd, bkgdset, wbkgdset, getbkgd:  XCURSES4.2

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

DESCRIPTION

       The bkgdset and wbkgdset routines manipulate the background of the named window. Background is defined as chtype and consists of any combi-
       nation of attributes and a character.  The attribute part of the background is combined (by using an inclusive OR operation) with all  non-
       blank  characters  that waddch writes into the window. 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 character put on the screen.

       The bkgd and wbkgd routines combine the new background with every position in the window. Background is any combination of attributes and a
       character.  Only  the attribute part is used to set the background of nonblank characters, while both character and attributes are used for
       blank positions. To the extent possible on a particular terminal, the attribute part of the background is displayed as the  graphic  rendi-
       tion of the character put on the screen.

       The getbkgd routine returns the background character and attributes, encoded in a chtype data element, for the specified window.

NOTES

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

       Note that bkgdset and bkgd may be macros.

RETURN VALUES

       The bkgd and wbkgd routines return OK on success or ERR on failure.

       The wbkgdset and wbkgdset routines have no return value.

       The getbkgd routine returns the background character and its rendition on success or ERR on failure.

SEE ALSO

       Functions: curses(3), curs_addch(3), curs_bkgrnd(3), curs_outopts(3)

       Others: standards(5)

																      curs_bkgd(3)

Check Out this Related Man Page

curs_bkgd(3X)															     curs_bkgd(3X)

NAME

       bkgdset, wbkgdset, bkgd, wbkgd, getbkgd - curses window background manipulation routines

SYNOPSIS

       #include <curses.h>

       void bkgdset(chtype ch);
       void wbkgdset(WINDOW *win, chtype ch);
       int bkgd(chtype ch);
       int wbkgd(WINDOW *win, chtype ch);
       chtype getbkgd(WINDOW *win);

DESCRIPTION

       The  bkgdset and wbkgdset routines manipulate the background of the named window.  The window background is a chtype consisting of any com-
       bination of attributes (i.e., rendition) and a 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 bkgd and wbkgd 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.

       The getbkgd function returns the given window's current background character/attribute pair.

RETURN VALUE

       The  routines bkgd and wbkgd return the integer OK.  The SVr4.0 manual says "or a non-negative integer if immedok is set", but this appears
       to be an error.

NOTES

       Note that bkgdset and bkgd may be macros.

PORTABILITY

       These functions are described in the XSI Curses standard, Issue 4.  It specifies that bkgd and wbkgd return ERR on failure.  but  gives	no
       failure conditions.

SEE ALSO

       curses(3X), curs_addch(3X), curs_attr(3X), curs_outopts(3X)

																     curs_bkgd(3X)

Linux and UNIX Man Pages

wbkgd(3) [osf1 man page]

Check Out this Related Man Page