Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / 9b9f5e71c18a5d2317f7871a472b47d3d7efc0c4 / . / doc / html / man / curs_deleteln.3x.html
blob: c9c5001461821a4bf5bdec52146bd1aa61c63a00 [file] [log] [blame]
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]1<!--
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]2 ****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]3 * Copyright 2018-2023,2024 Thomas E. Dickey *
4 * Copyright 1998-2007,2010 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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 ****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]30 * @Id: curs_deleteln.3x,v 1.38 2024/04/20 21:20:07 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]31-->
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]32<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]33<HTML>
34<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]35<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]36<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37<TITLE>curs_deleteln 3x 2024-04-20 ncurses 6.5 Library calls</TITLE>
38<link rel="author" href="mailto:bug-ncurses@gnu.org">
39
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]40</HEAD>
41<BODY>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]42<H1 class="no-header">curs_deleteln 3x 2024-04-20 ncurses 6.5 Library calls</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43<PRE>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]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>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]45
46
47
48
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]49</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>deleteln</STRONG>, <STRONG>wdeleteln</STRONG>, <STRONG>insdelln</STRONG>, <STRONG>winsdelln</STRONG>, <STRONG>insertln</STRONG>, <STRONG>winsertln</STRONG> - delete
51 or insert lines in a <EM>curses</EM> window
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]52
53
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]54</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]55 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
56
57 <STRONG>int</STRONG> <STRONG>deleteln(void);</STRONG>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]58 <STRONG>int</STRONG> <STRONG>wdeleteln(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
59
60 <STRONG>int</STRONG> <STRONG>insdelln(int</STRONG> <EM>n</EM><STRONG>);</STRONG>
61 <STRONG>int</STRONG> <STRONG>winsdelln(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
62
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]63 <STRONG>int</STRONG> <STRONG>insertln(void);</STRONG>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]64 <STRONG>int</STRONG> <STRONG>winsertln(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]65
66
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]67</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
68 The <STRONG>deleteln</STRONG> and <STRONG>wdeleteln</STRONG> routines delete the line under the cursor in
69 the window; all lines below the current line are moved up one line.
70 The bottom line of the window is cleared. The cursor position does not
71 change.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]72
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]73 The <STRONG>insdelln</STRONG> and <STRONG>winsdelln</STRONG> routines, for positive <EM>n</EM>, insert <EM>n</EM> lines
74 into the specified window above the current line. The <EM>n</EM> bottom lines
75 are lost. For negative <EM>n</EM>, delete <EM>n</EM> lines (starting with the one under
76 the cursor), and move the remaining lines up. The bottom <EM>n</EM> lines are
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]77 cleared. The current cursor position remains the same.
78
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]79 The <STRONG>insertln</STRONG> and <STRONG>winsertln</STRONG> routines insert a blank line above the
80 current line and the bottom line is lost.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]81
82
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]83</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
84 These routines return the integer <STRONG>ERR</STRONG> upon failure and an <STRONG>OK</STRONG> (SVr4
85 specifies only "an integer value other than <STRONG>ERR</STRONG>") upon successful
86 completion.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]87
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]88 X/Open defines no error conditions. In this implementation, if the
89 window parameter is null, an error is returned.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]90
91
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]92</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]93 Note that all but <STRONG>winsdelln</STRONG> may be macros.
94
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]95 These routines do not require a hardware line delete or insert feature
96 in the terminal. In fact, they will not use hardware line
97 delete/insert unless <STRONG>idlok(...,</STRONG> <STRONG>TRUE)</STRONG> has been set on the current
98 window.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]99
100
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]101</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
102 These functions are described in X/Open Curses, Issue 4. The standard
103 specifies that they return <STRONG>ERR</STRONG> on failure, but specifies no error
104 conditions.
105
106
107</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]108 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
109
110
111
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]112ncurses 6.5 2024-04-20 <STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]113</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]120<li><a href="#h2-NOTES">NOTES</a></li>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]121<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]122<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
123</ul>
124</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]125</BODY>
126</HTML>