2002-10-13 11:35:53 +08:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
|
|
|
|
|
<!--
|
|
|
|
|
****************************************************************************
|
2004-02-09 10:15:26 +08:00
|
|
|
* Copyright (c) 1998-2002,2003 Free Software Foundation, Inc. *
|
2002-10-13 11:35:53 +08:00
|
|
|
* *
|
|
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a *
|
|
|
|
|
* copy of this software and associated documentation files (the *
|
|
|
|
|
* "Software"), to deal in the Software without restriction, including *
|
|
|
|
|
* without limitation the rights to use, copy, modify, merge, publish, *
|
|
|
|
|
* distribute, distribute with modifications, sublicense, and/or sell *
|
|
|
|
|
* copies of the Software, and to permit persons to whom the Software is *
|
|
|
|
|
* furnished to do so, subject to the following conditions: *
|
|
|
|
|
* *
|
|
|
|
|
* The above copyright notice and this permission notice shall be included *
|
|
|
|
|
* in all copies or substantial portions of the Software. *
|
|
|
|
|
* *
|
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|
|
|
|
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|
|
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|
|
|
|
* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|
|
|
|
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|
|
|
|
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|
|
|
|
* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|
|
|
|
* *
|
|
|
|
|
* Except as contained in this notice, the name(s) of the above copyright *
|
|
|
|
|
* holders shall not be used in advertising or otherwise to promote the *
|
|
|
|
|
* sale, use or other dealings in this Software without prior written *
|
|
|
|
|
* authorization. *
|
|
|
|
|
****************************************************************************
|
2004-02-09 10:15:26 +08:00
|
|
|
* @Id: curs_bkgd.3x,v 1.19 2003/12/27 18:50:40 tom Exp @
|
2002-10-13 11:35:53 +08:00
|
|
|
-->
|
2000-07-09 10:46:08 +08:00
|
|
|
<HTML>
|
2002-10-13 11:35:53 +08:00
|
|
|
<HEAD>
|
|
|
|
|
<TITLE>curs_bkgd 3x</TITLE>
|
|
|
|
|
<link rev=made href="mailto:bug-ncurses@gnu.org">
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
|
|
|
</HEAD>
|
2000-07-09 10:46:08 +08:00
|
|
|
<BODY>
|
2002-10-13 11:35:53 +08:00
|
|
|
<H1>curs_bkgd 3x</H1>
|
|
|
|
|
<HR>
|
2000-07-09 10:46:08 +08:00
|
|
|
<PRE>
|
|
|
|
|
<!-- Manpage converted by man2html 3.0.1 -->
|
2004-02-09 10:15:26 +08:00
|
|
|
<STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG> <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>NAME</H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>bkgdset</STRONG>, <STRONG>wbkgdset</STRONG>, <STRONG>bkgd</STRONG>, <STRONG>wbkgd</STRONG>, <STRONG>getbkgd</STRONG> - <STRONG>curses</STRONG> window
|
2000-07-09 10:46:08 +08:00
|
|
|
background manipulation routines
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>SYNOPSIS</H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>void</STRONG> <STRONG>bkgdset(chtype</STRONG> <STRONG>ch);</STRONG>
|
|
|
|
|
<STRONG>void</STRONG> <STRONG>wbkgdset(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
|
|
|
|
|
<STRONG>int</STRONG> <STRONG>bkgd(chtype</STRONG> <STRONG>ch);</STRONG>
|
|
|
|
|
<STRONG>int</STRONG> <STRONG>wbkgd(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
|
|
|
|
|
<STRONG>chtype</STRONG> <STRONG>getbkgd(WINDOW</STRONG> <STRONG>*win);</STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>DESCRIPTION</H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
The <STRONG>bkgdset</STRONG> and <STRONG>wbkgdset</STRONG> routines manipulate the back-
|
2000-07-09 10:46:08 +08:00
|
|
|
ground of the named window. The window background is a
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>chtype</STRONG> consisting of any combination of attributes (i.e.,
|
2000-07-09 10:46:08 +08:00
|
|
|
rendition) and a character. The attribute part of the
|
|
|
|
|
background is combined (OR'ed) with all non-blank charac-
|
2002-10-13 11:35:53 +08:00
|
|
|
ters that are written into the window with <STRONG>waddch</STRONG>. Both
|
2000-07-09 10:46:08 +08:00
|
|
|
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.
|
|
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
The <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> functions set the background property
|
2000-07-09 10:46:08 +08:00
|
|
|
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.
|
|
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
The <STRONG>getbkgd</STRONG> function returns the given window's current
|
2000-07-09 10:46:08 +08:00
|
|
|
background character/attribute pair.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>RETURN VALUE</H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
The routines <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> return the integer <STRONG>OK</STRONG>. The
|
|
|
|
|
SVr4.0 manual says "or a non-negative integer if <STRONG>immedok</STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
is set", but this appears to be an error.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>NOTES</H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
Note that <STRONG>bkgdset</STRONG> and <STRONG>bkgd</STRONG> may be macros.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>PORTABILITY</H2><PRE>
|
|
|
|
|
These functions are described in the XSI Curses standard,
|
2002-10-13 11:35:53 +08:00
|
|
|
Issue 4. It specifies that <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> return <STRONG>ERR</STRONG> on
|
|
|
|
|
failure. but gives no failure conditions.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>SEE ALSO</H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<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>
|
|
|
|
|
<STRONG><A HREF="curs_outopts.3x.html">opts(3x)</A></STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2004-02-09 10:15:26 +08:00
|
|
|
<STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
</PRE>
|
|
|
|
|
<HR>
|
|
|
|
|
<ADDRESS>
|
|
|
|
|
Man(1) output converted with
|
|
|
|
|
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
|
|
|
|
|
</ADDRESS>
|
|
|
|
|
</BODY>
|
|
|
|
|
</HTML>
|
