\" $NetBSD: form_new_page.3,v 1.11 2010/03/22 21:58:31 joerg Exp $

\" $NetBSD: form_new_page.3,v 1.11 2010/03/22 21:58:31 joerg Exp $
\"
\" Copyright (c) 2001
\" Brett Lymn - [email protected], [email protected]
\"
\" 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.
\"
Dd January 1, 2001
Dt FORMS 3
Os
Sh NAME
Nm new_page ,
Nm set_new_page
Nd form library
Sh LIBRARY
Lb libform
Sh SYNOPSIS
In form.h
Ft int
Fn new_page "FIELD *field"
Ft int
Fn set_new_page "FIELD *field" "int page"
Sh DESCRIPTION
The
Fn new_page
function returns
Dv TRUE
if the given field is the start of a new page, otherwise it returns
Dv FALSE ,
the new page status of a field can be set or unset using the
Fn set_new_page
function.
Sh RETURN VALUES
The functions 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
In form.h
automatically includes both
In curses.h
and
In eti.h .