ncurses 6.2 - patch 20210619
[ncurses.git] / doc / html / man / curs_bkgrnd.3x.html
index 4a445359c0738e2f05fadbb5d8fbd346b807528d..4e86eeeec0081b23b12e044b1f38b3482dfb2719 100644 (file)
@@ -1,7 +1,7 @@
-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
-<!-- 
+<!--
   ****************************************************************************
-  * Copyright (c) 2002 Free Software Foundation, Inc.                        *
+  * Copyright 2018,2020 Thomas E. Dickey                                     *
+  * Copyright 2002-2015,2017 Free Software Foundation, Inc.                  *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * copy of this software and associated documentation files (the            *
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_bkgrnd.3x,v 1.1 2002/02/23 23:23:42 tom Exp @
+  * @Id: curs_bkgrnd.3x,v 1.12 2020/10/17 23:13:15 tom Exp @
 -->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HEAD>
-<TITLE>curs_bkgrnd 3x</TITLE>
-<link rev=made href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
+<TITLE>curs_bkgrnd 3X</TITLE>
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 </HEAD>
 <BODY>
-<H1>curs_bkgrnd 3x</H1>
-<HR>
+<H1 class="no-header">curs_bkgrnd 3X</H1>
 <PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
-
-</PRE>
-<H2>NAME</H2><PRE>
-       <STRONG>bkgrnd</STRONG>,  <STRONG>wbkgrnd</STRONG>,  <STRONG>bkgrndset</STRONG>, <STRONG>wbkgrndset</STRONG>, <STRONG>getbkgrnd</STRONG>, <STRONG>wget-</STRONG>
-       <STRONG>bkgrnd</STRONG> - <STRONG>curses</STRONG>  window  complex  background  manipulation
-       routines
-
-
-</PRE>
-<H2>SYNOPSIS</H2><PRE>
-       <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
-
-       <STRONG>int</STRONG> <STRONG>bkgrnd(</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
-       <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>
-       <STRONG>void</STRONG> <STRONG>bkgrndset(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
-       <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>
-       <STRONG>int</STRONG> <STRONG>getbkgrnd(cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
-       <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>
-
-
-</PRE>
-<H2>DESCRIPTION</H2><PRE>
-       The <STRONG>bkgrndset</STRONG> and <STRONG>wbkgrndset</STRONG> routines manipulate the back-
-       ground of the named window.  The window  background  is  a
-       <STRONG>cchar_t</STRONG> consisting of any combination of attributes (i.e.,
-       rendition) and a complex character.  The attribute part of
-       the  background  is  combined  (OR'ed)  with all non-blank
-       characters that are written into the window  with  <STRONG>waddch</STRONG>.
-       Both  the  character and attribute parts of the background
-       are combined with the blank  characters.   The  background
-       becomes  a  property  of  the character 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  <STRONG>bkgrnd</STRONG> and <STRONG>wbkgrnd</STRONG> functions set the background prop-
-       erty of the current or specified  window  and  then  apply
-       this setting to every character position in that window:
-
-              The  rendition  of every character on the screen is
-              changed to the new background rendition.
-
-              Wherever the former background  character  appears,
-              it is changed to the new background character.
-
-       The  <STRONG>getbkgrnd</STRONG> function returns the given window's current
-       background character/attribute pair via the <STRONG>wch</STRONG> pointer.
-
-
-
-</PRE>
-<H2>NOTES</H2><PRE>
-       Note that <STRONG>bkgrnd</STRONG>, <STRONG>bkgrndset</STRONG>, and <STRONG>getbkgrnd</STRONG> may be  macros.
-
-
-</PRE>
-<H2>RETURN VALUES</H2><PRE>
-       The  <STRONG>bkgrndset</STRONG>  and  <STRONG>wbkgrndset</STRONG>  routines  do not return a
-       value.
-
-       Upon successful completion, the other functions return <STRONG>OK</STRONG>.
-       Otherwise,  they  return  <STRONG>ERR</STRONG>.   A  null window pointer is
-       treated as an error.
-
-
-</PRE>
-<H2>SEE ALSO</H2><PRE>
-       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+<B><A HREF="curs_bkgrnd.3X.html">curs_bkgrnd(3X)</A></B>                                                <B><A HREF="curs_bkgrnd.3X.html">curs_bkgrnd(3X)</A></B>
 
 
 
 
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
+       <B>bkgrnd</B>,  <B>wbkgrnd</B>, <B>bkgrndset</B>, <B>wbkgrndset</B>, <B>getbkgrnd</B>, <B>wgetbkgrnd</B> - <B>curses</B>
+       window complex background manipulation routines
 
 
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
+       <B>#include</B> <B>&lt;curses.h&gt;</B>
 
+       <B>int</B> <B>bkgrnd(</B> <B>const</B> <B>cchar_t</B> <B>*</B><I>wch</I><B>);</B>
+       <B>int</B> <B>wbkgrnd(</B> <B>WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>const</B> <B>cchar_t</B> <B>*</B><I>wch</I><B>);</B>
 
+       <B>void</B> <B>bkgrndset(const</B> <B>cchar_t</B> <B>*</B><I>wch</I> <B>);</B>
+       <B>void</B> <B>wbkgrndset(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>const</B> <B>cchar_t</B> <B>*</B><I>wch</I><B>);</B>
 
+       <B>int</B> <B>getbkgrnd(cchar_t</B> <B>*</B><I>wch</I><B>);</B>
+       <B>int</B> <B>wgetbkgrnd(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>cchar_t</B> <B>*</B><I>wch</I><B>);</B>
 
 
+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
 
+</PRE><H3><a name="h3-bkgrndset">bkgrndset</a></H3><PRE>
+       The <B>bkgrndset</B> and <B>wbkgrndset</B> routines manipulate the background of  the
+       named  window.   The  window  background is a <B>cchar_t</B> consisting of any
+       combination of attributes (i.e., rendition) and  a  complex  character.
+       The  attribute part of the background is combined (OR'ed) with all non-
+       blank characters that are written into the window  with  <B>waddch</B>.   Both
+       the  character  and attribute parts of the background are combined with
+       the blank  characters.   The  background  becomes  a  property  of  the
+       character  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.
 
 
+</PRE><H3><a name="h3-bkgrnd">bkgrnd</a></H3><PRE>
+       The <B>bkgrnd</B> and <B>wbkgrnd</B> functions set the  background  property  of  the
+       current  or  specified  window  and  then  apply  this setting to every
+       character position in that window:
 
+       <B>o</B>   The rendition of every character on the screen is  changed  to  the
+           new background rendition.
 
+       <B>o</B>   Wherever  the former background character appears, it is changed to
+           the new background character.
 
 
+</PRE><H3><a name="h3-getbkgrnd">getbkgrnd</a></H3><PRE>
+       The <B>getbkgrnd</B> function returns the given  window's  current  background
+       character/attribute  pair  via  the  <B>wch</B>  pointer.  If the given window
+       pointer is null, the character is not updated (but no error returned).
 
 
+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
+       Note that <B>bkgrnd</B>, <B>bkgrndset</B>, and <B>getbkgrnd</B> may be macros.
 
+       X/Open Curses does not provide details on how the rendition is changed.
+       This  implementation follows the approach used in SVr4 curses, which is
+       explained in the manual page for <B>wbkgd</B>.
 
 
+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+       The <B>bkgrndset</B> and <B>wbkgrndset</B> routines do not return a value.
 
+       Upon successful completion, the other functions return <B>OK</B>.   Otherwise,
+       they return <B>ERR</B>:
 
+       <B>o</B>   A null window pointer is treated as an error.
 
+       <B>o</B>   A null character pointer is treated as an error.
 
 
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+       These  functions  are  described  in  the  XSI Curses standard, Issue 4
+       (X/Open Curses).
 
 
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+       <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_bkgd.3X.html">curs_bkgd(3X)</A></B>
 
 
 
+                                                               <B><A HREF="curs_bkgrnd.3X.html">curs_bkgrnd(3X)</A></B>
 </PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
+<ul>
+<li><a href="#h3-bkgrndset">bkgrndset</a></li>
+<li><a href="#h3-bkgrnd">bkgrnd</a></li>
+<li><a href="#h3-getbkgrnd">getbkgrnd</a></li>
+</ul>
+</li>
+<li><a href="#h2-NOTES">NOTES</a></li>
+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+</ul>
+</div>
 </BODY>
 </HTML>