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 <B><A HREF="form_field.3X.html">form_field(3X)</A></B> <B><A HREF="form_field.3X.html">form_field(3X)</A></B>
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <B>form_field</B> - make and break connections between fields and forms
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <B>#include</B> <B><form.h></B>
57 <B>int</B> <B>set_form_fields(FORM</B> <B>*</B><I>form</I><B>,</B> <B>FIELD</B> <B>**</B><I>fields</I><B>);</B>
58 <B>FIELD</B> <B>**form_fields(const</B> <B>FORM</B> <B>*</B><I>form</I><B>);</B>
59 <B>int</B> <B>field_count(const</B> <B>FORM</B> <B>*</B><I>form</I><B>);</B>
60 <B>int</B> <B>move_field(FIELD</B> <B>*</B><I>field</I><B>,</B> <B>int</B> <I>frow</I><B>,</B> <B>int</B> <I>fcol</I><B>);</B>
63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
64 The function <B>set_form_fields</B> changes the field pointer array of the
65 given <I>form</I>. The array must be terminated by a <B>NULL</B>.
67 The function <B>form_fields</B> returns the field array of the given form.
69 The function <B>field_count</B> returns the count of fields in <I>form</I>.
71 The function <B>move_field</B> 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 <B>form_fields</B> returns a pointer (which may be <B>NULL</B>). It
77 does not set <B>errno</B>.
79 The function <B>field_count</B> returns <B>ERR</B> if the <I>form</I> parameter is <B>NULL</B>.
81 The functions <B>set_form_fields</B> and <B>move_field</B> return one of the
82 following codes on error:
84 <B>E_OK</B> The routine succeeded.
87 Routine detected an incorrect or out-of-range argument.
90 The field is already connected to a form.
93 The form is already posted.
96 System error occurred (see <B>errno(3)</B>).
99 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
100 <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="form.3X.html">form(3X)</A></B>.
103 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
104 The header file <B><form.h></B> automatically includes the header file
105 <B><curses.h></B>.
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 <B>field_count</B> error
113 value as -1 (which is the value of <B>ERR</B>).
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 <B><A HREF="form_field.3X.html">form_field(3X)</A></B>
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>