+<!--
+ ****************************************************************************
+ * Copyright 2018-2019,2020 Thomas E. Dickey *
+ * Copyright 1998-2010,2016 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. *
+ ****************************************************************************
+ * @Id: curs_refresh.3x,v 1.22 2020/10/24 09:43:49 tom Exp @
+-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
+<HEAD>
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
+<TITLE>curs_refresh 3X</TITLE>
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
<BODY>
+<H1 class="no-header">curs_refresh 3X</H1>
<PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
+<B><A HREF="curs_refresh.3X.html">curs_refresh(3X)</A></B> <B><A HREF="curs_refresh.3X.html">curs_refresh(3X)</A></B>
-</PRE>
-<H2>NAME</H2><PRE>
- <B>refresh</B>, <B>wrefresh</B>, <B>wnoutrefresh</B>, <B>doupdate</B>, <B>redrawwin</B>, <B>wre-</B>
- <B>drawln</B> - refresh <B>curses</B> windows and lines
-</PRE>
-<H2>SYNOPSIS</H2><PRE>
+
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
+ <B>doupdate</B>, <B>redrawwin</B>, <B>refresh</B>, <B>wnoutrefresh</B>, <B>wredrawln</B>, <B>wrefresh</B> -
+ refresh <B>curses</B> windows and lines
+
+
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
<B>#include</B> <B><curses.h></B>
<B>int</B> <B>refresh(void);</B>
- <B>int</B> <B>wrefresh(WINDOW</B> <B>*win);</B>
- <B>int</B> <B>wnoutrefresh(WINDOW</B> <B>*win);</B>
+ <B>int</B> <B>wrefresh(WINDOW</B> <B>*</B><I>win</I><B>);</B>
+ <B>int</B> <B>wnoutrefresh(WINDOW</B> <B>*</B><I>win</I><B>);</B>
<B>int</B> <B>doupdate(void);</B>
- <B>int</B> <B>redrawwin(WINDOW</B> <B>*win);</B>
- <B>int</B> <B>wredrawln(WINDOW</B> <B>*win,</B> <B>int</B> <B>beg_line,</B> <B>int</B> <B>num_lines);</B>
-
-
-</PRE>
-<H2>DESCRIPTION</H2><PRE>
- The <B>refresh</B> and <B>wrefresh</B> routines (or <B>wnoutrefresh</B> and
- <B>doupdate</B>) must be called to get actual output to the ter-
- minal, as other routines merely manipulate data struc-
- tures. The routine <B>wrefresh</B> copies the named window to
- the physical terminal screen, taking into account what is
- already there in order to do optimizations. The <B>refresh</B>
- routine is the same, using <B>stdscr</B> as the default window.
- Unless <B>leaveok</B> has been enabled, the physical cursor of
- the terminal is left at the location of the cursor for
- that window.
- The <B>wnoutrefresh</B> and <B>doupdate</B> routines allow multiple
- updates with more efficiency than <B>wrefresh</B> alone. In
- addition to all the window structures, <B>curses</B> keeps two
- data structures representing the terminal screen: a physi-
- cal screen, describing what is actually on the screen, and
- a virtual screen, describing what the programmer wants to
- have on the screen.
-
- The routine <B>wrefresh</B> works by first calling <B>wnoutrefresh</B>,
- which copies the named window to the virtual screen, and
- then calling <B>doupdate</B>, which compares the virtual screen
- to the physical screen and does the actual update. If the
- programmer wishes to output several windows at once, a
- series of calls to <B>wrefresh</B> results in alternating calls
- to <B>wnoutrefresh</B> and <B>doupdate</B>, causing several bursts of
- output to the screen. By first calling <B>wnoutrefresh</B> for
- each window, it is then possible to call <B>doupdate</B> once,
- resulting in only one burst of output, with fewer total
- characters transmitted and less CPU time used. If the <I>win</I>
- argument to <B>wrefresh</B> is the global variable <B>curscr</B>, the
- screen is immediately cleared and repainted from scratch.
-
- The phrase "copies the named window to the virtual screen"
- above is ambiguous. What actually happens is that all
- <I>touched</I> (changed) lines in the window are copied to the
- virtual screen. This affects programs that use overlap-
- ping windows; it means that if two windows overlap, you
- can refresh them in either order and the overlap region
- will be modified only when it is explicitly changed. (But
- see the section on <B>PORTABILITY</B> below for a warning about
- exploiting this behavior.)
-
- The <B>wredrawln</B> routine indicates to <B>curses</B> that some screen
- lines are corrupted and should be thrown away before any-
- thing is written over them. It touches the indicated
- lines (marking them changed). The routine <B>redrawwin</B>()
- touches the entire window.
+ <B>int</B> <B>redrawwin(WINDOW</B> <B>*</B><I>win</I><B>);</B>
+ <B>int</B> <B>wredrawln(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>beg</I><B>_</B><I>line</I><B>,</B> <B>int</B> <I>num</I><B>_</B><I>lines</I><B>);</B>
-</PRE>
-<H2>RETURN VALUE</H2><PRE>
- Routines that return an integer return <B>ERR</B> upon failure,
- and <B>OK</B> (SVr4 only specifies "an integer value other than
- <B>ERR</B>") upon successful completion.
+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
+</PRE><H3><a name="h3-refresh_wrefresh">refresh/wrefresh</a></H3><PRE>
+ The <B>refresh</B> and <B>wrefresh</B> routines (or <B>wnoutrefresh</B> and <B>doupdate</B>) must
+ be called to get actual output to the terminal, as other routines mere-
+ ly manipulate data structures. The routine <B>wrefresh</B> copies the named
+ window to the <I>physical</I> <I>screen</I>, taking into account what is already
+ there to do optimizations. The <B>refresh</B> routine is the same, using <B>std-</B>
+ <B>scr</B> as the default window. Unless <B>leaveok</B> has been enabled, the physi-
+ cal cursor of the terminal is left at the location of the cursor for
+ that window.
-</PRE>
-<H2>NOTES</H2><PRE>
- Note that <B>refresh</B> and <B>redrawwin</B> may be macros.
+</PRE><H3><a name="h3-wnoutrefresh_doupdate">wnoutrefresh/doupdate</a></H3><PRE>
+ The <B>wnoutrefresh</B> and <B>doupdate</B> routines allow multiple updates with more
+ efficiency than <B>wrefresh</B> alone. In addition to all the window struc-
+ tures, <B>curses</B> keeps two data structures representing the terminal
+ screen:
-</PRE>
-<H2>PORTABILITY</H2><PRE>
- The XSI Curses standard, Issue 4 describes these func-
- tions.
+ <B>o</B> a <I>physical</I> <I>screen</I>, describing what is actually on the screen, and
- Whether <B>wnoutrefresh()</B> copies to the virtual screen the
- entire contents of a window or just its changed portions
- has never been well-documented in historic curses versions
- (including SVr4). It might be unwise to rely on either
- behavior in programs that might have to be linked with
- other curses implementations. Instead, you can do an
- explicit <B>touchwin()</B> before the <B>wnoutrefresh()</B> call to
- guarantee an entire-contents copy anywhere.
+ <B>o</B> a <I>virtual</I> <I>screen</I>, describing what the programmer wants to have on
+ the screen.
+ The routine <B>wrefresh</B> works by
-</PRE>
-<H2>SEE ALSO</H2><PRE>
- <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B>
+ <B>o</B> first calling <B>wnoutrefresh</B>, which copies the named window to the
+ <I>virtual</I> <I>screen</I>, and
+ <B>o</B> then calling <B>doupdate</B>, which compares the <I>virtual</I> <I>screen</I> to the
+ <I>physical</I> <I>screen</I> and does the actual update.
+ If the programmer wishes to output several windows at once, a series of
+ calls to <B>wrefresh</B> results in alternating calls to <B>wnoutrefresh</B> and
+ <B>doupdate</B>, causing several bursts of output to the screen. By first
+ calling <B>wnoutrefresh</B> for each window, it is then possible to call <B>doup-</B>
+ <B>date</B> once, resulting in only one burst of output, with fewer total
+ characters transmitted and less CPU time used.
+ If the <I>win</I> argument to <B>wrefresh</B> is the <I>physical</I> <I>screen</I> (i.e., the glob-
+ al variable <B>curscr</B>), the screen is immediately cleared and repainted
+ from scratch.
+ The phrase "copies the named window to the virtual screen" above is am-
+ biguous. What actually happens is that all <I>touched</I> (changed) lines in
+ the window are copied to the virtual screen. This affects programs
+ that use overlapping windows; it means that if two windows overlap, you
+ can refresh them in either order and the overlap region will be modi-
+ fied only when it is explicitly changed. (But see the section on
+ <B>PORTABILITY</B> below for a warning about exploiting this behavior.)
+</PRE><H3><a name="h3-wredrawln_redrawwin">wredrawln/redrawwin</a></H3><PRE>
+ The <B>wredrawln</B> routine indicates to <B>curses</B> that some screen lines are
+ corrupted and should be thrown away before anything is written over
+ them. It touches the indicated lines (marking them changed). The rou-
+ tine <B>redrawwin</B> touches the entire window.
+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+ Routines that return an integer return <B>ERR</B> upon failure, and <B>OK</B> (SVr4
+ only specifies "an integer value other than <B>ERR</B>") upon successful com-
+ pletion.
+ X/Open does not define any error conditions. In this implementation
+ <B>wnoutrefresh</B>
+ returns an error if the window pointer is null, or if the win-
+ dow is really a pad.
+ <B>wredrawln</B>
+ returns an error if the associated call to <B>touchln</B> returns an
+ error.
+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
+ Note that <B>refresh</B> and <B>redrawwin</B> may be macros.
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+ The XSI Curses standard, Issue 4 describes these functions.
+ Whether <B>wnoutrefresh</B> copies to the virtual screen the entire contents
+ of a window or just its changed portions has never been well-documented
+ in historic curses versions (including SVr4). It might be unwise to
+ rely on either behavior in programs that might have to be linked with
+ other curses implementations. Instead, you can do an explicit <B>touchwin</B>
+ before the <B>wnoutrefresh</B> call to guarantee an entire-contents copy any-
+ where.
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+ <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_outopts.3X.html">curs_outopts(3X)</A></B> <B><A HREF="curs_variables.3X.html">curs_variables(3X)</A></B>.
+ <B><A HREF="curs_refresh.3X.html">curs_refresh(3X)</A></B>
</PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
+<ul>
+<li><a href="#h3-refresh_wrefresh">refresh/wrefresh</a></li>
+<li><a href="#h3-wnoutrefresh_doupdate">wnoutrefresh/doupdate</a></li>
+<li><a href="#h3-wredrawln_redrawwin">wredrawln/redrawwin</a></li>
+</ul>
+</li>
+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
+<li><a href="#h2-NOTES">NOTES</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+</ul>
+</div>
</BODY>
</HTML>
projects / ncurses.git / blobdiff