ncurses 4.1
[ncurses.git] / Ada95 / html / curs_bkgd.3x.html
1 <HTML>
2 <BODY BGCOLOR="#99ccbb" TEXT="#000000" LINK="#4060b0" VLINK="#000080" ALINK="#ff4040">
3 <PRE>
4        <STRONG>bkgdset</STRONG>,  <STRONG>wbkgdset</STRONG>, <STRONG>bkgd</STRONG>, <STRONG>wbkgd</STRONG> - <STRONG>curses</STRONG> window background
5        manipulation routines
6
7
8 </PRE>
9 <H2>SYNOPSIS</H2><PRE>
10        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
11
12        <STRONG>void</STRONG> <STRONG>bkgdset(const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
13        <STRONG>void</STRONG> <STRONG>wbkgdset(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
14        <STRONG>int</STRONG> <STRONG>bkgd(const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
15        <STRONG>int</STRONG> <STRONG>wbkgd(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
16        <STRONG>chtype</STRONG> <STRONG>getbkgd(WINDOW</STRONG> <STRONG>*win);</STRONG>
17
18
19 </PRE>
20 <H2>DESCRIPTION</H2><PRE>
21        The <STRONG>bkgdset</STRONG> and <STRONG>wbkgdset</STRONG>  routines  manipulate  the  back-
22        ground  of  the  named window.  The window background is a
23        <STRONG>chtype</STRONG> consisting of any combination of attributes  (i.e.,
24        rendition)  and  a  character.   The attribute part of the
25        background is combined (OR'ed) with all non-blank  charac-
26        ters  that  are written into the window with <STRONG>waddch</STRONG>.  Both
27        the character and attribute parts of  the  background  are
28        combined   with  the  blank  characters.   The  background
29        becomes a property of the character  and  moves  with  the
30        character   through   any   scrolling   and  insert/delete
31        line/character operations.
32
33        To the extent  possible  on  a  particular  terminal,  the
34        attribute  part  of  the  background  is  displayed as the
35        graphic rendition of the character put on the screen.
36
37        The <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> functions set the  background  property
38        of  the  current  or  specified window and then apply this
39        setting to every character position in that window:
40
41               The rendition of every character on the  screen  is
42               changed to the new background rendition.
43
44               Wherever  the  former background character appears,
45               it is changed to the new background character.
46
47        The <STRONG>getbkgd</STRONG> function returns the  given  window's  current
48        background character/attribute pair.
49
50
51 </PRE>
52 <H2>RETURN VALUE</H2><PRE>
53        The  routines  <STRONG>bkgd</STRONG>  and <STRONG>wbkgd</STRONG> return the integer <STRONG>OK</STRONG>.  The
54        SVr4.0 manual says "or a non-negative integer  if  <STRONG>immedok</STRONG>
55        is set", but this appears to be an error.
56
57
58 </PRE>
59 <H2>NOTES</H2><PRE>
60        Note that <STRONG>bkgdset</STRONG> and <STRONG>bkgd</STRONG> may be macros.
61
62
63 </PRE>
64 <H2>PORTABILITY</H2><PRE>
65        These  functions are described in the XSI Curses standard,
66        return <STRONG>ERR</STRONG>, on failure. but gives no failure conditions.
67
68
69 </PRE>
70 <H2>SEE ALSO</H2><PRE>
71        <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_outopts.3x.html">curs_outopts(3X)</A></STRONG>
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 </PRE>
121 </BODY>
122 </HTML>