ncurses 6.1 - patch 20191130
[ncurses.git] / man / form_new_page.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2018,2019 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.14 2019/11/30 21:06:30 tom Exp $
31 .TH form_new_page 3X ""
32 .ie \n(.g .ds `` \(lq
33 .el       .ds `` ``
34 .ie \n(.g .ds '' \(rq
35 .el       .ds '' ''
36 .SH NAME
37 \fBset_new_page\fR,
38 \fBnew_page\fR \- form pagination functions
39 .SH SYNOPSIS
40 \fB#include <form.h>\fR
41 .br
42 int set_new_page(FIELD *field, bool new_page_flag);
43 .br
44 bool new_page(const FIELD *field);
45 .br
46 .SH DESCRIPTION
47 The function \fBset_new_page\fR sets or resets a flag marking the given field
48 as the beginning of a new page on its form.
49 .PP
50 The function \fBnew_page\fR is a predicate which tests if a given field marks
51 a page beginning on its form.
52 .SH RETURN VALUE
53 The function \fBnew_page\fR returns \fBTRUE\fR or \fBFALSE\fR.
54 .PP
55 The function \fBset_new_page\fR returns one of the following:
56 .TP 5
57 .B E_OK
58 The routine succeeded.
59 .TP 5
60 .B E_CONNECTED
61 The given field is already connected to a form.
62 .SH SEE ALSO
63 \fBcurses\fR(3X) and related pages whose names begin \*(``form_\*('' for detailed
64 descriptions of the entry points.
65 .SH NOTES
66 The header file \fB<form.h>\fR automatically includes the header file
67 \fB<curses.h>\fR.
68 .SH PORTABILITY
69 These routines emulate the System V forms library.
70 They were not supported on
71 Version 7 or BSD versions.
72 .SH AUTHORS
73 Juergen Pfeifer.
74 Manual pages and adaptation for new curses by Eric S. Raymond.