ncurses 6.0 - patch 20151205
[ncurses.git] / doc / html / man / form_new_page.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
5   *                                                                          *
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:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
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.                               *
24   *                                                                          *
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       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: form_new_page.3x,v 1.11 2015/12/05 23:42:45 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
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">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">form_new_page 3x</H1>
43 <PRE>
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>
45
46
47
48
49 </PRE>
50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>set_new_page</STRONG>, <STRONG>new_page</STRONG> - form pagination functions
52
53
54 </PRE>
55 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
57        int set_new_page(FIELD *field, bool new_page_flag);
58        bool new_page(const FIELD *field);
59
60
61 </PRE>
62 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63        The  function  <STRONG>set_new_page</STRONG>  sets or resets a flag marking
64        the given field as the beginning of  a  new  page  on  its
65        form.
66
67        The  function  <STRONG>new_page</STRONG>  is  a  predicate which tests if a
68        given field marks a page beginning on its form.
69
70
71 </PRE>
72 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
73        The function <STRONG>new_page</STRONG> returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>.
74
75        The function <STRONG>set_new_page</STRONG> return one of the following:
76
77        <STRONG>E_OK</STRONG> The routine succeeded.
78
79        <STRONG>E_SYSTEM_ERROR</STRONG>
80             System error occurred (see <STRONG>errno</STRONG>).
81
82        <STRONG>E_CONNECTED</STRONG>
83             The given field is already connected to a form.
84
85
86 </PRE>
87 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
88        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
89        detailed descriptions of the entry points.
90
91
92 </PRE>
93 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
94        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
95        file <STRONG>&lt;curses.h&gt;</STRONG>.
96
97
98 </PRE>
99 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
100        These routines emulate the System V forms  library.   They
101        were not supported on Version 7 or BSD versions.
102
103
104 </PRE>
105 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
106        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
107        curses by Eric S. Raymond.
108
109
110
111                                                       <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG>
112 </PRE>
113 <div class="nav">
114 <ul>
115 <li><a href="#h2-NAME">NAME</a></li>
116 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
117 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
118 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
119 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
120 <li><a href="#h2-NOTES">NOTES</a></li>
121 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
122 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
123 </ul>
124 </div>
125 </BODY>
126 </HTML>