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

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