3e651a5a5d3efaec2af374e0297386eef36485e7
[ncurses.git] / man / form_field.3x
1 '\" t
2 .TH form_field 3X ""
3 .SH NAME
4 \fBform_field\fR - make and break connections between fields and forms
5 .SH SYNOPSIS
6 \fB#include <form.h>\fR
7 .br
8 int set_form_fields(FORM *form, FIELD **fields);
9 .br
10 FIELD **form_fields(const FORM *form);
11 .br
12 int field_count(const FORM *form);
13 .br
14 int move_field(FIELD *field, int frow, int fcol);
15 .br
16 .SH DESCRIPTION
17 The function \fBset_form_fields\fR changes the field pointer array of
18 the given \fIform\fR.  The array must be terminated by a \fBNULL\fR.
19
20 The function \fBform_fields\fR returns the field array of the given form.
21
22 The function \fBfield_count\fR returns the count of fields in \fIform\fR.
23
24 The function \fBmove_field\fR move the given field (which must be disconnected)
25 to a specified location on the screen.
26 .SH RETURN VALUES
27 The function \fBform_fields\fR returns \fBNULL\fR on error.
28
29 The function \fBfield_count\fR returns \fBERR\fR (the general
30 \fBcurses\fR error return value) on error.
31
32 The functions \fBset_form_fields\fR and \fBmove_field\fR return one of
33 the following codes on error:
34 .TP 5
35 \fBE_OK\fR
36 The routine succeeded.
37 .TP 5
38 \fBE_SYSTEM_ERROR\fR
39 System error occurred (see \fBerrno\fR).
40 .TP 5
41 \fBE_BAD_ARGUMENT\fR
42 Routine detected an incorrect or out-of-range argument.
43 .TP 5
44 \fBE_POSTED\fR
45 The form is already posted.
46 .TP 5
47 \fBE_CONNECTED\fR
48 The field is already connected to a form.
49 .SH SEE ALSO
50 \fBcurses\fR(3X), \fBform\fR(3X).
51 .SH NOTES
52 The header file \fB<form.h>\fR automatically includes the header file
53 \fB<curses.h>\fR.
54 .SH PORTABILITY
55 These routines emulate the System V forms library.  They were not supported on
56 Version 7 or BSD versions.
57
58 The SVr4 forms library documentation specifies the \fBfield_count\fR error value
59 as -1 (which is the value of \fBERR\fR).
60 .SH AUTHORS
61 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
62 S. Raymond.
63 .\"#
64 .\"# The following sets edit modes for GNU EMACS
65 .\"# Local Variables:
66 .\"# mode:nroff
67 .\"# fill-column:79
68 .\"# End: