Debian Codegraph @

upstream/debian-unstable/man3/field.3form

raw
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright 2018-2023,2024 Thomas E. Dickey *
4 .\" Copyright 1998-2010,2012 Free Software Foundation, Inc. *
5 .\" *
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: *
13 .\" *
14 .\" The above copyright notice and this permission notice shall be included *
15 .\" in all copies or substantial portions of the Software. *
16 .\" *
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. *
24 .\" *
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 *
28 .\" authorization. *
29 .\"***************************************************************************
30 .\"
31 .\" $Id: form_field.3x,v 1.36 2024/12/28 21:26:21 tom Exp $
32 .TH field 3FORM 2024-12-28 "ncurses 6.6" "Library calls"
33 .SH NAME
34 \fBform_field\fP \-
35 make and break connections between fields and forms
36 .SH SYNOPSIS
37 .nf
38 \fB#include <form.h>
39 .PP
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);
44 .fi
45 .SH DESCRIPTION
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
48 .IR NULL "."
49 .PP
50 The function \fBform_fields\fP returns the field array of the given form.
51 .PP
52 The function \fBfield_count\fP returns the count of fields in \fIform\fP.
53 .PP
54 The function \fBmove_field\fP moves the given field (which must be disconnected)
55 to a specified location on the screen.
56 .SH RETURN VALUE
57 The function \fBform_fields\fP returns a pointer (which may be
58 .IR NULL ")."
59 It does not set \fBerrno\fP.
60 .PP
61 The function \fBfield_count\fP returns \fBERR\fP if the \fIform\fP
62 parameter is
63 .IR NULL "."
64 .PP
65 The functions \fBset_form_fields\fP and \fBmove_field\fP return one of
66 the following codes on error:
67 .TP 5
68 .B E_OK
69 The routine succeeded.
70 .TP 5
71 .B E_BAD_ARGUMENT
72 Routine detected an incorrect or out-of-range argument.
73 .TP 5
74 .B E_CONNECTED
75 The field is already connected to a form.
76 .TP 5
77 .B E_POSTED
78 The form is already posted.
79 .TP 5
80 .B E_SYSTEM_ERROR
81 System error occurred (see \fBerrno\fP(3)).
82 .SH PORTABILITY
83 These routines emulate the System V forms library.
84 They were not supported on
85 Version 7 or BSD versions.
86 .PP
87 The SVr4 forms library documentation specifies the \fBfield_count\fP error value
88 as \-1 (which is the value of \fBERR\fP).
89 .SH AUTHORS
90 Juergen Pfeifer.
91 Manual pages and adaptation for new curses by Eric S. Raymond.
92 .SH SEE ALSO
93 \fB\%ncurses\fP(3NCURSES),
94 \fB\%form\fP(3FORM)