ncurses 5.6 - patch 20070128
[ncurses.git] / man / form_new_page.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2002,2006 Free Software Foundation, Inc.              *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: form_new_page.3x,v 1.8 2006/11/04 17:12:00 tom Exp $
31 .TH form_new_page 3X ""
32 .SH NAME
33 \fBform_new_page\fR - form pagination functions
34 .SH SYNOPSIS
35 \fB#include <form.h>\fR
36 .br
37 int set_new_page(FIELD *field, bool new_page_flag);
38 .br
39 bool new_page(const FIELD *field);
40 .br
41 .SH DESCRIPTION
42 The function \fBset_new_page\fR sets or resets a flag marking the given field
43 as the beginning of a new page on its form.
44 .PP
45 The function \fBnew_page\fR is a predicate which tests if a given field marks
46 a page beginning on its form.
47 .SH RETURN VALUE
48 The function \fBnew_page\fR returns \fBTRUE\fR or \fBFALSE\fR.
49 .PP
50 The function \fBset_new_page\fR return one of the following:
51 .TP 5
52 .B E_OK
53 The routine succeeded.
54 .TP 5
55 .B E_SYSTEM_ERROR
56 System error occurred (see \fBerrno\fR).
57 .TP 5
58 .B E_CONNECTED
59 The given field is already connected to a form.
60 .SH SEE ALSO
61 \fBcurses\fR(3X) and related pages whose names begin "form_" for detailed
62 descriptions of the entry points.
63 .SH NOTES
64 The header file \fB<form.h>\fR automatically includes the header file
65 \fB<curses.h>\fR.
66 .SH PORTABILITY
67 These routines emulate the System V forms library.  They were not supported on
68 Version 7 or BSD versions.
69 .SH AUTHORS
70 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
71 S. Raymond.
72 .\"#
73 .\"# The following sets edit modes for GNU EMACS
74 .\"# Local Variables:
75 .\"# mode:nroff
76 .\"# fill-column:79
77 .\"# End: