Changeset 1910 for ncurses/vendor/current/doc/html/man/curs_clear.3x.html
- Timestamp:
- Jan 13, 2017, 3:21:12 PM (8 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
TabularUnified ncurses/vendor/current/doc/html/man/curs_clear.3x.html ¶
r85 r1910 2 2 <!-- 3 3 **************************************************************************** 4 * Copyright (c) 1998-200 5,2007Free Software Foundation, Inc. *4 * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * 5 5 * * 6 6 * Permission is hereby granted, free of charge, to any person obtaining a * … … 28 28 * authorization. * 29 29 **************************************************************************** 30 * @Id: curs_clear.3x,v 1.1 1 2007/12/29 15:58:38tom Exp @30 * @Id: curs_clear.3x,v 1.14 2010/12/04 18:36:44 tom Exp @ 31 31 --> 32 32 <HTML> … … 68 68 </PRE> 69 69 <H2>DESCRIPTION</H2><PRE> 70 The <STRONG>erase</STRONG> and <STRONG>werase</STRONG> routines copy blanks to everyposi-70 The <STRONG>erase</STRONG> and <STRONG>werase</STRONG> routines copy blanks to every posi- 71 71 tion in the window, clearing the screen. 72 72 73 The <STRONG>clear</STRONG> and <STRONG>wclear</STRONG> routines are like <STRONG>erase</STRONG> and<STRONG>werase</STRONG>,74 but they also call <STRONG>clearok</STRONG>, so that the screen iscleared75 completely on the next call to <STRONG>wrefresh</STRONG> for thatwindow73 The <STRONG>clear</STRONG> and <STRONG>wclear</STRONG> routines are like <STRONG>erase</STRONG> and <STRONG>werase</STRONG>, 74 but they also call <STRONG>clearok</STRONG>, so that the screen is cleared 75 completely on the next call to <STRONG>wrefresh</STRONG> for that window 76 76 and repainted from scratch. 77 77 78 The <STRONG>clrtobot</STRONG> and <STRONG>wclrtobot</STRONG> routines erase from thecursor78 The <STRONG>clrtobot</STRONG> and <STRONG>wclrtobot</STRONG> routines erase from the cursor 79 79 to the end of screen. That is, they erase all lines below 80 the cursor in the window. Also, the current line tothe80 the cursor in the window. Also, the current line to the 81 81 right of the cursor, inclusive, is erased. 82 82 83 83 The <STRONG>clrtoeol</STRONG> and <STRONG>wclrtoeol</STRONG> routines erase the current line 84 to the right of the cursor, inclusive, to the end ofthe84 to the right of the cursor, inclusive, to the end of the 85 85 current line. 86 86 … … 91 91 </PRE> 92 92 <H2>RETURN VALUE</H2><PRE> 93 All routines return the integer <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG>on94 failure. The SVr4.0 manual says "or a non-negativeinte-93 All routines return the integer <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> on 94 failure. The SVr4.0 manual says "or a non-negative inte- 95 95 ger if <STRONG>immedok</STRONG> is set", but this appears to be an error. 96 96 97 X/Open defines no error conditions. In thisimplementa-97 X/Open defines no error conditions. In this implementa- 98 98 tion, functions using a window pointer parameter return an 99 99 error if it is null. … … 108 108 </PRE> 109 109 <H2>PORTABILITY</H2><PRE> 110 These functions are described in the XSI Cursesstandard,111 Issue 4. The standard specifies that they return <STRONG>ERR</STRONG>on110 These functions are described in the XSI Curses standard, 111 Issue 4. The standard specifies that they return <STRONG>ERR</STRONG> on 112 112 failure, but specifies no error conditions. 113 113 114 Some historic curses implementations had, as anundocu-115 mented feature, the ability to do the equivalentof116 <STRONG>clearok(...,</STRONG> <STRONG>1)</STRONG> by saying <STRONG>touchwin(stdscr)</STRONG> or<STRONG>clear(std-</STRONG>114 Some historic curses implementations had, as an undocu- 115 mented feature, the ability to do the equivalent of 116 <STRONG>clearok(...,</STRONG> <STRONG>1)</STRONG> by saying <STRONG>touchwin(stdscr)</STRONG> or <STRONG>clear(std-</STRONG> 117 117 <STRONG>scr)</STRONG>. This will not work under ncurses. 118 118 119 This implementation, and others such as Solaris, setsthe120 current position to 0,0 after erasing via <STRONG>werase()</STRONG>and121 <STRONG>wclear()</STRONG>. That fact is not documented in otherimplemen-119 This implementation, and others such as Solaris, sets the 120 current position to 0,0 after erasing via <STRONG>werase()</STRONG> and 121 <STRONG>wclear()</STRONG>. That fact is not documented in other implemen- 122 122 tations, and may not be true of implementations which were 123 123 not derived from SVr4 source. 124 124 125 Not obvious from the description, mostimplementations126 clear the screen after <STRONG>wclear</STRONG> even for a subwindow orde-125 Not obvious from the description, most implementations 126 clear the screen after <STRONG>wclear</STRONG> even for a subwindow or de- 127 127 rived window. If you do not want to clear the screen dur- 128 128 ing the next <STRONG>wrefresh</STRONG>, use <STRONG>werase</STRONG> instead. … … 131 131 </PRE> 132 132 <H2>SEE ALSO</H2><PRE> 133 <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_refresh.3x.html">curs_refresh(3x)</A></STRONG> 133 <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_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG>curs_vari-</STRONG> 134 <STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG> 134 135 135 136
Note:
See TracChangeset
for help on using the changeset viewer.
