ncurses 4.1
[ncurses.git] / Ada95 / html / curs_deleteln.3x.html
1 <HTML>
2 <BODY BGCOLOR="#99ccbb" TEXT="#000000" LINK="#4060b0" VLINK="#000080" ALINK="#ff4040">
3 <PRE>
4        <STRONG>deleteln</STRONG>,  <STRONG>wdeleteln</STRONG>,  <STRONG>insdelln</STRONG>, <STRONG>winsdelln</STRONG>, <STRONG>insertln</STRONG>, <STRONG>win-</STRONG>
5        <STRONG>sertln</STRONG> - delete and insert lines in a <STRONG>curses</STRONG> window
6
7
8 </PRE>
9 <H2>SYNOPSIS</H2><PRE>
10        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
11
12        <STRONG>int</STRONG> <STRONG>deleteln(void);</STRONG>
13        <STRONG>int</STRONG> <STRONG>wdeleteln(WINDOW</STRONG> <STRONG>*win);</STRONG>
14        <STRONG>int</STRONG> <STRONG>insdelln(int</STRONG> <STRONG>n);</STRONG>
15        <STRONG>int</STRONG> <STRONG>winsdelln(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
16        <STRONG>int</STRONG> <STRONG>insertln(void);</STRONG>
17        <STRONG>int</STRONG> <STRONG>winsertln(WINDOW</STRONG> <STRONG>*win);</STRONG>
18
19
20 </PRE>
21 <H2>DESCRIPTION</H2><PRE>
22        The <STRONG>deleteln</STRONG> and <STRONG>wdeleteln</STRONG> routines delete the line  under
23        the cursor in the window; all lines below the current line
24        are moved up one line.  The bottom line of the  window  is
25        cleared.  The cursor position does not change.
26
27        The  <STRONG>insdelln</STRONG>  and  <STRONG>winsdelln</STRONG>  routines,  for  positive <EM>n</EM>,
28        insert <EM>n</EM> lines into the specified window above the current
29        line.   The  <EM>n</EM>  bottom  lines  are  lost.  For negative <EM>n</EM>,
30        delete <EM>n</EM> lines (starting with the one under  the  cursor),
31        and  move  the remaining lines up.  The bottom <EM>n</EM> lines are
32        cleared.  The current cursor position remains the same.
33
34        The <STRONG>insertln</STRONG> and <STRONG>insertln</STRONG> routines, insert  a  blank  line
35        above the current line and the bottom line is lost.
36
37
38 </PRE>
39 <H2>RETURN VALUE</H2><PRE>
40        All routines return the integer <STRONG>ERR</STRONG> upon failure and an <STRONG>OK</STRONG>
41        (SVr4 specifies only "an integer value  other  than  <STRONG>ERR</STRONG>")
42        upon successful completion.
43
44
45 </PRE>
46 <H2>PORTABILITY</H2><PRE>
47        These  functions are described in the XSI Curses standard,
48        Issue 4.  The standard specifies that they return  <STRONG>ERR</STRONG>  on
49        failure, but specifies no error conditions.
50
51
52 </PRE>
53 <H2>NOTES</H2><PRE>
54        Note that all but <STRONG>winsdelln</STRONG> may be a macros.
55
56        These  routines  do  not require a hardware line delete or
57        insert feature in the terminal.  In fact, they  won't  use
58        hardware  line  delete/insert  unless <STRONG>idlok(...,</STRONG> <STRONG>TRUE)</STRONG> has
59        been set on the current window.
60
61
62 </PRE>
63 <H2>SEE ALSO</H2><PRE>
64        <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>
65
66
67
68 </PRE>
69 </BODY>
70 </HTML>