xref: /netbsd-src/lib/libform/form_new_page.3 (revision f63b030c155962477d6bf4c9a6689bb1c35fdc25)
1*f63b030cSjoerg.\"	$NetBSD: form_new_page.3,v 1.11 2010/03/22 21:58:31 joerg Exp $
2e1a3174bSblymn.\"
3e1a3174bSblymn.\" Copyright (c) 2001
4e1a3174bSblymn.\"	Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
5e1a3174bSblymn.\"
6e1a3174bSblymn.\" This code is donated to The NetBSD Foundation by the author.
7e1a3174bSblymn.\"
8e1a3174bSblymn.\" Redistribution and use in source and binary forms, with or without
9e1a3174bSblymn.\" modification, are permitted provided that the following conditions
10e1a3174bSblymn.\" are met:
11e1a3174bSblymn.\" 1. Redistributions of source code must retain the above copyright
12e1a3174bSblymn.\"    notice, this list of conditions and the following disclaimer.
13e1a3174bSblymn.\" 2. Redistributions in binary form must reproduce the above copyright
14e1a3174bSblymn.\"    notice, this list of conditions and the following disclaimer in the
15e1a3174bSblymn.\"    documentation and/or other materials provided with the distribution.
16e1a3174bSblymn.\" 3. The name of the Author may not be used to endorse or promote
17e1a3174bSblymn.\"    products derived from this software without specific prior written
18e1a3174bSblymn.\"    permission.
19e1a3174bSblymn.\"
20e1a3174bSblymn.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
21e1a3174bSblymn.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22e1a3174bSblymn.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23e1a3174bSblymn.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
24e1a3174bSblymn.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25e1a3174bSblymn.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26e1a3174bSblymn.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27e1a3174bSblymn.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28e1a3174bSblymn.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29e1a3174bSblymn.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30e1a3174bSblymn.\" SUCH DAMAGE.
31e1a3174bSblymn.\"
320b7fe888Swiz.Dd January 1, 2001
33e1a3174bSblymn.Dt FORMS 3
34e1a3174bSblymn.Os
35e1a3174bSblymn.Sh NAME
36e1a3174bSblymn.Nm new_page ,
37e1a3174bSblymn.Nm set_new_page
38e1a3174bSblymn.Nd form library
39e1a3174bSblymn.Sh LIBRARY
40e1a3174bSblymn.Lb libform
41e1a3174bSblymn.Sh SYNOPSIS
42472351e1Swiz.In form.h
43e1a3174bSblymn.Ft int
44e1a3174bSblymn.Fn new_page "FIELD *field"
45e1a3174bSblymn.Ft int
466bce40bcSwiz.Fn set_new_page "FIELD *field" "int page"
47e1a3174bSblymn.Sh DESCRIPTION
48e1a3174bSblymnThe
49e1a3174bSblymn.Fn new_page
5020a78941Swizfunction returns
5120a78941Swiz.Dv TRUE
5220a78941Swizif the given field is the start of a new page, otherwise it returns
5320a78941Swiz.Dv FALSE ,
5420a78941Swizthe new page status of a field can be set or unset using the
55e1a3174bSblymn.Fn set_new_page
56e1a3174bSblymnfunction.
57e1a3174bSblymn.Sh RETURN VALUES
58b86a72cbSwizThe functions will return one of the following error values:
59e1a3174bSblymn.Pp
60e1a3174bSblymn.Bl -tag -width E_UNKNOWN_COMMAND -compact
61e1a3174bSblymn.It Er E_OK
62e1a3174bSblymnThe function was successful.
63e1a3174bSblymn.It Er E_CONNECTED
64e1a3174bSblymnThe field is connected to a form.
65e1a3174bSblymn.El
66e1a3174bSblymn.Sh SEE ALSO
67e1a3174bSblymn.Xr curses 3 ,
68e1a3174bSblymn.Xr forms 3
69e1a3174bSblymn.Sh NOTES
70e1a3174bSblymnThe header
71*f63b030cSjoerg.In form.h
72e1a3174bSblymnautomatically includes both
73*f63b030cSjoerg.In curses.h
74e1a3174bSblymnand
75*f63b030cSjoerg.In eti.h .
76