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