2 .\"***************************************************************************
3 .\" Copyright 2018-2019,2020 Thomas E. Dickey *
4 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
6 .\" Permission is hereby granted, free of charge, to any person obtaining a *
7 .\" copy of this software and associated documentation files (the *
8 .\" "Software"), to deal in the Software without restriction, including *
9 .\" without limitation the rights to use, copy, modify, merge, publish, *
10 .\" distribute, distribute with modifications, sublicense, and/or sell *
11 .\" copies of the Software, and to permit persons to whom the Software is *
12 .\" furnished to do so, subject to the following conditions: *
14 .\" The above copyright notice and this permission notice shall be included *
15 .\" in all copies or substantial portions of the Software. *
17 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 .\" Except as contained in this notice, the name(s) of the above copyright *
26 .\" holders shall not be used in advertising or otherwise to promote the *
27 .\" sale, use or other dealings in this Software without prior written *
29 .\"***************************************************************************
31 .\" $Id: form_new_page.3x,v 1.15 2020/02/02 23:34:34 tom Exp $
32 .TH form_new_page 3X ""
39 \fBnew_page\fR \- form pagination functions
41 \fB#include <form.h>\fR
43 int set_new_page(FIELD *field, bool new_page_flag);
45 bool new_page(const FIELD *field);
48 The function \fBset_new_page\fR sets or resets a flag marking the given field
49 as the beginning of a new page on its form.
51 The function \fBnew_page\fR is a predicate which tests if a given field marks
52 a page beginning on its form.
54 The function \fBnew_page\fR returns \fBTRUE\fR or \fBFALSE\fR.
56 The function \fBset_new_page\fR returns one of the following:
59 The routine succeeded.
62 The given field is already connected to a form.
64 \fBcurses\fR(3X) and related pages whose names begin \*(``form_\*('' for detailed
65 descriptions of the entry points.
67 The header file \fB<form.h>\fR automatically includes the header file
70 These routines emulate the System V forms library.
71 They were not supported on
72 Version 7 or BSD versions.
75 Manual pages and adaptation for new curses by Eric S. Raymond.