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

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
   2 <!--
   3   ****************************************************************************
   4   * Copyright (c) 1998-2000,2002 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.18 2002/09/21 19:46:26 tom Exp @
  31 -->
  32 <HTML>
  33 <HEAD>
  34 <TITLE>curs_bkgd 3x</TITLE>
  35 <link rev=made href="mailto:bug-ncurses@gnu.org">
  36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  37 </HEAD>
  38 <BODY>
  39 <H1>curs_bkgd 3x</H1>
  40 <HR>
  41 <PRE>
  42 <!-- Manpage converted by man2html 3.0.1 -->
  43
  44 </PRE>
  45 <H2>NAME</H2><PRE>
  46        <STRONG>bkgdset</STRONG>,  <STRONG>wbkgdset</STRONG>,  <STRONG>bkgd</STRONG>,  <STRONG>wbkgd</STRONG>, <STRONG>getbkgd</STRONG> - <STRONG>curses</STRONG> window
  47        background manipulation routines
  48
  49
  50
  51 </PRE>
  52 <H2>SYNOPSIS</H2><PRE>
  53        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  54
  55        <STRONG>void</STRONG> <STRONG>bkgdset(chtype</STRONG> <STRONG>ch);</STRONG>
  56        <STRONG>void</STRONG> <STRONG>wbkgdset(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
  57        <STRONG>int</STRONG> <STRONG>bkgd(chtype</STRONG> <STRONG>ch);</STRONG>
  58        <STRONG>int</STRONG> <STRONG>wbkgd(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
  59        <STRONG>chtype</STRONG> <STRONG>getbkgd(WINDOW</STRONG> <STRONG>*win);</STRONG>
  60
  61
  62 </PRE>
  63 <H2>DESCRIPTION</H2><PRE>
  64        The <STRONG>bkgdset</STRONG> and <STRONG>wbkgdset</STRONG>  routines  manipulate  the  back-
  65        ground  of  the  named window.  The window background is a
  66        <STRONG>chtype</STRONG> consisting of any combination of attributes  (i.e.,
  67        rendition)  and  a  character.   The attribute part of the
  68        background is combined (OR'ed) with all non-blank  charac-
  69        ters  that  are written into the window with <STRONG>waddch</STRONG>.  Both
  70        the character and attribute parts of  the  background  are
  71        combined   with  the  blank  characters.   The  background
  72        becomes a property of the character  and  moves  with  the
  73        character   through   any   scrolling   and  insert/delete
  74        line/character operations.
  75
  76        To the extent  possible  on  a  particular  terminal,  the
  77        attribute  part  of  the  background  is  displayed as the
  78        graphic rendition of the character put on the screen.
  79
  80        The <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> functions set the  background  property
  81        of  the  current  or  specified window and then apply this
  82        setting to every character position in that window:
  83
  84               The rendition of every character on the  screen  is
  85               changed to the new background rendition.
  86
  87               Wherever  the  former background character appears,
  88               it is changed to the new background character.
  89
  90        The <STRONG>getbkgd</STRONG> function returns the  given  window's  current
  91        background character/attribute pair.
  92
  93
  94 </PRE>
  95 <H2>RETURN VALUE</H2><PRE>
  96        The  routines  <STRONG>bkgd</STRONG>  and <STRONG>wbkgd</STRONG> return the integer <STRONG>OK</STRONG>.  The
  97        SVr4.0 manual says "or a non-negative integer  if  <STRONG>immedok</STRONG>
  98        is set", but this appears to be an error.
  99
 100
 101 </PRE>
 102 <H2>NOTES</H2><PRE>
 103        Note that <STRONG>bkgdset</STRONG> and <STRONG>bkgd</STRONG> may be macros.
 104
 105
 106 </PRE>
 107 <H2>PORTABILITY</H2><PRE>
 108        These  functions are described in the XSI Curses standard,
 109        Issue 4.  It specifies that <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> return  <STRONG>ERR</STRONG>  on
 110        failure.  but gives no failure conditions.
 111
 112
 113 </PRE>
 114 <H2>SEE ALSO</H2><PRE>
 115        <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>curs_out-</STRONG>
 116        <STRONG><A HREF="curs_outopts.3x.html">opts(3x)</A></STRONG>
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165 </PRE>
 166 <HR>
 167 <ADDRESS>
 168 Man(1) output converted with
 169 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 170 </ADDRESS>
 171 </BODY>
 172 </HTML>