diff options
Diffstat (limited to 'upstream/opensuse-leap-15-6/man3/field.3form')
| -rw-r--r-- | upstream/opensuse-leap-15-6/man3/field.3form | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/upstream/opensuse-leap-15-6/man3/field.3form b/upstream/opensuse-leap-15-6/man3/field.3form new file mode 100644 index 00000000..28989f45 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man3/field.3form @@ -0,0 +1,92 @@ +'\" t +.\"*************************************************************************** +.\" Copyright (c) 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.11 2012/11/03 23:03:59 tom Exp $ +.TH field 3FORM "" +.SH NAME +\fBform_field\fR \- make and break connections between fields and forms +.SH SYNOPSIS +\fB#include <form.h>\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 +.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. +.PP +The function \fBmove_field\fR moves the given field (which must be disconnected) +to a specified location on the screen. +.SH RETURN VALUE +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 +.B E_OK +The routine succeeded. +.TP 5 +.B E_BAD_ARGUMENT +Routine detected an incorrect or out-of-range argument. +.TP 5 +.B E_CONNECTED +The field is already connected to a form. +.TP 5 +.B E_POSTED +The form is already posted. +.TP 5 +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR). +.SH SEE ALSO +\fBncurses\fR(3NCURSES), \fBform\fR(3FORM). +.SH NOTES +The header file \fB<form.h>\fR automatically includes the header file +\fB<curses.h>\fR. +.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). +.SH AUTHORS +Juergen Pfeifer. Manual pages and adaptation for new curses by Eric +S. Raymond. |