2 .\"***************************************************************************
3 .\" Copyright (c) 1998 Free Software Foundation, Inc. *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a *
6 .\" copy of this software and associated documentation files (the *
7 .\" "Software"), to deal in the Software without restriction, including *
8 .\" without limitation the rights to use, copy, modify, merge, publish, *
9 .\" distribute, distribute with modifications, sublicense, and/or sell *
10 .\" copies of the Software, and to permit persons to whom the Software is *
11 .\" furnished to do so, subject to the following conditions: *
13 .\" The above copyright notice and this permission notice shall be included *
14 .\" in all copies or substantial portions of the Software. *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 .\" Except as contained in this notice, the name(s) of the above copyright *
25 .\" holders shall not be used in advertising or otherwise to promote the *
26 .\" sale, use or other dealings in this Software without prior written *
28 .\"***************************************************************************
30 .\" $Id: form_field.3x,v 1.5 1998/11/29 01:05:52 Rick.Ohnemus Exp $
33 \fBform_field\fR - make and break connections between fields and forms
35 \fB#include <form.h>\fR
37 int set_form_fields(FORM *form, FIELD **fields);
39 FIELD **form_fields(const FORM *form);
41 int field_count(const FORM *form);
43 int move_field(FIELD *field, int frow, int fcol);
46 The function \fBset_form_fields\fR changes the field pointer array of
47 the given \fIform\fR. The array must be terminated by a \fBNULL\fR.
49 The function \fBform_fields\fR returns the field array of the given form.
51 The function \fBfield_count\fR returns the count of fields in \fIform\fR.
53 The function \fBmove_field\fR move the given field (which must be disconnected)
54 to a specified location on the screen.
56 The function \fBform_fields\fR returns \fBNULL\fR on error.
58 The function \fBfield_count\fR returns \fBERR\fR (the general
59 \fBcurses\fR error return value) on error.
61 The functions \fBset_form_fields\fR and \fBmove_field\fR return one of
62 the following codes on error:
65 The routine succeeded.
68 System error occurred (see \fBerrno\fR).
71 Routine detected an incorrect or out-of-range argument.
74 The form is already posted.
77 The field is already connected to a form.
79 \fBcurses\fR(3X), \fBform\fR(3X).
81 The header file \fB<form.h>\fR automatically includes the header file
84 These routines emulate the System V forms library. They were not supported on
85 Version 7 or BSD versions.
87 The SVr4 forms library documentation specifies the \fBfield_count\fR error value
88 as -1 (which is the value of \fBERR\fR).
90 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
93 .\"# The following sets edit modes for GNU EMACS