X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_field.3x;h=01ff576af173db8e4894778ff779f942f3bd4ed6;hp=3e651a5a5d3efaec2af374e0297386eef36485e7;hb=HEAD;hpb=3a9b6a3bf0269231bef7de74757a910dedd04e0c diff --git a/man/form_field.3x b/man/form_field.3x index 3e651a5a..9799d0c0 100644 --- a/man/form_field.3x +++ b/man/form_field.3x @@ -1,68 +1,91 @@ '\" t -.TH form_field 3X "" +.\"*************************************************************************** +.\" Copyright 2018-2023,2024 Thomas E. Dickey * +.\" Copyright 1998-2010,2012 Free Software Foundation, Inc. * +.\" * +.\" Permission is hereby granted, free of charge, to any person obtaining a * +.\" copy of this software and associated documentation files (the * +.\" "Software"), to deal in the Software without restriction, including * +.\" without limitation the rights to use, copy, modify, merge, publish, * +.\" distribute, distribute with modifications, sublicense, and/or sell * +.\" copies of the Software, and to permit persons to whom the Software is * +.\" furnished to do so, subject to the following conditions: * +.\" * +.\" The above copyright notice and this permission notice shall be included * +.\" in all copies or substantial portions of the Software. * +.\" * +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * +.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * +.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * +.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * +.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * +.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * +.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * +.\" * +.\" Except as contained in this notice, the name(s) of the above copyright * +.\" holders shall not be used in advertising or otherwise to promote the * +.\" sale, use or other dealings in this Software without prior written * +.\" authorization. * +.\"*************************************************************************** +.\" +.\" $Id: form_field.3x,v 1.34 2024/03/16 15:35:01 tom Exp $ +.TH form_field 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .SH NAME -\fBform_field\fR - make and break connections between fields and forms +\fBform_field\fP \- +make and break connections between fields and forms .SH SYNOPSIS -\fB#include \fR -.br -int set_form_fields(FORM *form, FIELD **fields); -.br -FIELD **form_fields(const FORM *form); -.br -int field_count(const FORM *form); -.br -int move_field(FIELD *field, int frow, int fcol); -.br +.nf +\fB#include +.PP +\fBint set_form_fields(FORM *\fIform\fP, FIELD **\fIfields\fP); +\fBFIELD **form_fields(const FORM *\fIform\fP); +\fBint field_count(const FORM *\fIform\fP); +\fBint move_field(FIELD *\fIfield\fP, int \fIfrow\fP, int \fIfcol\fP); +.fi .SH DESCRIPTION -The function \fBset_form_fields\fR changes the field pointer array of -the given \fIform\fR. The array must be terminated by a \fBNULL\fR. - -The function \fBform_fields\fR returns the field array of the given form. - -The function \fBfield_count\fR returns the count of fields in \fIform\fR. - -The function \fBmove_field\fR move the given field (which must be disconnected) +The function \fBset_form_fields\fP changes the field pointer array of +the given \fIform\fP. The array must be terminated by a \fBNULL\fP. +.PP +The function \fBform_fields\fP returns the field array of the given form. +.PP +The function \fBfield_count\fP returns the count of fields in \fIform\fP. +.PP +The function \fBmove_field\fP moves the given field (which must be disconnected) to a specified location on the screen. -.SH RETURN VALUES -The function \fBform_fields\fR returns \fBNULL\fR on error. - -The function \fBfield_count\fR returns \fBERR\fR (the general -\fBcurses\fR error return value) on error. - -The functions \fBset_form_fields\fR and \fBmove_field\fR return one of +.SH RETURN VALUE +The function \fBform_fields\fP returns a pointer (which may be \fBNULL\fP). +It does not set \fBerrno\fP. +.PP +The function \fBfield_count\fP returns \fBERR\fP if the \fIform\fP parameter +is \fBNULL\fP. +.PP +The functions \fBset_form_fields\fP and \fBmove_field\fP return one of the following codes on error: .TP 5 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR -System error occurred (see \fBerrno\fR). -.TP 5 -\fBE_BAD_ARGUMENT\fR +.B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. .TP 5 -\fBE_POSTED\fR +.B E_CONNECTED +The field is already connected to a form. +.TP 5 +.B E_POSTED The form is already posted. .TP 5 -\fBE_CONNECTED\fR -The field is already connected to a form. -.SH SEE ALSO -\fBcurses\fR(3X), \fBform\fR(3X). -.SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fP(3)). .SH PORTABILITY -These routines emulate the System V forms library. They were not supported on +These routines emulate the System V forms library. +They were not supported on Version 7 or BSD versions. - -The SVr4 forms library documentation specifies the \fBfield_count\fR error value -as -1 (which is the value of \fBERR\fR). +.PP +The SVr4 forms library documentation specifies the \fBfield_count\fP error value +as \-1 (which is the value of \fBERR\fP). .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X)