2 .\"***************************************************************************
3 .\" Copyright 2018-2022,2023 Thomas E. Dickey *
4 .\" Copyright 1998-2010,2012 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 .\"***************************************************************************
31 .\" $Id: form_field.3x,v 1.30 2023/10/07 21:19:07 tom Exp $
32 .TH form_field 3X 2023-10-07 "ncurses 6.4" "Library calls"
35 make and break connections between fields and forms
40 \fBint set_form_fields(FORM *\fIform\fP, FIELD **\fIfields\fP);
41 \fBFIELD **form_fields(const FORM *\fIform\fP);
42 \fBint field_count(const FORM *\fIform\fP);
43 \fBint move_field(FIELD *\fIfield\fP, int \fIfrow\fP, int \fIfcol\fP);
46 The function \fBset_form_fields\fP changes the field pointer array of
47 the given \fIform\fP. The array must be terminated by a \fBNULL\fP.
49 The function \fBform_fields\fP returns the field array of the given form.
51 The function \fBfield_count\fP returns the count of fields in \fIform\fP.
53 The function \fBmove_field\fP moves the given field (which must be disconnected)
54 to a specified location on the screen.
56 The function \fBform_fields\fP returns a pointer (which may be \fBNULL\fP).
57 It does not set \fBerrno\fP.
59 The function \fBfield_count\fP returns \fBERR\fP if the \fIform\fP parameter
62 The functions \fBset_form_fields\fP and \fBmove_field\fP return one of
63 the following codes on error:
66 The routine succeeded.
69 Routine detected an incorrect or out-of-range argument.
72 The field is already connected to a form.
75 The form is already posted.
78 System error occurred (see \fBerrno\fP(3)).
80 The header file \fB<form.h>\fP automatically includes the header file
83 These routines emulate the System V forms library.
84 They were not supported on
85 Version 7 or BSD versions.
87 The SVr4 forms library documentation specifies the \fBfield_count\fP error value
88 as \-1 (which is the value of \fBERR\fP).
91 Manual pages and adaptation for new curses by Eric S. Raymond.