MirOS Manual: bkgrnd(3), bkgrndset(3), curs_bkgrnd(3), getbkgrnd(3), wbkgrnd(3), wbkgrndset(3), wgetbkgrnd(3)


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

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 back-
     ground 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 char-
     acters that are written into the window with waddch.  Both
     the character and attribute parts of the background are com-
     bined 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 bkgrnd and wbkgrnd functions set the background property
     of the current or specified window and then apply this set-
     ting 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 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 VALUES

     The bkgrndset and wbkgrndset routines do not return a value.

MirOS BSD #10-current  Printed 03.04.2017                       1

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

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

SEE ALSO

     curses(3), curs_bkgd(3)

MirOS BSD #10-current  Printed 03.04.2017                       2

Generated on 2017-04-03 16:26:17 by $MirOS: src/scripts/roff2htm,v 1.88 2017/01/29 00:51:06 tg Exp $

These manual pages and other documentation are copyrighted by their respective writers; their source is available at our CVSweb, AnonCVS, and other mirrors. The rest is Copyright © 2002–2017 The MirOS Project, Germany.
This product includes material provided by mirabilos.

This manual page’s HTML representation is supposed to be valid XHTML/1.1; if not, please send a bug report — diffs preferred.