ncurses 6.1 - patch 20190727
[ncurses.git] / man / curs_deleteln.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2010,2018 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: curs_deleteln.3x,v 1.14 2018/07/28 21:34:06 tom Exp $
30 .TH curs_deleteln 3X ""
31 .SH NAME
32 \fBdeleteln\fR,
33 \fBwdeleteln\fR,
34 \fBinsdelln\fR,
35 \fBwinsdelln\fR,
36 \fBinsertln\fR,
37 \fBwinsertln\fR \- delete and insert lines in a \fBcurses\fR window
38 .SH SYNOPSIS
39 \fB#include <curses.h>\fR
40 .sp
41 \fBint deleteln(void);\fR
42 .br
43 \fBint wdeleteln(WINDOW *win);\fR
44 .br
45 \fBint insdelln(int n);\fR
46 .br
47 \fBint winsdelln(WINDOW *win, int n);\fR
48 .br
49 \fBint insertln(void);\fR
50 .br
51 \fBint winsertln(WINDOW *win);\fR
52 .br
53 .SH DESCRIPTION
54 The \fBdeleteln\fR and \fBwdeleteln\fR routines delete the line under the
55 cursor in the window; all lines below the current line are moved up one line.
56 The bottom line of the window is cleared.
57 The cursor position does not change.
58 .PP
59 The \fBinsdelln\fR and \fBwinsdelln\fR routines, for positive \fIn\fR, insert
60 \fIn\fR lines into the specified window above the current line.
61 The \fIn\fR
62 bottom lines are lost.
63 For negative \fIn\fR, delete \fIn\fR lines (starting
64 with the one under the cursor), and move the remaining lines up.
65 The bottom
66 \fIn\fR lines are cleared.
67 The current cursor position remains the same.
68 .PP
69 The \fBinsertln\fR and \fBwinsertln\fR routines insert a blank line above the
70 current line and the bottom line is lost.
71 .SH RETURN VALUE
72 All routines return the integer \fBERR\fR upon failure and an \fBOK\fR (SVr4
73 specifies only "an integer value other than \fBERR\fR") upon successful
74 completion.
75 .PP
76 X/Open defines no error conditions.
77 In this implementation,
78 if the window parameter is null, an error is returned.
79 .SH PORTABILITY
80 These functions are described in the XSI Curses standard, Issue 4.
81 The
82 standard specifies that they return \fBERR\fR on failure, but specifies no
83 error conditions.
84 .SH NOTES
85 Note that all but \fBwinsdelln\fR may be macros.
86 .PP
87 These routines do not require a hardware line delete or insert feature in the
88 terminal.
89 In fact, they will not use hardware line delete/insert unless
90 \fBidlok(..., TRUE)\fR has been set on the current window.
91 .SH SEE ALSO
92 \fBcurses\fR(3X)