lib/libcurses/curses_deleteln.3

   1 .\"     $NetBSD: curses_deleteln.3,v 1.4 2003/04/16 13:35:01 wiz 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_DELETELN 3
  35 .Os
  36 .Sh NAME
  37 .Nm curses_deleteln ,
  38 .Nm deleteln ,
  39 .Nm wdeleteln
  40 .Nd curses delete single line routines
  41 .Sh LIBRARY
  42 .Lb libcurses
  43 .Sh SYNOPSIS
  44 .In curses.h
  45 .Ft int
  46 .Fn deleteln "void"
  47 .Ft int
  48 .Fn wdeleteln "WINDOW *win"
  49 .Sh DESCRIPTION
  50 These functions delete a single line from
  51 .Dv stdscr
  52 or from the specified window.
  53 .Pp
  54 The
  55 .Fn deleteln
  56 function deletes the screen line containing the cursor in the
  57 .Dv stdscr .
  58 The
  59 .Fn wdeleteln
  60 function is the same as the
  61 .Fn deleteln
  62 function, excepting that the line is deleted from the window specified by
  63 .Fa win .
  64 .Pp
  65 All lines following the deleted line are moved up one line toward the cursor.
  66 The last line of the window is cleared.
  67 The cursor position is unchanged.
  68 .Pp
  69 If a scrolling region has been set with the
  70 .Fn setscrreg
  71 or
  72 .Fn wsetscrreg
  73 functions and the current cursor position is inside the scrolling region,
  74 then only the lines from the current line to the bottom of the scrolling
  75 region are moved up and the bottom line of the scrolling region cleared.
  76 .Pp
  77 The functions
  78 .Fn deleteln
  79 and
  80 .Fn wdeleteln win
  81 are equivalent to
  82 .Fn winsdelln stdscr \-1
  83 and
  84 .Fn winsdelln win \-1
  85 respectively.
  86 .Sh RETURN VALUES
  87 Functions returning pointers will return
  88 .Dv NULL
  89 if an error is detected.
  90 The functions that return an int will return one of the following
  91 values:
  92 .Pp
  93 .Bl -tag -width ERR -compact
  94 .It Er OK
  95 The function completed successfully.
  96 .It Er ERR
  97 An error occurred in the function.
  98 .El
  99 .Sh SEE ALSO
 100 .Xr curses_insdelln 3 ,
 101 .Xr curses_insertln 3 ,
 102 .Xr curses_scroll 3
 103 .Sh STANDARDS
 104 The
 105 .Nx
 106 Curses library complies with the X/Open Curses specification, part of the
 107 Single Unix Specification.
 108 .Sh HISTORY
 109 The Curses package appeared in
 110 .Bx 4.0 .