3 ****************************************************************************
4 * Copyright 2018-2019,2020 Thomas E. Dickey *
5 * Copyright 1998-2010,2012 Free Software Foundation, Inc. *
7 * Permission is hereby granted, free of charge, to any person obtaining a *
8 * copy of this software and associated documentation files (the *
9 * "Software"), to deal in the Software without restriction, including *
10 * without limitation the rights to use, copy, modify, merge, publish, *
11 * distribute, distribute with modifications, sublicense, and/or sell *
12 * copies of the Software, and to permit persons to whom the Software is *
13 * furnished to do so, subject to the following conditions: *
15 * The above copyright notice and this permission notice shall be included *
16 * in all copies or substantial portions of the Software. *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
21 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
22 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
23 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
24 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
26 * Except as contained in this notice, the name(s) of the above copyright *
27 * holders shall not be used in advertising or otherwise to promote the *
28 * sale, use or other dealings in this Software without prior written *
30 ****************************************************************************
31 * @Id: form_field.3x,v 1.17 2020/10/24 09:10:45 tom Exp @
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>form_field 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
43 <H1 class="no-header">form_field 3x</H1>
45 <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG> <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>form_field</STRONG> - make and break connections between fields and forms
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
57 <STRONG>int</STRONG> <STRONG>set_form_fields(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>FIELD</STRONG> <STRONG>**</STRONG><EM>fields</EM><STRONG>);</STRONG>
58 <STRONG>FIELD</STRONG> <STRONG>**form_fields(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
59 <STRONG>int</STRONG> <STRONG>field_count(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
60 <STRONG>int</STRONG> <STRONG>move_field(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>frow</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>fcol</EM><STRONG>);</STRONG>
63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
64 The function <STRONG>set_form_fields</STRONG> changes the field pointer array of the
65 given <EM>form</EM>. The array must be terminated by a <STRONG>NULL</STRONG>.
67 The function <STRONG>form_fields</STRONG> returns the field array of the given form.
69 The function <STRONG>field_count</STRONG> returns the count of fields in <EM>form</EM>.
71 The function <STRONG>move_field</STRONG> moves the given field (which must be
72 disconnected) to a specified location on the screen.
75 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
76 The function <STRONG>form_fields</STRONG> returns a pointer (which may be <STRONG>NULL</STRONG>). It
77 does not set <STRONG>errno</STRONG>.
79 The function <STRONG>field_count</STRONG> returns <STRONG>ERR</STRONG> if the <EM>form</EM> parameter is <STRONG>NULL</STRONG>.
81 The functions <STRONG>set_form_fields</STRONG> and <STRONG>move_field</STRONG> return one of the
82 following codes on error:
84 <STRONG>E_OK</STRONG> The routine succeeded.
86 <STRONG>E_BAD_ARGUMENT</STRONG>
87 Routine detected an incorrect or out-of-range argument.
89 <STRONG>E_CONNECTED</STRONG>
90 The field is already connected to a form.
92 <STRONG>E_POSTED</STRONG>
93 The form is already posted.
95 <STRONG>E_SYSTEM_ERROR</STRONG>
96 System error occurred (see <STRONG>errno(3)</STRONG>).
99 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
100 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
103 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
104 The header file <STRONG><form.h></STRONG> automatically includes the header file
105 <STRONG><curses.h></STRONG>.
108 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
109 These routines emulate the System V forms library. They were not
110 supported on Version 7 or BSD versions.
112 The SVr4 forms library documentation specifies the <STRONG>field_count</STRONG> error
113 value as -1 (which is the value of <STRONG>ERR</STRONG>).
116 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
117 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
122 <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
126 <li><a href="#h2-NAME">NAME</a></li>
127 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
128 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
129 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
130 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
131 <li><a href="#h2-NOTES">NOTES</a></li>
132 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
133 <li><a href="#h2-AUTHORS">AUTHORS</a></li>