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

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
   4   * Copyright 1998-2015,2017 Free Software Foundation, Inc.                  *
   5   *                                                                          *
   6   * Permission is hereby granted, free of charge, to any person obtaining a  *
   7   * copy of this software and associated documentation files (the            *
   8   * "Software"), to deal in the Software without restriction, including      *
   9   * without limitation the rights to use, copy, modify, merge, publish,      *
  10   * distribute, distribute with modifications, sublicense, and/or sell       *
  11   * copies of the Software, and to permit persons to whom the Software is    *
  12   * furnished to do so, subject to the following conditions:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24   *                                                                          *
  25   * Except as contained in this notice, the name(s) of the above copyright   *
  26   * holders shall not be used in advertising or otherwise to promote the     *
  27   * sale, use or other dealings in this Software without prior written       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * @Id: curs_bkgd.3x,v 1.30 2020/02/02 23:34:34 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>curs_bkgd 3x</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">curs_bkgd 3x</H1>
  43 <PRE>
  44 <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>                                                    <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>bkgdset</STRONG>,  <STRONG>wbkgdset</STRONG>,  <STRONG>bkgd</STRONG>,  <STRONG>wbkgd</STRONG>,  <STRONG>getbkgd</STRONG>  - <STRONG>curses</STRONG> window background
  51        manipulation routines
  52
  53
  54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  55        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  56
  57        <STRONG>void</STRONG> <STRONG>bkgdset(chtype</STRONG> <EM>ch</EM><STRONG>);</STRONG>
  58        <STRONG>void</STRONG> <STRONG>wbkgdset(WINDOW</STRONG> <STRONG>*</STRONG><EM>win,</EM> <EM>chtype</EM> <EM>ch</EM><STRONG>);</STRONG>
  59        <STRONG>int</STRONG> <STRONG>bkgd(chtype</STRONG> <EM>ch</EM><STRONG>);</STRONG>
  60        <STRONG>int</STRONG> <STRONG>wbkgd(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>ch</EM><STRONG>);</STRONG>
  61        <STRONG>chtype</STRONG> <STRONG>getbkgd(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
  62
  63
  64 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  65
  66 </PRE><H3><a name="h3-bkgdset">bkgdset</a></H3><PRE>
  67        The <STRONG>bkgdset</STRONG> and <STRONG>wbkgdset</STRONG> routines  manipulate  the  background  of  the
  68        named window.  The window background is a <STRONG>chtype</STRONG> consisting of any com-
  69        bination  of  attributes  (i.e.,  rendition)  and  a  character.    The
  70        attribute part of the background is combined (OR'ed) with all non-blank
  71        characters that are written into the  window  with  <STRONG>waddch</STRONG>.   Both  the
  72        character  and  attribute parts of the background are combined with the
  73        blank characters.  The background becomes a property of  the  character
  74        and  moves  with  the character through any scrolling and insert/delete
  75        line/character operations.
  76
  77        To the extent possible on a particular terminal, the attribute part  of
  78        the  background  is displayed as the graphic rendition of the character
  79        put on the screen.
  80
  81
  82 </PRE><H3><a name="h3-bkgd">bkgd</a></H3><PRE>
  83        The <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> functions set the background property of the current
  84        or  specified  window  and  then  apply this setting to every character
  85        position in that window.  According to  X/Open  Curses,  it  should  do
  86        this:
  87
  88        <STRONG>o</STRONG>   The  rendition  of  every character on the screen is changed to the
  89            new background rendition.
  90
  91        <STRONG>o</STRONG>   Wherever the former background character appears, it is changed  to
  92            the new background character.
  93
  94        Neither  X/Open Curses nor the SVr4 manual pages give details about the
  95        way the rendition of characters on the screen is updated when  <STRONG>bkgd</STRONG>  or
  96        <STRONG>wbkgd</STRONG> is used to change the background character.
  97
  98        This  implementation,  like  SVr4 curses, does not store the background
  99        and window attribute contributions to each cell separately.  It updates
 100        the rendition by comparing the character, non-color attributes and col-
 101        ors contained in the background.  For each cell in the window,  whether
 102        or not it is blank:
 103
 104        <STRONG>o</STRONG>   The  library  first  compares  the <EM>character</EM>, and if it matches the
 105            current character part of the background, it replaces that with the
 106            new background character.
 107
 108        <STRONG>o</STRONG>   The  library  then  checks  if the cell uses color, i.e., its color
 109            pair value is nonzero.  If not, it simply replaces  the  attributes
 110            and color pair in the cell with those from the new background char-
 111            acter.
 112
 113        <STRONG>o</STRONG>   If the cell uses color, and that matches the color in  the  current
 114            background, the library removes attributes which may have come from
 115            the current background and adds attributes from the new background.
 116            It finishes by setting the cell to use the color from the new back-
 117            ground.
 118
 119        <STRONG>o</STRONG>   If the cell uses color, and that does not match the  color  in  the
 120            current   background,   the  library  updates  only  the  non-color
 121            attributes, first removing those which may have come from the  cur-
 122            rent  background,  and  then  adding  attributes from the new back-
 123            ground.
 124
 125        If the background's character value is zero, a space is assumed.
 126
 127        If the terminal does not support  color,  or  if  color  has  not  been
 128        started   with   <STRONG>start_color</STRONG>,  the  new  background  character's  color
 129        attribute will be ignored.
 130
 131
 132 </PRE><H3><a name="h3-getbkgd">getbkgd</a></H3><PRE>
 133        The <STRONG>getbkgd</STRONG> function returns  the  given  window's  current  background
 134        character/attribute pair.
 135
 136
 137 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 138        These  functions are described in the XSI Curses standard, Issue 4.  It
 139        specifies that <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> return <STRONG>ERR</STRONG> on failure, but gives no fail-
 140        ure conditions.
 141
 142        The  routines  <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> return the integer <STRONG>OK</STRONG>, unless the library
 143        has not been initialized.
 144
 145        In contrast, the SVr4.0 manual says <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> may return <STRONG>OK</STRONG> "or  a
 146        non-negative  integer  if  <STRONG>immedok</STRONG>  is set", which refers to the return
 147        value from <STRONG>wrefresh</STRONG> (used to implement the immediate repainting).   The
 148        SVr4  curses  <STRONG>wrefresh</STRONG>  returns the number of characters written to the
 149        screen during the refresh.  This implementation does not do that.
 150
 151
 152 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 153        Note that <STRONG>bkgdset</STRONG> and <STRONG>bkgd</STRONG> may be macros.
 154
 155        X/Open Curses mentions that the character part of the  background  must
 156        be  a  single-byte  value.   This  implementation, like SVr4, checks to
 157        ensure that, and will reuse the old background character if  the  check
 158        fails.
 159
 160
 161 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 162        These  functions  are  described  in  the  XSI Curses standard, Issue 4
 163        (X/Open Curses).
 164
 165
 166 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 167        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>, <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
 168
 169
 170
 171                                                                  <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
 172 </PRE>
 173 <div class="nav">
 174 <ul>
 175 <li><a href="#h2-NAME">NAME</a></li>
 176 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 177 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
 178 <ul>
 179 <li><a href="#h3-bkgdset">bkgdset</a></li>
 180 <li><a href="#h3-bkgd">bkgd</a></li>
 181 <li><a href="#h3-getbkgd">getbkgd</a></li>
 182 </ul>
 183 </li>
 184 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 185 <li><a href="#h2-NOTES">NOTES</a></li>
 186 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 187 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 188 </ul>
 189 </div>
 190 </BODY>
 191 </HTML>