NetBSD/lib/libform/form_cursor.3

72 lines
2.4 KiB
Groff
Raw Normal View History

2004-11-24 15:47:20 +03:00
.\" $NetBSD: form_cursor.3,v 1.8 2004/11/24 12:47:20 wiz Exp $
2001-07-08 16:10:28 +04:00
.\"
.\" Copyright (c) 2001
.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
.\"
.\" This code is donated to The NetBSD Foundation by the author.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. The name of the Author may not be used to endorse or promote
.\" products derived from this software without specific prior written
.\" permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
2002-02-20 14:30:57 +03:00
.Dd January 1, 2001
2001-07-08 16:10:28 +04:00
.Dt FORMS 3
2002-01-15 05:47:02 +03:00
.Os
2001-07-08 16:10:28 +04:00
.Sh NAME
.Nm pos_form_cursor
.Nd form library
.Sh LIBRARY
.Lb libform
.Sh SYNOPSIS
.In form.h
2001-07-08 16:10:28 +04:00
.Ft int
.Fn pos_form_cursor "FORM *form"
.Sh DESCRIPTION
2002-01-15 05:47:02 +03:00
The function
2001-07-08 16:10:28 +04:00
.Fn pos_form_cursor
positions the screen cursor at the correct position for the form.
This function can be used to restore the cursor state after using
other curses routines.
.Sh RETURN VALUES
2004-11-24 15:47:20 +03:00
.Fn pos_form_cursor
will return one of the following error values:
2001-07-08 16:10:28 +04:00
.Pp
.Bl -tag -width E_UNKNOWN_COMMAND -compact
.It Er E_OK
The function was successful.
.It Er E_BAD_ARGUMENT
A bad argument was passed to the function.
.It Er E_NOT_POSTED
The form is not posted to the screen.
.El
.Sh SEE ALSO
.Xr curses 3 ,
.Xr forms 3
.Sh NOTES
The header
2004-11-24 15:12:19 +03:00
.Aq Pa form.h
2001-07-08 16:10:28 +04:00
automatically includes both
2004-11-24 15:12:19 +03:00
.Aq Pa curses.h
2001-07-08 16:10:28 +04:00
and
2004-11-24 15:12:19 +03:00
.Aq Pa eti.h .