doc/html/man/curs_bkgrnd.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright (c) 2002-2015,2017 Free Software Foundation, Inc.              *
   4   *                                                                          *
   5   * Permission is hereby granted, free of charge, to any person obtaining a  *
   6   * copy of this software and associated documentation files (the            *
   7   * "Software"), to deal in the Software without restriction, including      *
   8   * without limitation the rights to use, copy, modify, merge, publish,      *
   9   * distribute, distribute with modifications, sublicense, and/or sell       *
  10   * copies of the Software, and to permit persons to whom the Software is    *
  11   * furnished to do so, subject to the following conditions:                 *
  12   *                                                                          *
  13   * The above copyright notice and this permission notice shall be included  *
  14   * in all copies or substantial portions of the Software.                   *
  15   *                                                                          *
  16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23   *                                                                          *
  24   * Except as contained in this notice, the name(s) of the above copyright   *
  25   * holders shall not be used in advertising or otherwise to promote the     *
  26   * sale, use or other dealings in this Software without prior written       *
  27   * authorization.                                                           *
  28   ****************************************************************************
  29   * @Id: curs_bkgrnd.3x,v 1.7 2017/03/25 21:49:00 tom Exp @
  30 -->
  31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  32 <HTML>
  33 <HEAD>
  34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
  36 <TITLE>curs_bkgrnd 3x</TITLE>
  37 <link rev=made href="mailto:bug-ncurses@gnu.org">
  38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  39 </HEAD>
  40 <BODY>
  41 <H1 class="no-header">curs_bkgrnd 3x</H1>
  42 <PRE>
  43 <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>                                                <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>
  44
  45
  46
  47
  48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  49        <STRONG>bkgrnd</STRONG>,  <STRONG>wbkgrnd</STRONG>, <STRONG>bkgrndset</STRONG>, <STRONG>wbkgrndset</STRONG>, <STRONG>getbkgrnd</STRONG>, <STRONG>wgetbkgrnd</STRONG> - <STRONG>curses</STRONG>
  50        window complex background manipulation routines
  51
  52
  53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  55
  56        <STRONG>int</STRONG> <STRONG>bkgrnd(</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
  57        <STRONG>int</STRONG> <STRONG>wbkgrnd(</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
  58        <STRONG>void</STRONG> <STRONG>bkgrndset(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
  59        <STRONG>void</STRONG> <STRONG>wbkgrndset(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
  60        <STRONG>int</STRONG> <STRONG>getbkgrnd(cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
  61        <STRONG>int</STRONG> <STRONG>wgetbkgrnd(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
  62
  63
  64 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  65
  66 </PRE><H3><a name="h3-bkgrndset">bkgrndset</a></H3><PRE>
  67        The <STRONG>bkgrndset</STRONG> and <STRONG>wbkgrndset</STRONG> routines manipulate the background of  the
  68        named  window.   The  window  background is a <STRONG>cchar_t</STRONG> consisting of any
  69        combination of attributes (i.e., rendition) and  a  complex  character.
  70        The  attribute part of the background is combined (OR'ed) with all non-
  71        blank characters that are written into the window  with  <STRONG>waddch</STRONG>.   Both
  72        the  character  and attribute parts of the background are combined with
  73        the blank characters.  The background becomes a property of the charac-
  74        ter   and   moves   with   the  character  through  any  scrolling  and
  75        insert/delete 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-bkgrnd">bkgrnd</a></H3><PRE>
  83        The <STRONG>bkgrnd</STRONG> and <STRONG>wbkgrnd</STRONG> functions set the  background  property  of  the
  84        current  or specified window and then apply this setting to every char-
  85        acter position in that window:
  86
  87        <STRONG>o</STRONG>   The rendition of every character on the screen is  changed  to  the
  88            new background rendition.
  89
  90        <STRONG>o</STRONG>   Wherever  the former background character appears, it is changed to
  91            the new background character.
  92
  93
  94 </PRE><H3><a name="h3-getbkgrnd">getbkgrnd</a></H3><PRE>
  95        The <STRONG>getbkgrnd</STRONG> function returns the given  window's  current  background
  96        character/attribute  pair  via  the  <STRONG>wch</STRONG>  pointer.  If the given window
  97        pointer is null, the character is not updated (but no error returned).
  98
  99
 100 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 101        Note that <STRONG>bkgrnd</STRONG>, <STRONG>bkgrndset</STRONG>, and <STRONG>getbkgrnd</STRONG> may be macros.
 102
 103
 104 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 105        The <STRONG>bkgrndset</STRONG> and <STRONG>wbkgrndset</STRONG> routines do not return a value.
 106
 107        Upon successful completion, the other functions return <STRONG>OK</STRONG>.   Otherwise,
 108        they return <STRONG>ERR</STRONG>:
 109
 110        <STRONG>o</STRONG>   A null window pointer is treated as an error.
 111
 112        <STRONG>o</STRONG>   A null character pointer is treated as an error.
 113
 114
 115 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 116        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
 117
 118
 119
 120                                                                <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>
 121 </PRE>
 122 <div class="nav">
 123 <ul>
 124 <li><a href="#h2-NAME">NAME</a></li>
 125 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 126 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
 127 <ul>
 128 <li><a href="#h3-bkgrndset">bkgrndset</a></li>
 129 <li><a href="#h3-bkgrnd">bkgrnd</a></li>
 130 <li><a href="#h3-getbkgrnd">getbkgrnd</a></li>
 131 </ul>
 132 </li>
 133 <li><a href="#h2-NOTES">NOTES</a></li>
 134 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 135 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 136 </ul>
 137 </div>
 138 </BODY>
 139 </HTML>