mirror of
https://github.com/Aigor44/ncursesw-morphos.git
synced 2024-12-21 07:39:06 +08:00
52 lines
1.6 KiB
Plaintext
52 lines
1.6 KiB
Plaintext
|
'\" t
|
||
|
|
.TH form_field_info 3X ""
|
||
|
|
.SH NAME
|
||
|
|
\fBform_field_info\fR - retrieve field characteristics
|
||
|
|
.SH SYNOPSIS
|
||
|
|
\fB#include <form.h>\fR
|
||
|
|
.br
|
||
|
|
int field_info(const FIELD *field, int *rows, int *cols,
|
||
|
|
int *frow, int *fcol, int *nrow, int *nbuf);
|
||
|
|
.br
|
||
|
|
int dynamic_field_info(const FIELD *field, int *rows, int *cols, *max);
|
||
|
|
.br
|
||
|
|
.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.
|
||
|
|
|
||
|
|
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).
|
||
|
|
.SH RETURN VALUE
|
||
|
|
These routines return one of the following:
|
||
|
|
.TP 5
|
||
|
|
\fBE_OK\fR
|
||
|
|
The routine succeeded.
|
||
|
|
.TP 5
|
||
|
|
\fBE_SYSTEM_ERROR\fR
|
||
|
|
System error occurred (see \fBerrno\fR).
|
||
|
|
.TP 5
|
||
|
|
\fBE_BAD_ARGUMENT\fR
|
||
|
|
Routine detected an incorrect or out-of-range argument.
|
||
|
|
.SH SEE ALSO
|
||
|
|
\fBcurses\fR(3X) and 3X 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.
|
||
|
|
.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:
|