NetBSD/lib/libform/form_new_page.3

76 lines
2.5 KiB
Groff
Raw Normal View History

.\" $NetBSD: form_new_page.3,v 1.5 2002/08/06 12:44:35 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 new_page ,
.Nm set_new_page
.Nd form library
.Sh LIBRARY
.Lb libform
.Sh SYNOPSIS
2002-02-07 10:00:09 +03:00
.Fd #include \*[Lt]form.h\*[Gt]
2001-07-08 16:10:28 +04:00
.Ft int
.Fn new_page "FIELD *field"
.Ft int
.Fn set_new_page "FIELD *field" "int page"
2001-07-08 16:10:28 +04:00
.Sh DESCRIPTION
2002-01-15 05:47:02 +03:00
The
2001-07-08 16:10:28 +04:00
.Fn new_page
function returns TRUE if the given field is the start of a new page,
otherwise it returns FALSE, the new page status of a field can be set
2002-01-15 05:47:02 +03:00
or unset using the
2001-07-08 16:10:28 +04:00
.Fn set_new_page
function.
.Sh RETURN VALUES
Functions returning pointers will return NULL if an error is detected.
The functions that return an int will return one of the following error
values:
.Pp
.Bl -tag -width E_UNKNOWN_COMMAND -compact
.It Er E_OK
The function was successful.
.It Er E_CONNECTED
The field is connected to a form.
.El
.Sh SEE ALSO
.Xr curses 3 ,
.Xr forms 3
.Sh NOTES
The header
2002-02-07 10:00:09 +03:00
.Pa \*[Lt]form.h\*[Gt]
2001-07-08 16:10:28 +04:00
automatically includes both
2002-02-07 10:00:09 +03:00
.Pa \*[Lt]curses.h\*[Gt]
2001-07-08 16:10:28 +04:00
and
2002-02-07 10:00:09 +03:00
.Pa \*[Lt]eti.h\*[Gt] .