| 1 | .\"***************************************************************************
|
|---|
| 2 | .\" Copyright (c) 1998-2007,2010 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.13 2010/12/04 18:36:44 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. The cursor position does not change.
|
|---|
| 57 | .PP
|
|---|
| 58 | The \fBinsdelln\fR and \fBwinsdelln\fR routines, for positive \fIn\fR, insert
|
|---|
| 59 | \fIn\fR lines into the specified window above the current line. The \fIn\fR
|
|---|
| 60 | bottom lines are lost. For negative \fIn\fR, delete \fIn\fR lines (starting
|
|---|
| 61 | with the one under the cursor), and move the remaining lines up. The bottom
|
|---|
| 62 | \fIn\fR lines are cleared. The current cursor position remains the same.
|
|---|
| 63 | .PP
|
|---|
| 64 | The \fBinsertln\fR and \fBwinsertln\fR routines insert a blank line above the
|
|---|
| 65 | current line and the bottom line is lost.
|
|---|
| 66 | .SH RETURN VALUE
|
|---|
| 67 | All routines return the integer \fBERR\fR upon failure and an \fBOK\fR (SVr4
|
|---|
| 68 | specifies only "an integer value other than \fBERR\fR") upon successful
|
|---|
| 69 | completion.
|
|---|
| 70 | .PP
|
|---|
| 71 | X/Open defines no error conditions.
|
|---|
| 72 | In this implementation,
|
|---|
| 73 | if the window parameter is null, an error is returned.
|
|---|
| 74 | .SH PORTABILITY
|
|---|
| 75 | These functions are described in the XSI Curses standard, Issue 4. The
|
|---|
| 76 | standard specifies that they return \fBERR\fR on failure, but specifies no
|
|---|
| 77 | error conditions.
|
|---|
| 78 | .SH NOTES
|
|---|
| 79 | Note that all but \fBwinsdelln\fR may be macros.
|
|---|
| 80 | .PP
|
|---|
| 81 | These routines do not require a hardware line delete or insert feature in the
|
|---|
| 82 | terminal. In fact, they will not use hardware line delete/insert unless
|
|---|
| 83 | \fBidlok(..., TRUE)\fR has been set on the current window.
|
|---|
| 84 | .SH SEE ALSO
|
|---|
| 85 | \fBcurses\fR(3X)
|
|---|
