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

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
   2 <!--
   3   ****************************************************************************
   4   * Copyright (c) 1998-2007,2010 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.13 2010/12/04 18:36:44 tom 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 <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>
  49 <H2>NAME</H2><PRE>
  50        <STRONG>deleteln</STRONG>,  <STRONG>wdeleteln</STRONG>,  <STRONG>insdelln</STRONG>, <STRONG>winsdelln</STRONG>, <STRONG>insertln</STRONG>, <STRONG>win-</STRONG>
  51        <STRONG>sertln</STRONG> - delete and insert lines in a <STRONG>curses</STRONG> window
  52
  53
  54 </PRE>
  55 <H2>SYNOPSIS</H2><PRE>
  56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  57
  58        <STRONG>int</STRONG> <STRONG>deleteln(void);</STRONG>
  59        <STRONG>int</STRONG> <STRONG>wdeleteln(WINDOW</STRONG> <STRONG>*win);</STRONG>
  60        <STRONG>int</STRONG> <STRONG>insdelln(int</STRONG> <STRONG>n);</STRONG>
  61        <STRONG>int</STRONG> <STRONG>winsdelln(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
  62        <STRONG>int</STRONG> <STRONG>insertln(void);</STRONG>
  63        <STRONG>int</STRONG> <STRONG>winsertln(WINDOW</STRONG> <STRONG>*win);</STRONG>
  64
  65
  66 </PRE>
  67 <H2>DESCRIPTION</H2><PRE>
  68        The <STRONG>deleteln</STRONG> and <STRONG>wdeleteln</STRONG> routines delete the line  under
  69        the cursor in the window; all lines below the current line
  70        are moved up one line.  The bottom line of the  window  is
  71        cleared.  The cursor position does not change.
  72
  73        The  <STRONG>insdelln</STRONG>  and  <STRONG>winsdelln</STRONG>  routines,  for  positive <EM>n</EM>,
  74        insert <EM>n</EM> lines into the specified window above the current
  75        line.   The  <EM>n</EM>  bottom  lines  are  lost.  For negative <EM>n</EM>,
  76        delete <EM>n</EM> lines (starting with the one under  the  cursor),
  77        and  move  the remaining lines up.  The bottom <EM>n</EM> lines are
  78        cleared.  The current cursor position remains the same.
  79
  80        The <STRONG>insertln</STRONG> and <STRONG>winsertln</STRONG> routines insert  a  blank  line
  81        above the current line and the bottom line is lost.
  82
  83
  84 </PRE>
  85 <H2>RETURN VALUE</H2><PRE>
  86        All routines return the integer <STRONG>ERR</STRONG> upon failure and an <STRONG>OK</STRONG>
  87        (SVr4 specifies only "an integer value  other  than  <STRONG>ERR</STRONG>")
  88        upon successful completion.
  89
  90        X/Open  defines  no error conditions.  In this implementa-
  91        tion, if  the  window  parameter  is  null,  an  error  is
  92        returned.
  93
  94
  95 </PRE>
  96 <H2>PORTABILITY</H2><PRE>
  97        These  functions are described in the XSI Curses standard,
  98        Issue 4.  The standard specifies that they return  <STRONG>ERR</STRONG>  on
  99        failure, but specifies no error conditions.
 100
 101
 102 </PRE>
 103 <H2>NOTES</H2><PRE>
 104        Note that all but <STRONG>winsdelln</STRONG> may be macros.
 105
 106        These  routines  do  not require a hardware line delete or
 107        insert feature in the terminal.  In fact,  they  will  not
 108        use  hardware  line  delete/insert unless <STRONG>idlok(...,</STRONG> <STRONG>TRUE)</STRONG>
 109        has been set on the current window.
 110
 111
 112 </PRE>
 113 <H2>SEE ALSO</H2><PRE>
 114        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
 115
 116
 117
 118                                                       <STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG>
 119 </PRE>
 120 <HR>
 121 <ADDRESS>
 122 Man(1) output converted with
 123 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 124 </ADDRESS>
 125 </BODY>
 126 </HTML>