2 ****************************************************************************
3 * Copyright 2018-2022,2023 Thomas E. Dickey *
4 * Copyright 1998-2010,2016 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.32 2023/10/07 21:19:07 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 https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>form_page 3x 2023-10-07 ncurses 6.4 Library calls</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
42 <H1 class="no-header">form_page 3x 2023-10-07 ncurses 6.4 Library calls</H1>
44 <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG> Library calls <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>form_page</STRONG> - set and get form page number
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
56 <STRONG>int</STRONG> <STRONG>set_current_field(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG>
57 <STRONG>FIELD</STRONG> <STRONG>*current_field(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
59 <STRONG>int</STRONG> <STRONG>unfocus_current_field(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
61 <STRONG>int</STRONG> <STRONG>set_form_page(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
62 <STRONG>int</STRONG> <STRONG>form_page(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
64 <STRONG>int</STRONG> <STRONG>field_index(const</STRONG> <STRONG>FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG>
67 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
68 The function <STRONG>set_current_field</STRONG> sets the current field of the given
69 form; <STRONG>current_field</STRONG> returns the current field of the given form.
71 The function <STRONG>unfocus_current_field</STRONG> removes the focus from the current
72 field of the form. In such state, inquiries via <STRONG>current_field</STRONG> shall
73 return a NULL pointer.
75 The function <STRONG>set_form_page</STRONG> sets the form's page number (goes to page <EM>n</EM>
78 The function <STRONG>form_page</STRONG> returns the form's current page number.
80 The function <STRONG>field_index</STRONG> returns the index of the field in the field
81 array of the form it is connected to. It returns <STRONG>ERR</STRONG> if the argument
82 is the null pointer or the field is not connected.
85 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
86 Except for <STRONG>form_page</STRONG>, each routine returns one of the following:
88 <STRONG>E_OK</STRONG> The routine succeeded.
90 <STRONG>E_BAD_ARGUMENT</STRONG>
91 Routine detected an incorrect or out-of-range argument.
93 <STRONG>E_BAD_STATE</STRONG>
94 Routine was called from an initialization or termination function.
96 <STRONG>E_INVALID_FIELD</STRONG>
97 Contents of a field are not valid.
99 <STRONG>E_REQUEST_DENIED</STRONG>
100 The form driver could not process the request.
102 <STRONG>E_SYSTEM_ERROR</STRONG>
103 System error occurred (see <STRONG>errno(3)</STRONG>).
106 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
107 The header file <STRONG><form.h></STRONG> automatically includes the header file
108 <STRONG><curses.h></STRONG>.
111 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
112 These routines emulate the System V forms library. They were not
113 supported on Version 7 or BSD versions.
115 The <STRONG>unfocus_current_field</STRONG> function is an ncurses extension.
118 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
119 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
123 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
124 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>
128 ncurses 6.4 2023-10-07 <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
132 <li><a href="#h2-NAME">NAME</a></li>
133 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
134 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
135 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
136 <li><a href="#h2-NOTES">NOTES</a></li>
137 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
138 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
139 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>