X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fform_field.3x;h=c9cfbf2e5a65f13cdda455e31f07d9bb87f49fd2;hb=4c9f63c460cb7134f142aa65f6866c175ed77605;hp=113604d689325dedcd15de5320258250e6cd3d96;hpb=47d2fb4537d9ad5bb14f4810561a327930ca4280;p=ncurses.git diff --git a/man/form_field.3x b/man/form_field.3x index 113604d6..c9cfbf2e 100644 --- a/man/form_field.3x +++ b/man/form_field.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 2018-2021,2022 Thomas E. Dickey * .\" Copyright 1998-2010,2012 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,39 +28,39 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field.3x,v 1.14 2020/02/02 23:34:34 tom Exp $ +.\" $Id: form_field.3x,v 1.20 2022/02/12 20:03:40 tom Exp $ .TH form_field 3X "" .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 +\fB#include \fP +.sp +\fBint set_form_fields(FORM *\fIform\fB, FIELD **\fIfields\fB);\fR .br -int set_form_fields(FORM *form, FIELD **fields); +\fBFIELD **form_fields(const FORM *\fIform\fB);\fR .br -FIELD **form_fields(const FORM *form); +\fBint field_count(const FORM *\fIform\fB);\fR .br -int field_count(const FORM *form); -.br -int move_field(FIELD *field, int frow, int fcol); +\fBint move_field(FIELD *\fIfield\fB, int \fIfrow\fB, int \fIfcol\fB);\fR .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. +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\fR returns the field array of the given form. +The function \fBform_fields\fP returns the field array of the given form. .PP -The function \fBfield_count\fR returns the count of fields in \fIform\fR. +The function \fBfield_count\fP returns the count of fields in \fIform\fP. .PP -The function \fBmove_field\fR moves the given field (which must be disconnected) +The function \fBmove_field\fP 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. +The function \fBform_fields\fP returns a pointer (which may be \fBNULL\fP). +It does not set \fBerrno\fP. .PP -The function \fBfield_count\fR returns \fBERR\fR if the \fIform\fP parameter +The function \fBfield_count\fP returns \fBERR\fP if the \fIform\fP parameter is \fBNULL\fP. .PP -The functions \fBset_form_fields\fR and \fBmove_field\fR return one of +The functions \fBset_form_fields\fP and \fBmove_field\fP return one of the following codes on error: .TP 5 .B E_OK @@ -76,19 +76,19 @@ The field is already connected to a form. The form is already posted. .TP 5 .B E_SYSTEM_ERROR -System error occurred (see \fBerrno\fR(3)). +System error occurred (see \fBerrno\fP(3)). .SH SEE ALSO -\fBcurses\fR(3X), \fBform\fR(3X). +\fBcurses\fP(3X), \fBform\fP(3X). .SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +The header file \fB\fP automatically includes the header file +\fB\fP. .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). +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.