ncurses 6.1 - patch 20190518
[ncurses.git] / doc / html / man / curs_refresh.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2016,2018 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: curs_refresh.3x,v 1.19 2018/07/28 22:59:02 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_refresh 3x</TITLE>
37 <link rel="author" href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">curs_refresh 3x</H1>
42 <PRE>
43 <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>                                              <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>
44
45
46
47
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        <STRONG>doupdate</STRONG>, <STRONG>redrawwin</STRONG>, <STRONG>refresh</STRONG>, <STRONG>wnoutrefresh</STRONG>, <STRONG>wredrawln</STRONG>, <STRONG>wrefresh</STRONG> -
50        refresh <STRONG>curses</STRONG> windows and lines
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
55
56        <STRONG>int</STRONG> <STRONG>refresh(void);</STRONG>
57        <STRONG>int</STRONG> <STRONG>wrefresh(WINDOW</STRONG> <STRONG>*win);</STRONG>
58        <STRONG>int</STRONG> <STRONG>wnoutrefresh(WINDOW</STRONG> <STRONG>*win);</STRONG>
59        <STRONG>int</STRONG> <STRONG>doupdate(void);</STRONG>
60        <STRONG>int</STRONG> <STRONG>redrawwin(WINDOW</STRONG> <STRONG>*win);</STRONG>
61        <STRONG>int</STRONG> <STRONG>wredrawln(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>beg_line,</STRONG> <STRONG>int</STRONG> <STRONG>num_lines);</STRONG>
62
63
64 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
65
66 </PRE><H3><a name="h3-refresh_wrefresh">refresh/wrefresh</a></H3><PRE>
67        The <STRONG>refresh</STRONG> and <STRONG>wrefresh</STRONG> routines (or <STRONG>wnoutrefresh</STRONG> and  <STRONG>doupdate</STRONG>)  must
68        be called to get actual output to the terminal, as other routines mere-
69        ly manipulate data structures.  The routine <STRONG>wrefresh</STRONG> copies  the  named
70        window  to  the  <EM>physical</EM>  <EM>screen</EM>,  taking into account what is already
71        there to do optimizations.  The <STRONG>refresh</STRONG> routine is the same, using <STRONG>std-</STRONG>
72        <STRONG>scr</STRONG> as the default window.  Unless <STRONG>leaveok</STRONG> has been enabled, the physi-
73        cal cursor of the terminal is left at the location of  the  cursor  for
74        that window.
75
76
77 </PRE><H3><a name="h3-wnoutrefresh_doupdate">wnoutrefresh/doupdate</a></H3><PRE>
78        The <STRONG>wnoutrefresh</STRONG> and <STRONG>doupdate</STRONG> routines allow multiple updates with more
79        efficiency than <STRONG>wrefresh</STRONG> alone.  In addition to all the  window  struc-
80        tures,  <STRONG>curses</STRONG>  keeps  two  data  structures  representing the terminal
81        screen:
82
83        <STRONG>o</STRONG>   a <EM>physical</EM> <EM>screen</EM>, describing what is actually on the screen, and
84
85        <STRONG>o</STRONG>   a <EM>virtual</EM> <EM>screen</EM>, describing what the programmer wants to  have  on
86            the screen.
87
88        The routine <STRONG>wrefresh</STRONG> works by
89
90        <STRONG>o</STRONG>   first  calling  <STRONG>wnoutrefresh</STRONG>,  which copies the named window to the
91            <EM>virtual</EM> <EM>screen</EM>, and
92
93        <STRONG>o</STRONG>   then calling <STRONG>doupdate</STRONG>, which compares the  <EM>virtual</EM>  <EM>screen</EM>  to  the
94            <EM>physical</EM> <EM>screen</EM> and does the actual update.
95
96        If the programmer wishes to output several windows at once, a series of
97        calls to <STRONG>wrefresh</STRONG> results in  alternating  calls  to  <STRONG>wnoutrefresh</STRONG>  and
98        <STRONG>doupdate</STRONG>,  causing  several  bursts  of output to the screen.  By first
99        calling <STRONG>wnoutrefresh</STRONG> for each window, it is then possible to call <STRONG>doup-</STRONG>
100        <STRONG>date</STRONG>  once,  resulting  in  only  one burst of output, with fewer total
101        characters transmitted and less CPU time used.
102
103        If the <EM>win</EM> argument to <STRONG>wrefresh</STRONG> is the <EM>physical</EM> <EM>screen</EM> (i.e., the glob-
104        al  variable  <STRONG>curscr</STRONG>),  the screen is immediately cleared and repainted
105        from scratch.
106
107        The phrase "copies the named window to the virtual screen" above is am-
108        biguous.   What actually happens is that all <EM>touched</EM> (changed) lines in
109        the window are copied to the virtual  screen.   This  affects  programs
110        that use overlapping windows; it means that if two windows overlap, you
111        can refresh them in either order and the overlap region will  be  modi-
112        fied  only  when  it  is  explicitly  changed.  (But see the section on
113        <STRONG>PORTABILITY</STRONG> below for a warning about exploiting this behavior.)
114
115
116 </PRE><H3><a name="h3-wredrawln_redrawwin">wredrawln/redrawwin</a></H3><PRE>
117        The <STRONG>wredrawln</STRONG> routine indicates to <STRONG>curses</STRONG> that some  screen  lines  are
118        corrupted  and  should  be  thrown away before anything is written over
119        them.  It touches the indicated lines (marking them changed).  The rou-
120        tine <STRONG>redrawwin</STRONG> touches the entire window.
121
122
123 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
124        Routines  that  return an integer return <STRONG>ERR</STRONG> upon failure, and <STRONG>OK</STRONG> (SVr4
125        only specifies "an integer value other than <STRONG>ERR</STRONG>") upon successful  com-
126        pletion.
127
128        X/Open does not define any error conditions.  In this implementation
129
130           <STRONG>wnoutrefresh</STRONG>
131                returns  an error if the window pointer is null, or if the win-
132                dow is really a pad.
133
134           <STRONG>wredrawln</STRONG>
135                returns an error if the associated call to <STRONG>touchln</STRONG>  returns  an
136                error.
137
138
139 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
140        Note that <STRONG>refresh</STRONG> and <STRONG>redrawwin</STRONG> may be macros.
141
142
143 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
144        The XSI Curses standard, Issue 4 describes these functions.
145
146        Whether  <STRONG>wnoutrefresh</STRONG>  copies to the virtual screen the entire contents
147        of a window or just its changed portions has never been well-documented
148        in  historic  curses  versions (including SVr4).  It might be unwise to
149        rely on either behavior in programs that might have to be  linked  with
150        other curses implementations.  Instead, you can do an explicit <STRONG>touchwin</STRONG>
151        before the <STRONG>wnoutrefresh</STRONG> call to guarantee an entire-contents copy  any-
152        where.
153
154
155 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
156        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
157
158
159
160                                                               <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>
161 </PRE>
162 <div class="nav">
163 <ul>
164 <li><a href="#h2-NAME">NAME</a></li>
165 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
166 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
167 <ul>
168 <li><a href="#h3-refresh_wrefresh">refresh/wrefresh</a></li>
169 <li><a href="#h3-wnoutrefresh_doupdate">wnoutrefresh/doupdate</a></li>
170 <li><a href="#h3-wredrawln_redrawwin">wredrawln/redrawwin</a></li>
171 </ul>
172 </li>
173 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
174 <li><a href="#h2-NOTES">NOTES</a></li>
175 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
176 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
177 </ul>
178 </div>
179 </BODY>
180 </HTML>