93 lines
4.3 KiB
Plaintext
93 lines
4.3 KiB
Plaintext
'\" t
|
|
.\"***************************************************************************
|
|
.\" Copyright 2018-2019,2020 Thomas E. Dickey *
|
|
.\" Copyright 1998-2010,2015 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_info.3x,v 1.18 2020/10/17 23:35:05 tom Exp $
|
|
.TH form_field_info 3X ""
|
|
.ie \n(.g .ds `` \(lq
|
|
.el .ds `` ``
|
|
.ie \n(.g .ds '' \(rq
|
|
.el .ds '' ''
|
|
.SH NAME
|
|
\fBdynamic_field_info\fP,
|
|
\fBfield_info\fR \- retrieve field characteristics
|
|
.SH SYNOPSIS
|
|
.nf
|
|
\fB#include <form.h>\fR
|
|
.sp
|
|
\fBint field_info(const FIELD *\fP\fIfield\fP\fB,\fP
|
|
\fBint *\fP\fIrows\fP\fB, int *\fP\fIcols\fP\fB,\fP
|
|
\fBint *\fP\fIfrow\fP\fB, int *\fP\fIfcol\fP\fB,\fP
|
|
\fBint *\fP\fInrow\fP\fB, int *\fP\fInbuf\fB);\fP
|
|
.sp
|
|
\fBint dynamic_field_info(const FIELD *\fP\fIfield\fP\fB,\fP
|
|
\fBint *\fP\fIrows\fP\fB, int *\fP\fIcols\fP\fB, int *\fImax\fB);\fP
|
|
.fi
|
|
.SH DESCRIPTION
|
|
The function \fBfield_info\fR returns the sizes and other attributes passed in
|
|
to the field at its creation time.
|
|
The attributes are: height, width, row of
|
|
upper-left corner, column of upper-left corner, number off-screen rows, and
|
|
number of working buffers.
|
|
.PP
|
|
The function \fBdynamic_field_info\fR returns the actual size of the field, and
|
|
its maximum possible size.
|
|
If the field has no size limit, the location
|
|
addressed by the third argument will be set to 0.
|
|
A field can be made dynamic
|
|
by turning off the \fBO_STATIC\fR option with \fBfield_opts_off\fR.
|
|
.SH RETURN VALUE
|
|
These routines return one of the following:
|
|
.TP 5
|
|
.B E_OK
|
|
The routine succeeded.
|
|
.TP 5
|
|
.B E_SYSTEM_ERROR
|
|
System error occurred (see \fBerrno\fR(3)).
|
|
.TP 5
|
|
.B E_BAD_ARGUMENT
|
|
Routine detected an incorrect or out-of-range argument.
|
|
.SH SEE ALSO
|
|
\fBcurses\fR(3X) and related pages whose names begin \*(``form_\*('' for detailed
|
|
descriptions of the entry points.
|
|
.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
|
|
A null (zero pointer) is accepted for any of the return values,
|
|
to ignore that value.
|
|
Not all implementations allow this, e.g., Solaris 2.7 does not.
|
|
.SH AUTHORS
|
|
Juergen Pfeifer.
|
|
Manual pages and adaptation for new curses by Eric S. Raymond.
|