3 ****************************************************************************
4 * Copyright (c) 1998-2006,2010 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_page.3x,v 1.12 2010/12/04 18:40: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_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">
45 <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG> <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
51 <H2><a name="h2-NAME">NAME</a></H2><PRE>
52 <STRONG>form_page</STRONG> - set and get form page number
56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
57 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
58 int set_current_field(FORM *form, FIELD *field);
59 FIELD *current_field(const FORM *);
60 int set_form_page(FORM *form, int n);
61 int form_page(const FORM *form);
62 int field_index(const FIELD *field);
66 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
67 The function <STRONG>set_current</STRONG> <STRONG>field</STRONG> sets the current field of
68 the given form; <STRONG>current_field</STRONG> returns the current field of
71 The function <STRONG>set_form_page</STRONG> sets the form's page number
72 (goes to page <EM>n</EM> of the form).
74 The function <STRONG>form_page</STRONG> returns the form's current page
77 The function <STRONG>field_index</STRONG> returns the index of the field in
78 the field array of the form it is connected to. It returns
79 <STRONG>ERR</STRONG> if the argument is the null pointer or the field is
84 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
85 Except for <STRONG>form_page</STRONG>, each routine returns one of the fol-
88 <STRONG>E_OK</STRONG> The routine succeeded.
90 <STRONG>E_BAD_ARGUMENT</STRONG>
91 Routine detected an incorrect or out-of-range argu-
94 <STRONG>E_BAD_STATE</STRONG>
95 Routine was called from an initialization or termina-
98 <STRONG>E_INVALID_FIELD</STRONG>
99 Contents of a field are not valid.
101 <STRONG>E_REQUEST_DENIED</STRONG>
102 The form driver could not process the request.
104 <STRONG>E_SYSTEM_ERROR</STRONG>
105 System error occurred (see <STRONG>errno</STRONG>).
109 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
110 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
114 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
115 The header file <STRONG><form.h></STRONG> automatically includes the header
116 file <STRONG><curses.h></STRONG>.
120 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
121 These routines emulate the System V forms library. They
122 were not supported on Version 7 or BSD versions.
126 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
127 Juergen Pfeifer. Manual pages and adaptation for new
128 curses by Eric S. Raymond.
132 <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
136 <li><a href="#h2-NAME">NAME</a></li>
137 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
138 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
139 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
140 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
141 <li><a href="#h2-NOTES">NOTES</a></li>
142 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
143 <li><a href="#h2-AUTHORS">AUTHORS</a></li>