+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<!--
+ ****************************************************************************
+ * Copyright (c) 1998-2000,2002 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 *
+ * "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. *
+ ****************************************************************************
+ * Author: Thomas E. Dickey <dickey@clark.net> 1997,1999,2000
+ * @Id: default_colors.3x,v 1.16 2002/02/16 22:39:52 tom Exp @
+-->
<HTML>
+<HEAD>
+<TITLE>default_colors 3x</TITLE>
+<link rev=made href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
<BODY>
+<H1>default_colors 3x</H1>
+<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
</PRE>
<H2>NAME</H2><PRE>
- <B>default_colors</B>: <B>use_default_colors</B>, <B>assume_default_colors</B>
- - use terminal's default colors
+ <STRONG>use_default_colors</STRONG>, <STRONG>assume_default_colors</STRONG> - use terminal's
+ default colors
</PRE>
<H2>SYNOPSIS</H2><PRE>
- <B>#include</B> <B><curses.h></B>
+ <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
- <B>int</B> <B>use_default_colors(void);</B>
- <B>int</B> <B>assume_default_colors(int</B> <B>fg,</B> <B>int</B> <B>bg);</B>
+ <STRONG>int</STRONG> <STRONG>use_default_colors(void);</STRONG>
+ <STRONG>int</STRONG> <STRONG>assume_default_colors(int</STRONG> <STRONG>fg,</STRONG> <STRONG>int</STRONG> <STRONG>bg);</STRONG>
</PRE>
<H2>DESCRIPTION</H2><PRE>
- The <I>use</I><B>_</B><I>default</I><B>_</B><I>colors()</I> and <I>assume</I><B>_</B><I>default</I><B>_</B><I>colors()</I> func-
+ The <EM>use</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors()</EM> and <EM>assume</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors()</EM> func-
tions are extensions to the curses library. They are used
with terminals that support ISO 6429 color, or equivalent.
These terminals allow the application to reset color to an
whole screen do not take advantage of SGR 39 and SGR 49.
Some applications are designed to work with the default
background, using colors only for text. For example,
- there are several implementations of the <B>ls</B> program which
+ there are several implementations of the <STRONG>ls</STRONG> program which
use colors to denote different file types or permissions.
These "color ls" programs do not necessarily modify the
- background color, typically using only the <I>setaf</I> terminfo
+ background color, typically using only the <EM>setaf</EM> terminfo
capability to set the foreground color. Full-screen
applications that use default colors can achieve similar
visual effects.
- The first function, <I>use</I><B>_</B><I>default</I><B>_</B><I>colors()</I> tells the curses
+ The first function, <EM>use</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors()</EM> tells the curses
library to assign terminal default foreground/background
colors to color number -1. So init_pair(x,COLOR_RED,-1)
will initialize pair x as red on default background and
init_pair(x,-1,COLOR_BLUE) will initialize pair x as
default foreground on blue.
- The other, <I>assume</I><B>_</B><I>default</I><B>_</B><I>colors()</I> is a refinement which
+ The other, <EM>assume</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors()</EM> is a refinement which
tells which colors to paint for color pair 0. This func-
tion recognizes a special color number -1, which denotes
the default terminal color.
The following are equivalent:
- <I>use</I><B>_</B><I>default</I><B>_</B><I>colors();</I>
- <I>assume</I><B>_</B><I>default</I><B>_</B><I>colors(-1,-1);</I>
+ <EM>use</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors();</EM>
+ <EM>assume</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors(-1,-1);</EM>
These are ncurses extensions. For other curses implemen-
tations, color number -1 does not mean anything, just as
- for ncurses before a successful call of <I>use</I><B>_</B><I>default</I><B>_</B><I>col-</I>
- <I>ors()</I> or <I>assume</I><B>_</B><I>default</I><B>_</B><I>colors()</I>.
+ for ncurses before a successful call of <EM>use</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>col-</EM>
+ <EM>ors()</EM> or <EM>assume</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors()</EM>.
Other curses implementations do not allow an application
to modify color pair 0. They assume that the background
is COLOR_BLACK, but do not ensure that the color pair 0 is
painted to match the assumption. If your application does
- not use either <I>use</I><B>_</B><I>default</I><B>_</B><I>colors()</I> or <I>assume</I><B>_</B><I>default</I><B>_</B><I>col-</I>
- <I>ors()</I> ncurses will paint a white foreground (text) with
+ not use either <EM>use</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors()</EM> or <EM>assume</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>col-</EM>
+ <EM>ors()</EM> ncurses will paint a white foreground (text) with
black background for color pair 0.
</PRE>
<H2>RETURN VALUE</H2><PRE>
- These functions return the integer <B>ERR</B> upon failure and <B>OK</B>
+ These functions return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG>
on success. They will fail if either the terminal does
- not support the <I>orig</I><B>_</B><I>pair</I> or <I>orig</I><B>_</B><I>colors</I> capability. If
- the <I>initialize</I><B>_</B><I>pair</I> capability is found, this causes an
+ not support the <EM>orig</EM><STRONG>_</STRONG><EM>pair</EM> or <EM>orig</EM><STRONG>_</STRONG><EM>colors</EM> capability. If
+ the <EM>initialize</EM><STRONG>_</STRONG><EM>pair</EM> capability is found, this causes an
error as well.
</PRE>
<H2>NOTES</H2><PRE>
- Associated with this extension, the <B><A HREF="init_pair.3x.html">init_pair(3x)</A></B> function
+ Associated with this extension, the <STRONG><A HREF="init_pair.3x.html">init_pair(3x)</A></STRONG> function
accepts negative arguments to specify default foreground
or background colors.
</PRE>
<H2>SEE ALSO</H2><PRE>
- <B><A HREF="curs_color.3x.html">curs_color(3x)</A></B>, <B><A HREF="ded.1.html">ded(1)</A></B>.
+ <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>, <STRONG><A HREF="ded.1.html">ded(1)</A></STRONG>.
</PRE>