doc/html/man/curs_deleteln.3x.html

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
   2 <!--
   3   ****************************************************************************
   4   * Copyright (c) 1998,2000 Free Software Foundation, Inc.                   *
   5   *                                                                          *
   6   * Permission is hereby granted, free of charge, to any person obtaining a  *
   7   * copy of this software and associated documentation files (the            *
   8   * "Software"), to deal in the Software without restriction, including      *
   9   * without limitation the rights to use, copy, modify, merge, publish,      *
  10   * distribute, distribute with modifications, sublicense, and/or sell       *
  11   * copies of the Software, and to permit persons to whom the Software is    *
  12   * furnished to do so, subject to the following conditions:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24   *                                                                          *
  25   * Except as contained in this notice, the name(s) of the above copyright   *
  26   * holders shall not be used in advertising or otherwise to promote the     *
  27   * sale, use or other dealings in this Software without prior written       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * @Id: curs_deleteln.3x,v 1.7 2000/11/11 20:43:20 Bernhard.Rosenkraenzer Exp @
  31 -->
  32 <HTML>
  33 <HEAD>
  34 <TITLE>curs_deleteln 3x</TITLE>
  35 <link rev=made href="mailto:bug-ncurses@gnu.org">
  36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  37 </HEAD>
  38 <BODY>
  39 <H1>curs_deleteln 3x</H1>
  40 <HR>
  41 <PRE>
  42 <!-- Manpage converted by man2html 3.0.1 -->
  43
  44 </PRE>
  45 <H2>NAME</H2><PRE>
  46        <STRONG>deleteln</STRONG>,  <STRONG>wdeleteln</STRONG>,  <STRONG>insdelln</STRONG>, <STRONG>winsdelln</STRONG>, <STRONG>insertln</STRONG>, <STRONG>win-</STRONG>
  47        <STRONG>sertln</STRONG> - delete and insert lines in a <STRONG>curses</STRONG> window
  48
  49
  50 </PRE>
  51 <H2>SYNOPSIS</H2><PRE>
  52        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  53
  54        <STRONG>int</STRONG> <STRONG>deleteln(void);</STRONG>
  55        <STRONG>int</STRONG> <STRONG>wdeleteln(WINDOW</STRONG> <STRONG>*win);</STRONG>
  56        <STRONG>int</STRONG> <STRONG>insdelln(int</STRONG> <STRONG>n);</STRONG>
  57        <STRONG>int</STRONG> <STRONG>winsdelln(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
  58        <STRONG>int</STRONG> <STRONG>insertln(void);</STRONG>
  59        <STRONG>int</STRONG> <STRONG>winsertln(WINDOW</STRONG> <STRONG>*win);</STRONG>
  60
  61
  62 </PRE>
  63 <H2>DESCRIPTION</H2><PRE>
  64        The <STRONG>deleteln</STRONG> and <STRONG>wdeleteln</STRONG> routines delete the line  under
  65        the cursor in the window; all lines below the current line
  66        are moved up one line.  The bottom line of the  window  is
  67        cleared.  The cursor position does not change.
  68
  69        The  <STRONG>insdelln</STRONG>  and  <STRONG>winsdelln</STRONG>  routines,  for  positive <EM>n</EM>,
  70        insert <EM>n</EM> lines into the specified window above the current
  71        line.   The  <EM>n</EM>  bottom  lines  are  lost.  For negative <EM>n</EM>,
  72        delete <EM>n</EM> lines (starting with the one under  the  cursor),
  73        and  move  the remaining lines up.  The bottom <EM>n</EM> lines are
  74        cleared.  The current cursor position remains the same.
  75
  76        The <STRONG>insertln</STRONG> and <STRONG>winsertln</STRONG> routines, insert a  blank  line
  77        above the current line and the bottom line is lost.
  78
  79
  80 </PRE>
  81 <H2>RETURN VALUE</H2><PRE>
  82        All routines return the integer <STRONG>ERR</STRONG> upon failure and an <STRONG>OK</STRONG>
  83        (SVr4 specifies only "an integer value  other  than  <STRONG>ERR</STRONG>")
  84        upon successful completion.
  85
  86
  87 </PRE>
  88 <H2>PORTABILITY</H2><PRE>
  89        These  functions are described in the XSI Curses standard,
  90        Issue 4.  The standard specifies that they return  <STRONG>ERR</STRONG>  on
  91        failure, but specifies no error conditions.
  92
  93
  94 </PRE>
  95 <H2>NOTES</H2><PRE>
  96        Note that all but <STRONG>winsdelln</STRONG> may be macros.
  97
  98        These  routines  do  not require a hardware line delete or
  99        insert feature in the terminal.  In fact, they  won't  use
 100        hardware  line  delete/insert  unless <STRONG>idlok(...,</STRONG> <STRONG>TRUE)</STRONG> has
 101        been set on the current window.
 102
 103
 104 </PRE>
 105 <H2>SEE ALSO</H2><PRE>
 106        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
 107
 108
 109
 110
 111 </PRE>
 112 <HR>
 113 <ADDRESS>
 114 Man(1) output converted with
 115 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 116 </ADDRESS>
 117 </BODY>
 118 </HTML>