doc/html/man/curs_bkgd.3x.html

   1 <HTML>
   2 <BODY>
   3 <PRE>
   4 <!-- Manpage converted by man2html 3.0.1 -->
   5
   6 </PRE>
   7 <H2>NAME</H2><PRE>
   8        <B>bkgdset</B>,  <B>wbkgdset</B>,  <B>bkgd</B>,  <B>wbkgd</B>, <B>getbkgd</B> - <B>curses</B> window
   9        background manipulation routines
  10
  11
  12 </PRE>
  13 <H2>SYNOPSIS</H2><PRE>
  14        <B>#include</B> <B>&lt;curses.h&gt;</B>
  15
  16        <B>void</B> <B>bkgdset(const</B> <B>chtype</B> <B>ch);</B>
  17        <B>void</B> <B>wbkgdset(WINDOW</B> <B>*win,</B> <B>const</B> <B>chtype</B> <B>ch);</B>
  18        <B>int</B> <B>bkgd(const</B> <B>chtype</B> <B>ch);</B>
  19        <B>int</B> <B>wbkgd(WINDOW</B> <B>*win,</B> <B>const</B> <B>chtype</B> <B>ch);</B>
  20        <B>chtype</B> <B>getbkgd(WINDOW</B> <B>*win);</B>
  21
  22
  23 </PRE>
  24 <H2>DESCRIPTION</H2><PRE>
  25        The <B>bkgdset</B> and <B>wbkgdset</B>  routines  manipulate  the  back-
  26        ground  of  the  named window.  The window background is a
  27        <B>chtype</B> consisting of any combination of attributes  (i.e.,
  28        rendition)  and  a  character.   The attribute part of the
  29        background is combined (OR'ed) with all non-blank  charac-
  30        ters  that  are written into the window with <B>waddch</B>.  Both
  31        the character and attribute parts of  the  background  are
  32        combined   with  the  blank  characters.   The  background
  33        becomes a property of the character  and  moves  with  the
  34        character   through   any   scrolling   and  insert/delete
  35        line/character operations.
  36
  37        To the extent  possible  on  a  particular  terminal,  the
  38        attribute  part  of  the  background  is  displayed as the
  39        graphic rendition of the character put on the screen.
  40
  41        The <B>bkgd</B> and <B>wbkgd</B> functions set the  background  property
  42        of  the  current  or  specified window and then apply this
  43        setting to every character position in that window:
  44
  45               The rendition of every character on the  screen  is
  46               changed to the new background rendition.
  47
  48               Wherever  the  former background character appears,
  49               it is changed to the new background character.
  50
  51        The <B>getbkgd</B> function returns the  given  window's  current
  52        background character/attribute pair.
  53
  54
  55 </PRE>
  56 <H2>RETURN VALUE</H2><PRE>
  57        The  routines  <B>bkgd</B>  and <B>wbkgd</B> return the integer <B>OK</B>.  The
  58        SVr4.0 manual says "or a non-negative integer  if  <B>immedok</B>
  59        is set", but this appears to be an error.
  60
  61
  62 </PRE>
  63 <H2>NOTES</H2><PRE>
  64        Note that <B>bkgdset</B> and <B>bkgd</B> may be macros.
  65
  66
  67 </PRE>
  68 <H2>PORTABILITY</H2><PRE>
  69        These  functions are described in the XSI Curses standard,
  70        Issue 4.  The draft does not include <B>const</B>  qualifiers  on
  71        the arguments.  The standard specifies that <B>bkgd</B> and <B>wbkgd</B>
  72        return <B>ERR</B>, on failure. but gives no failure conditions.
  73
  74
  75 </PRE>
  76 <H2>SEE ALSO</H2><PRE>
  77        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_addch.3x.html">curs_addch(3x)</A></B>, <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B>
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127 </PRE>
 128 <HR>
 129 <ADDRESS>
 130 Man(1) output converted with
 131 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 132 </ADDRESS>
 133 </BODY>
 134 </HTML>