curs_bkgd man page on MirBSD

Man page or keyword search:  
man Server   6113 pages
apropos Keyword Search (all sections)
Output format
MirBSD logo
[printable version]



curs_bkgd(3)	    UNIX Programmer's Manual	     curs_bkgd(3)

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 con-
     sisting of any combination 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 attri-
     bute part of the background is displayed as the graphic ren-
     dition of the character 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,

MirOS BSD #10-current	Printed 18.8.2011			1

curs_bkgd(3)	    UNIX Programmer's Manual	     curs_bkgd(3)

     Issue 4. It specifies that bkgd and wbkgd return ERR on
     failure. but gives no failure conditions.

SEE ALSO
     curses(3), curs_addch(3), curs_attr(3), curs_outopts(3)

MirOS BSD #10-current	Printed 18.8.2011			2

[top]

List of man pages available for MirBSD

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net