diff options
Diffstat (limited to 'doc/html/man/curs_refresh.3x.html')
| -rw-r--r-- | doc/html/man/curs_refresh.3x.html | 60 |
1 files changed, 28 insertions, 32 deletions
diff --git a/doc/html/man/curs_refresh.3x.html b/doc/html/man/curs_refresh.3x.html index 4beec325ad44..87d3ab311dbc 100644 --- a/doc/html/man/curs_refresh.3x.html +++ b/doc/html/man/curs_refresh.3x.html @@ -1,6 +1,6 @@ <!-- **************************************************************************** - * Copyright 2018-2023,2024 Thomas E. Dickey * + * Copyright 2018-2024,2025 Thomas E. Dickey * * Copyright 1998-2010,2016 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,25 +27,23 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_refresh.3x,v 1.46 2024/04/20 21:20:07 tom Exp @ + * @Id: curs_refresh.3x,v 1.58 2025/01/19 00:51:10 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 2024-04-20 ncurses 6.5 Library calls</TITLE> +<TITLE>curs_refresh 3x 2025-01-18 ncurses 6.6 Library calls</TITLE> <link rel="author" href="mailto:bug-ncurses@gnu.org"> </HEAD> <BODY> -<H1 class="no-header">curs_refresh 3x 2024-04-20 ncurses 6.5 Library calls</H1> +<H1 class="no-header">curs_refresh 3x 2025-01-18 ncurses 6.6 Library calls</H1> <PRE> <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG> - - </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> <STRONG>doupdate</STRONG>, <STRONG>redrawwin</STRONG>, <STRONG>refresh</STRONG>, <STRONG>wnoutrefresh</STRONG>, <STRONG>wredrawln</STRONG>, <STRONG>wrefresh</STRONG> - refresh <EM>curses</EM> windows or lines thereupon @@ -96,19 +94,19 @@ <EM>physical</EM> <EM>screen</EM> and does the actual update. If the programmer wishes to output several windows at once, a series of - calls to <STRONG>wrefresh</STRONG> results in alternating calls to <STRONG>wnoutrefresh</STRONG> and - <STRONG>doupdate</STRONG>, causing several bursts of output to the screen. By first - calling <STRONG>wnoutrefresh</STRONG> for each window, it is then possible to call - <STRONG>doupdate</STRONG> once, resulting in only one burst of output, with fewer total + calls to <STRONG>wrefresh</STRONG> results in alternating calls to <STRONG>wnoutrefresh</STRONG> and + <STRONG>doupdate</STRONG>, causing several bursts of output to the screen. By first + calling <STRONG>wnoutrefresh</STRONG> for each window, it is then possible to call + <STRONG>doupdate</STRONG> once, resulting in only one burst of output, with fewer total characters transmitted and less CPU time used. - If the <EM>win</EM> argument to <STRONG>wrefresh</STRONG> is the <EM>physical</EM> <EM>screen</EM> (i.e., the - global variable <STRONG>curscr</STRONG>), the screen is immediately cleared and + If the <EM>win</EM> argument to <STRONG>wrefresh</STRONG> is the <EM>physical</EM> <EM>screen</EM> (i.e., the + global variable <STRONG>curscr</STRONG>), 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 <EM>touched</EM> (changed) lines - in the window are copied to the virtual screen. This affects programs + The phrase "copies the named window to the virtual screen" above is + ambiguous. What actually happens is that all <EM>touched</EM> (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 modified only when it is explicitly changed. (But see the section on @@ -123,44 +121,42 @@ </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> - These routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 - specifies only "an integer value other than <STRONG>ERR</STRONG>") upon successful - completion. + These routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> - X/Open Curses does not specify any error conditions. In this - implementation + In this implementation <STRONG>wnoutrefresh</STRONG> - returns an error if the window pointer is null, or if the - window is really a pad. + returns <STRONG>ERR</STRONG> if the window pointer is null, or if the window is + really a pad. <STRONG>wredrawln</STRONG> - returns an error if the associated call to <STRONG>touchln</STRONG> returns an - error. + return <STRONG>ERR</STRONG> if the associated call to <STRONG>touchln</STRONG> returns <STRONG>ERR</STRONG>. </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> - Note that <STRONG>refresh</STRONG> and <STRONG>redrawwin</STRONG> may be macros. + <STRONG>refresh</STRONG> and <STRONG>redrawwin</STRONG> may be implemented as macros. </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> - X/Open Curses, Issue 4 describes these functions. + X/Open Curses Issue 4 describes these functions. It specifies no error + conditions for them. + + SVr4 describes a successful return value only as "an integer value + other than <EM>ERR</EM>". - Whether <STRONG>wnoutrefresh</STRONG> copies to the virtual screen the entire contents + Whether <STRONG>wnoutrefresh</STRONG> 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 <STRONG>touchwin</STRONG> - before the <STRONG>wnoutrefresh</STRONG> call to guarantee an entire-contents copy + before the <STRONG>wnoutrefresh</STRONG> call to guarantee an entire-contents copy anywhere. </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> - <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> - - + <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> -ncurses 6.5 2024-04-20 <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG> +ncurses 6.6 2025-01-18 <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG> </PRE> <div class="nav"> <ul> |