***************************************************************************
Copyright 2018-2024,2025 Thomas E. Dickey *
Copyright 1998-2007,2010 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_deleteln.3x,v 1.55 2025/07/05 12:46:36 tom Exp $
.\} .\} . \%deleteln, \%wdeleteln, \%insertln, \%winsertln, \%insdelln, \%winsdelln - delete or insert lines in a curses window

#include <curses.h>

int deleteln(void);
int wdeleteln(WINDOW * win);

int insertln(void);
int winsertln(WINDOW * win);

int insdelln(int n);
int winsdelln(WINDOW * win, int n);

\%wdeleteln deletes the line at the cursor in win ; all lines below it move up one line. curses then fills the bottom line of win with the background character configured by \%wbkgdset(3X) (wide-character API users: \%wbkgrndset(3X)). The cursor position does not change.

\%winsertln inserts a new, empty line of characters above the line at the cursor in win , shifting the existing lines down by one. The content of the window's bottom line is lost; curses fills the new line with the background character. The cursor position does not change.

\%winsdelln inserts or deletes n lines in win as n is positive or negative, respectively, as if by repeatedly calling \%winsertln or \%wdeleteln "." \%winsdelln( ".\|.\|." ", 0)" performs no operation.

These functions return OK on success and ERR on failure.

In \%ncurses "," they fail if win is NULL "."

All of these functions except \%winsdelln may be implemented as macros.

These functions do not require the terminal to possess hardware line deletion or insertion capabilities. Even if available, by default curses does not use them; see \%idlok(3X).

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 ERR \*(''. \" Courier roman in source; SVID 4, vol. 3, p. 490

4BSD (1980) introduced \%deleteln "," \%wdeleteln "," \%insertln "," and \%winsertln "."

SVr3.1 (1987) added \%insdelln and \%winsdelln "."

\%curses(3X)