1*a0e6850fSThomas Cort.\" $NetBSD: form_cursor.3,v 1.9 2010/03/22 21:58:31 joerg Exp $ 2*a0e6850fSThomas Cort.\" 3*a0e6850fSThomas Cort.\" Copyright (c) 2001 4*a0e6850fSThomas Cort.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au 5*a0e6850fSThomas Cort.\" 6*a0e6850fSThomas Cort.\" This code is donated to The NetBSD Foundation by the author. 7*a0e6850fSThomas Cort.\" 8*a0e6850fSThomas Cort.\" Redistribution and use in source and binary forms, with or without 9*a0e6850fSThomas Cort.\" modification, are permitted provided that the following conditions 10*a0e6850fSThomas Cort.\" are met: 11*a0e6850fSThomas Cort.\" 1. Redistributions of source code must retain the above copyright 12*a0e6850fSThomas Cort.\" notice, this list of conditions and the following disclaimer. 13*a0e6850fSThomas Cort.\" 2. Redistributions in binary form must reproduce the above copyright 14*a0e6850fSThomas Cort.\" notice, this list of conditions and the following disclaimer in the 15*a0e6850fSThomas Cort.\" documentation and/or other materials provided with the distribution. 16*a0e6850fSThomas Cort.\" 3. The name of the Author may not be used to endorse or promote 17*a0e6850fSThomas Cort.\" products derived from this software without specific prior written 18*a0e6850fSThomas Cort.\" permission. 19*a0e6850fSThomas Cort.\" 20*a0e6850fSThomas Cort.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND 21*a0e6850fSThomas Cort.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22*a0e6850fSThomas Cort.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23*a0e6850fSThomas Cort.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE 24*a0e6850fSThomas Cort.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25*a0e6850fSThomas Cort.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26*a0e6850fSThomas Cort.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27*a0e6850fSThomas Cort.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28*a0e6850fSThomas Cort.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29*a0e6850fSThomas Cort.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30*a0e6850fSThomas Cort.\" SUCH DAMAGE. 31*a0e6850fSThomas Cort.\" 32*a0e6850fSThomas Cort.Dd January 1, 2001 33*a0e6850fSThomas Cort.Dt FORMS 3 34*a0e6850fSThomas Cort.Os 35*a0e6850fSThomas Cort.Sh NAME 36*a0e6850fSThomas Cort.Nm pos_form_cursor 37*a0e6850fSThomas Cort.Nd form library 38*a0e6850fSThomas Cort.Sh LIBRARY 39*a0e6850fSThomas Cort.Lb libform 40*a0e6850fSThomas Cort.Sh SYNOPSIS 41*a0e6850fSThomas Cort.In form.h 42*a0e6850fSThomas Cort.Ft int 43*a0e6850fSThomas Cort.Fn pos_form_cursor "FORM *form" 44*a0e6850fSThomas Cort.Sh DESCRIPTION 45*a0e6850fSThomas CortThe function 46*a0e6850fSThomas Cort.Fn pos_form_cursor 47*a0e6850fSThomas Cortpositions the screen cursor at the correct position for the form. 48*a0e6850fSThomas CortThis function can be used to restore the cursor state after using 49*a0e6850fSThomas Cortother curses routines. 50*a0e6850fSThomas Cort.Sh RETURN VALUES 51*a0e6850fSThomas Cort.Fn pos_form_cursor 52*a0e6850fSThomas Cortwill return one of the following error values: 53*a0e6850fSThomas Cort.Pp 54*a0e6850fSThomas Cort.Bl -tag -width E_UNKNOWN_COMMAND -compact 55*a0e6850fSThomas Cort.It Er E_OK 56*a0e6850fSThomas CortThe function was successful. 57*a0e6850fSThomas Cort.It Er E_BAD_ARGUMENT 58*a0e6850fSThomas CortA bad argument was passed to the function. 59*a0e6850fSThomas Cort.It Er E_NOT_POSTED 60*a0e6850fSThomas CortThe form is not posted to the screen. 61*a0e6850fSThomas Cort.El 62*a0e6850fSThomas Cort.Sh SEE ALSO 63*a0e6850fSThomas Cort.Xr curses 3 , 64*a0e6850fSThomas Cort.Xr forms 3 65*a0e6850fSThomas Cort.Sh NOTES 66*a0e6850fSThomas CortThe header 67*a0e6850fSThomas Cort.In form.h 68*a0e6850fSThomas Cortautomatically includes both 69*a0e6850fSThomas Cort.In curses.h 70*a0e6850fSThomas Cortand 71*a0e6850fSThomas Cort.In eti.h . 72