X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_field.3x;h=20088135000de97b442c095b691998209b8a5cea;hp=3e651a5a5d3efaec2af374e0297386eef36485e7;hb=71c0306f0824ef2b10c4c5813fb003db48f3012e;hpb=3a9b6a3bf0269231bef7de74757a910dedd04e0c diff --git a/man/form_field.3x b/man/form_field.3x index 3e651a5a..20088135 100644 --- a/man/form_field.3x +++ b/man/form_field.3x @@ -1,7 +1,36 @@ '\" t +.\"*************************************************************************** +.\" Copyright (c) 1998-2006,2010 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.9 2010/07/31 16:09:36 tom Exp $ .TH form_field 3X "" .SH NAME -\fBform_field\fR - make and break connections between fields and forms +\fBform_field\fR \- make and break connections between fields and forms .SH SYNOPSIS \fB#include \fR .br @@ -16,36 +45,37 @@ int move_field(FIELD *field, int frow, int fcol); .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. - +.PP The function \fBform_fields\fR returns the field array of the given form. - +.PP 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) +.PP +The function \fBmove_field\fR 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 function \fBform_fields\fR returns a pointer (which may be \fBNULL\fR). +It does not set errno. +.PP +The function \fBfield_count\fR returns \fBERR\fR if the \fIform\fP parameter +is \fBNULL\fP. +.PP The functions \fBset_form_fields\fR and \fBmove_field\fR 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. +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR). .SH SEE ALSO \fBcurses\fR(3X), \fBform\fR(3X). .SH NOTES @@ -54,9 +84,9 @@ The header file \fB\fR automatically includes the header file .SH PORTABILITY These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions. - +.PP The SVr4 forms library documentation specifies the \fBfield_count\fR error value -as -1 (which is the value of \fBERR\fR). +as \-1 (which is the value of \fBERR\fR). .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond.