ncurses 6.2 - patch 20210619
[ncurses.git] / doc / html / man / curs_deleteln.3x.html
1 <!--
2   ****************************************************************************
3   * Copyright 2018,2020 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.17 2020/10/18 00:28:51 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</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">curs_deleteln 3X</H1>
43 <PRE>
44 <B><A HREF="curs_deleteln.3X.html">curs_deleteln(3X)</A></B>                                            <B><A HREF="curs_deleteln.3X.html">curs_deleteln(3X)</A></B>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <B>deleteln</B>,  <B>wdeleteln</B>, <B>insdelln</B>, <B>winsdelln</B>, <B>insertln</B>, <B>winsertln</B> - delete
51        and insert lines in a <B>curses</B> window
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <B>#include</B> <B>&lt;curses.h&gt;</B>
56
57        <B>int</B> <B>deleteln(void);</B>
58        <B>int</B> <B>wdeleteln(WINDOW</B> <B>*</B><I>win</I><B>);</B>
59
60        <B>int</B> <B>insdelln(int</B> <I>n</I><B>);</B>
61        <B>int</B> <B>winsdelln(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
62
63        <B>int</B> <B>insertln(void);</B>
64        <B>int</B> <B>winsertln(WINDOW</B> <B>*</B><I>win</I><B>);</B>
65
66
67 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
68        The <B>deleteln</B> and <B>wdeleteln</B> 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.
72
73        The  <B>insdelln</B>  and  <B>winsdelln</B>  routines, for positive <I>n</I>, insert <I>n</I> lines
74        into the specified window above the current line.  The <I>n</I>  bottom  lines
75        are  lost.  For negative <I>n</I>, delete <I>n</I> lines (starting with the one under
76        the cursor), and move the remaining lines up.  The bottom <I>n</I>  lines  are
77        cleared.  The current cursor position remains the same.
78
79        The  <B>insertln</B>  and  <B>winsertln</B>  routines  insert  a blank line above the
80        current line and the bottom line is lost.
81
82
83 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
84        All routines return the integer  <B>ERR</B>  upon  failure  and  an  <B>OK</B>  (SVr4
85        specifies  only  "an  integer  value  other  than <B>ERR</B>") upon successful
86        completion.
87
88        X/Open defines no error conditions.  In  this  implementation,  if  the
89        window parameter is null, an error is returned.
90
91
92 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
93        These functions are described in the XSI Curses standard, Issue 4.  The
94        standard specifies that they return <B>ERR</B> on failure,  but  specifies  no
95        error conditions.
96
97
98 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
99        Note that all but <B>winsdelln</B> may be macros.
100
101        These  routines do not require a hardware line delete or insert feature
102        in  the  terminal.   In  fact,  they  will  not   use   hardware   line
103        delete/insert  unless  <B>idlok(...,</B>  <B>TRUE)</B>  has  been  set on the current
104        window.
105
106
107 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
108        <B><A HREF="curses.3X.html">curses(3X)</A></B>
109
110
111
112                                                              <B><A HREF="curs_deleteln.3X.html">curs_deleteln(3X)</A></B>
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-PORTABILITY">PORTABILITY</a></li>
121 <li><a href="#h2-NOTES">NOTES</a></li>
122 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
123 </ul>
124 </div>
125 </BODY>
126 </HTML>