1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
<HTML>
<BODY>
<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
</PRE>
<H2>SYNOPSIS</H2><PRE>
<B>#include</B> <B><curses.h></B>
<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>
</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-
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
unspecified default value (e.g., with SGR 39 or SGR 49).
Applications that paint a colored background over the
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
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
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
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
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>
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>.
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
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>
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
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
accepts negative arguments to specify default foreground
or background colors.
</PRE>
<H2>PORTABILITY</H2><PRE>
These routines are specific to ncurses. They were not
supported on Version 7, BSD or System V implementations.
It is recommended that any code depending on them be con-
ditioned using NCURSES_VERSION.
</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>.
</PRE>
<H2>AUTHOR</H2><PRE>
Thomas Dickey (from an analysis of the requirements for
color xterm for XFree86 3.1.2C, February 1996).
</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
</BODY>
</HTML>
|
