


curs_bkgd(3X)                                       curs_bkgd(3X)


NNAAMMEE
       ccuurrss__bbkkggdd:  bbkkggddsseett, wwbbkkggddsseett, bbkkggdd, wwbbkkggdd - ccuurrsseess window
       background manipulation routines

SSYYNNOOPPSSIISS
       ##iinncclluuddee <<ccuurrsseess..hh>>

       vvooiidd bbkkggddsseett((ccoonnsstt cchhttyyppee cchh));;
       vvooiidd wwbbkkggddsseett((WWIINNDDOOWW **wwiinn,, ccoonnsstt cchhttyyppee cchh));;
       iinntt bbkkggdd((ccoonnsstt cchhttyyppee cchh));;
       iinntt wwbbkkggdd((WWIINNDDOOWW **wwiinn,, ccoonnsstt cchhttyyppee cchh));;
       iinntt wwggeettbbkkggdd((WWIINNDDOOWW **wwiinn));;

DDEESSCCRRIIPPTTIIOONN
       The bbkkggddsseett and wwbbkkggddsseett  routines  manipulate  the  back-
       ground  of  the named window.  Background is a cchhttyyppee con-
       sisting of any combination of attributes and a  character.
       The  attribute  part  of the background is combined (ORed)
       with all non-blank characters that are  written  into  the
       window  with  wwaaddddcchh.   Both  the  character and attribute
       parts of the background are combined with the blank  char-
       acters.   The background becomes a property of the charac-
       ter 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 bbkkggdd and wwbbkkggdd routines  combine  the  new  background
       with every position in the window.  Background is any com-
       bination  of  attributes  and  a  character.    Only   the
       attribute  part is used to set the background of non-blank
       characters, while both character and attributes  are  used
       for blank positions.  To the extent possible on a particu-
       lar terminal, the attribute part of the background is dis-
       played  as  the  graphic rendition of the character put on
       the screen.

       The wwggeettbbkkggdd function returns the given  window's  current
       background character/attribute pair.

RREETTUURRNN VVAALLUUEE
       The  routines  bbkkggdd  and  wwbbkkggddreturn the integer OOKK.  The
       SVr4.0 manual says "or a non-negative integer  if  iimmmmeeddookk
       is set", but this appears to be an error.

NNOOTTEESS
       Note that bbkkggddsseett and bbkkggdd may be macros.

PPOORRTTAABBIILLIITTYY
       These  functions are described in the XSI Curses standard,
       Issue 4.  The draft does not include ccoonnsstt  qualifiers  on
       the arguments.  The standard specifies that bbkkggdd and wwbbkkggdd
       return EERRRR, on failure. but gives no  failure  conditions.



                                                                1





curs_bkgd(3X)                                       curs_bkgd(3X)


       The  draft  describes  the new function wwggeettbbkkggdd, which is
       not in SVr4.

SSEEEE AALLSSOO
       ccuurrsseess(3X), ccuurrss__aaddddcchh(3X), ccuurrss__oouuttooppttss(3X)




















































                                                                2


