3 ****************************************************************************
4 * Copyright (c) 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 ****************************************************************************
30 * @Id: form_new_page.3x,v 1.11 2015/12/05 23:42:45 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>form_new_page 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 <H1 class="no-header">form_new_page 3x</H1>
44 <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG> <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>set_new_page</STRONG>, <STRONG>new_page</STRONG> - form pagination functions
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
55 int set_new_page(FIELD *field, bool new_page_flag);
56 bool new_page(const FIELD *field);
59 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
60 The function <STRONG>set_new_page</STRONG> sets or resets a flag marking the given field
61 as the beginning of a new page on its form.
63 The function <STRONG>new_page</STRONG> is a predicate which tests if a given field marks
64 a page beginning on its form.
67 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
68 The function <STRONG>new_page</STRONG> returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>.
70 The function <STRONG>set_new_page</STRONG> return one of the following:
72 <STRONG>E_OK</STRONG> The routine succeeded.
74 <STRONG>E_SYSTEM_ERROR</STRONG>
75 System error occurred (see <STRONG>errno</STRONG>).
77 <STRONG>E_CONNECTED</STRONG>
78 The given field is already connected to a form.
81 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
82 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for detailed
83 descriptions of the entry points.
86 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
87 The header file <STRONG><form.h></STRONG> automatically includes the header file
88 <STRONG><curses.h></STRONG>.
91 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
92 These routines emulate the System V forms library. They were not sup-
93 ported on Version 7 or BSD versions.
96 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
97 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
102 <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG>
106 <li><a href="#h2-NAME">NAME</a></li>
107 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
108 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
109 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
110 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
111 <li><a href="#h2-NOTES">NOTES</a></li>
112 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
113 <li><a href="#h2-AUTHORS">AUTHORS</a></li>