ncurses 5.7 - patch 20100731
[ncurses.git] / man / form_field.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
4 .\"                                                                          *
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:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
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.                               *
23 .\"                                                                          *
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       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: form_field.3x,v 1.9 2010/07/31 16:09:36 tom Exp $
31 .TH form_field 3X ""
32 .SH NAME
33 \fBform_field\fR \- make and break connections between fields and forms
34 .SH SYNOPSIS
35 \fB#include <form.h>\fR
36 .br
37 int set_form_fields(FORM *form, FIELD **fields);
38 .br
39 FIELD **form_fields(const FORM *form);
40 .br
41 int field_count(const FORM *form);
42 .br
43 int move_field(FIELD *field, int frow, int fcol);
44 .br
45 .SH DESCRIPTION
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.
48 .PP
49 The function \fBform_fields\fR returns the field array of the given form.
50 .PP
51 The function \fBfield_count\fR returns the count of fields in \fIform\fR.
52 .PP
53 The function \fBmove_field\fR moves the given field (which must be disconnected)
54 to a specified location on the screen.
55 .SH RETURN VALUES
56 The function \fBform_fields\fR returns a pointer (which may be \fBNULL\fR).
57 It does not set errno.
58 .PP
59 The function \fBfield_count\fR returns \fBERR\fR if the \fIform\fP parameter
60 is \fBNULL\fP.
61 .PP
62 The functions \fBset_form_fields\fR and \fBmove_field\fR return one of
63 the following codes on error:
64 .TP 5
65 .B E_OK
66 The routine succeeded.
67 .TP 5
68 .B E_BAD_ARGUMENT
69 Routine detected an incorrect or out-of-range argument.
70 .TP 5
71 .B E_CONNECTED
72 The field is already connected to a form.
73 .TP 5
74 .B E_POSTED
75 The form is already posted.
76 .TP 5
77 .B E_SYSTEM_ERROR
78 System error occurred (see \fBerrno\fR).
79 .SH SEE ALSO
80 \fBcurses\fR(3X), \fBform\fR(3X).
81 .SH NOTES
82 The header file \fB<form.h>\fR automatically includes the header file
83 \fB<curses.h>\fR.
84 .SH PORTABILITY
85 These routines emulate the System V forms library.  They were not supported on
86 Version 7 or BSD versions.
87 .PP
88 The SVr4 forms library documentation specifies the \fBfield_count\fR error value
89 as \-1 (which is the value of \fBERR\fR).
90 .SH AUTHORS
91 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
92 S. Raymond.
93 .\"#
94 .\"# The following sets edit modes for GNU EMACS
95 .\"# Local Variables:
96 .\"# mode:nroff
97 .\"# fill-column:79
98 .\"# End: