| 1 |
<!-- |
| 2 |
**************************************************************************** |
| 3 |
* Copyright 2018-2024,2025 Thomas E. Dickey * |
| 4 |
* Copyright 1998-2007,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_deleteln.3x,v 1.55 2025/07/05 12:46:36 tom Exp @ |
| 31 |
--> |
| 32 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> |
| 33 |
<HTML> |
| 34 |
<HEAD> |
| 35 |
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> |
| 36 |
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> |
| 37 |
<TITLE>curs_deleteln 3x 2025-07-05 ncurses 6.6 Library calls</TITLE> |
| 38 |
<link rel="author" href="mailto:[email protected]"> |
| 39 |
|
| 40 |
</HEAD> |
| 41 |
<BODY> |
| 42 |
<H1 class="no-header">curs_deleteln 3x 2025-07-05 ncurses 6.6 Library calls</H1> |
| 43 |
<PRE> |
| 44 |
<STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG> |
| 45 |
|
| 46 |
|
| 47 |
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> |
| 48 |
<STRONG>deleteln</STRONG>, <STRONG>wdeleteln</STRONG>, <STRONG>insertln</STRONG>, <STRONG>winsertln</STRONG>, <STRONG>insdelln</STRONG>, <STRONG>winsdelln</STRONG> - delete |
| 49 |
or insert lines in a <EM>curses</EM> window |
| 50 |
|
| 51 |
|
| 52 |
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> |
| 53 |
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG> |
| 54 |
|
| 55 |
<STRONG>int</STRONG> <STRONG>deleteln(void);</STRONG> |
| 56 |
<STRONG>int</STRONG> <STRONG>wdeleteln(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>);</STRONG> |
| 57 |
|
| 58 |
<STRONG>int</STRONG> <STRONG>insertln(void);</STRONG> |
| 59 |
<STRONG>int</STRONG> <STRONG>winsertln(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>);</STRONG> |
| 60 |
|
| 61 |
<STRONG>int</STRONG> <STRONG>insdelln(int</STRONG> <EM>n</EM><STRONG>);</STRONG> |
| 62 |
<STRONG>int</STRONG> <STRONG>winsdelln(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> |
| 63 |
|
| 64 |
|
| 65 |
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> |
| 66 |
<STRONG>wdeleteln</STRONG> deletes the line at the cursor in <EM>win</EM>; all lines below it |
| 67 |
move up one line. <EM>curses</EM> then fills the bottom line of <EM>win</EM> with the |
| 68 |
background character configured by <STRONG><A HREF="curs_bkgd.3x.html">wbkgdset(3x)</A></STRONG> (wide-character API |
| 69 |
users: <STRONG><A HREF="curs_bkgrnd.3x.html">wbkgrndset(3x)</A></STRONG>). The cursor position does not change. |
| 70 |
|
| 71 |
<STRONG>winsertln</STRONG> inserts a new, empty line of characters above the line at the |
| 72 |
cursor in <EM>win</EM>, shifting the existing lines down by one. The content of |
| 73 |
the window's bottom line is lost; <EM>curses</EM> fills the new line with the |
| 74 |
background character. The cursor position does not change. |
| 75 |
|
| 76 |
<STRONG>winsdelln</STRONG> inserts or deletes <EM>n</EM> lines in <EM>win</EM> as <EM>n</EM> is positive or |
| 77 |
negative, respectively, as if by repeatedly calling <STRONG>winsertln</STRONG> or |
| 78 |
<STRONG>wdeleteln</STRONG>. <STRONG>winsdelln(</STRONG>...<STRONG>,</STRONG> <STRONG>0)</STRONG> performs no operation. |
| 79 |
|
| 80 |
|
| 81 |
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> |
| 82 |
These functions return <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> on failure. |
| 83 |
|
| 84 |
In <EM>ncurses</EM>, they fail if <EM>win</EM> is <EM>NULL</EM>. |
| 85 |
|
| 86 |
|
| 87 |
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> |
| 88 |
All of these functions except <STRONG>winsdelln</STRONG> may be implemented as macros. |
| 89 |
|
| 90 |
These functions do not require the terminal to possess hardware line |
| 91 |
deletion or insertion capabilities. Even if available, by default |
| 92 |
<EM>curses</EM> does not use them; see <STRONG><A HREF="idlok.3x.html">idlok(3x)</A></STRONG>. |
| 93 |
|
| 94 |
|
| 95 |
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> |
| 96 |
X/Open Curses Issue 4 describes these functions. It specifies no error |
| 97 |
conditions for them. |
| 98 |
|
| 99 |
SVr4 describes a successful return value only as "an integer value |
| 100 |
other than <EM>ERR</EM>". |
| 101 |
|
| 102 |
|
| 103 |
</PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE> |
| 104 |
4BSD (1980) introduced <EM>deleteln</EM>, <EM>wdeleteln</EM>, <EM>insertln</EM>, and <EM>winsertln</EM>. |
| 105 |
|
| 106 |
SVr3.1 (1987) added <EM>insdelln</EM> and <EM>winsdelln</EM>. |
| 107 |
|
| 108 |
|
| 109 |
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> |
| 110 |
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> |
| 111 |
|
| 112 |
ncurses 6.6 2025-07-05 <STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG> |
| 113 |
</PRE> |
| 114 |
<div class="nav"> |
| 115 |
<ul> |
| 116 |
<li><a href="#h2-NAME">NAME</a></li> |
| 117 |
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> |
| 118 |
<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> |
| 119 |
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> |
| 120 |
<li><a href="#h2-NOTES">NOTES</a></li> |
| 121 |
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> |
| 122 |
<li><a href="#h2-HISTORY">HISTORY</a></li> |
| 123 |
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> |
| 124 |
</ul> |
| 125 |
</div> |
| 126 |
</BODY> |
| 127 |
</HTML> |