man/curs_deleteln.3x

   1 .TH curs_deleteln 3X ""
   2 .SH NAME
   3 \fBdeleteln\fR, \fBwdeleteln\fR, \fBinsdelln\fR,
   4 \fBwinsdelln\fR, \fBinsertln\fR, \fBwinsertln\fR - delete and insert
   5 lines in a \fBcurses\fR window
   6 .SH SYNOPSIS
   7 \fB#include <curses.h>\fR
   8
   9 \fBint deleteln(void);\fR
  10 .br
  11 \fBint wdeleteln(WINDOW *win);\fR
  12 .br
  13 \fBint insdelln(int n);\fR
  14 .br
  15 \fBint winsdelln(WINDOW *win, int n);\fR
  16 .br
  17 \fBint insertln(void);\fR
  18 .br
  19 \fBint winsertln(WINDOW *win);\fR
  20 .br
  21 .SH DESCRIPTION
  22 The \fBdeleteln\fR and \fBwdeleteln\fR routines delete the line under the
  23 cursor in the window; all lines below the current line are moved up one line.
  24 The bottom line of the window is cleared.  The cursor position does not change.
  25
  26 The \fBinsdelln\fR and \fBwinsdelln\fR routines, for positive \fIn\fR, insert
  27 \fIn\fR lines into the specified window above the current line.  The \fIn\fR
  28 bottom lines are lost.  For negative \fIn\fR, delete \fIn\fR lines (starting
  29 with the one under the cursor), and move the remaining lines up.  The bottom
  30 \fIn\fR lines are cleared.  The current cursor position remains the same.
  31
  32 The \fBinsertln\fR and \fBinsertln\fR routines, insert a blank line above the
  33 current line and the bottom line is lost.
  34 .SH RETURN VALUE
  35 All routines return the integer \fBERR\fR upon failure and an \fBOK\fR (SVr4
  36 specifies only "an integer value other than \fBERR\fR") upon successful
  37 completion.
  38 .SH PORTABILITY
  39 These functions are described in the XSI Curses standard, Issue 4.  The
  40 standard specifies that they return \fBERR\fR on failure, but specifies no
  41 error conditions.
  42 .SH NOTES
  43 Note that all but \fBwinsdelln\fR may be a macros.
  44
  45 These routines do not require a hardware line delete or insert feature in the
  46 terminal.  In fact, they won't use hardware line delete/insert unless
  47 \fBidlok(..., TRUE)\fR has been set on the current window.
  48 .SH SEE ALSO
  49 \fBcurses\fR(3X)
  50 .\"#
  51 .\"# The following sets edit modes for GNU EMACS
  52 .\"# Local Variables:
  53 .\"# mode:nroff
  54 .\"# fill-column:79
  55 .\"# End: