lib/libcurses/curses_insdelln.3

   1 .\"     $NetBSD: curses_insdelln.3,v 1.2 2003/02/14 16:29:11 grant Exp $
   2 .\"
   3 .\" Copyright (c) 2002
   4 .\"     Brett Lymn (blymn@NetBSD.org, brett_lymn@yahoo.com.au)
   5 .\"
   6 .\" This code is donated to the NetBSD Foundation by the Author.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. The name of the Author may not be used to endorse or promote
  17 .\"    products derived from this software without specific prior written
  18 .\"    permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"
  33 .Dd August 12, 2002
  34 .Dt CURSES_INSDEL 3
  35 .Os
  36 .Sh NAME
  37 .Nm curses_insdelln ,
  38 .Nm insdelln ,
  39 .Nm winsdelln
  40 .Nd curses insert or delete lines routines
  41 .Sh LIBRARY
  42 .Lb libcurses
  43 .Sh SYNOPSIS
  44 .In curses.h
  45 .Ft int
  46 .Fn insdelln "int n"
  47 .Ft int
  48 .Fn winsdelln "WINDOW *win" "int n"
  49 .Sh DESCRIPTION
  50 These functions insert or delete lines on
  51 .Dv stdscr
  52 or on the specified window.
  53 .Pp
  54 If
  55 .Fn insdelln
  56 is called with a positive number in
  57 .Fa n ,
  58 then the specified number of lines are inserted before the current line on
  59 .Dv stdscr .
  60 The last
  61 .Fa n
  62 lines of the screen are no longer displayed.
  63 If
  64 .Fa n
  65 is negative, then
  66 .Fa n
  67 lines are deleted from
  68 .Dv stdscr ,
  69 starting at the current line.
  70 The last
  71 .Fa n
  72 lines of
  73 .Dv stdscr
  74 are cleared.
  75 .Pp
  76 The
  77 .Fn winsdelln
  78 function is the same as the
  79 .Fn insdelln
  80 function, excepting that lines are inserted or deleted from the window
  81 specified by
  82 .Fa win .
  83 .Pp
  84 If a scrolling region has been set with the
  85 .Fn setscrreg
  86 or
  87 .Fn wsetscrreg
  88 functions and the current cursor position is inside the scrolling region,
  89 then only the lines from the current line to the bottom of the scrolling
  90 region are affected.
  91 .Sh RETURN VALUES
  92 Functions returning pointers will return
  93 .Dv NULL
  94 if an error is detected.
  95 The functions that return an int will return one of the following
  96 values:
  97 .Pp
  98 .Bl -tag -width ERR -compact
  99 .It Er OK
 100 The function completed successfully.
 101 .It Er ERR
 102 An error occurred in the function.
 103 .El
 104 .Sh SEE ALSO
 105 .Xr curses_deleteln 3 ,
 106 .Xr curses_insertln 3 ,
 107 .Xr curses_scroll 3
 108 .Sh STANDARDS
 109 The
 110 .Nx
 111 Curses library complies with the X/Open Curses specification, part of
 112 the Single Unix Specification.
 113 .Sh HISTORY
 114 The Curses package appeared in
 115 .Bx 4.0 .