curs_deleteln.3x.html 5.8 KB

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