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