ncursesw-morphos/man/form_field_info.3x

86 lines
4.0 KiB
Plaintext
Raw Normal View History

1997-05-15 12:00:00 +08:00
'\" t
1999-10-24 12:32:42 +08:00
.\"***************************************************************************
2006-12-18 12:32:42 +08:00
.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. *
1999-10-24 12:32:42 +08:00
.\" *
.\" 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. *
.\"***************************************************************************
.\"
2006-12-18 12:32:42 +08:00
.\" $Id: form_field_info.3x,v 1.10 2006/11/04 17:14:31 tom Exp $
1997-05-15 12:00:00 +08:00
.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
2002-10-13 11:35:53 +08:00
int dynamic_field_info(const FIELD *field, int *rows, int *cols, int *max);
1997-05-15 12:00:00 +08:00
.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.
2005-10-10 02:41:57 +08:00
.PP
1997-05-15 12:00:00 +08:00
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
2005-10-10 02:41:57 +08:00
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.
1997-05-15 12:00:00 +08:00
.SH RETURN VALUE
These routines return one of the following:
.TP 5
2006-12-18 12:32:42 +08:00
.B E_OK
1997-05-15 12:00:00 +08:00
The routine succeeded.
.TP 5
2006-12-18 12:32:42 +08:00
.B E_SYSTEM_ERROR
1997-05-15 12:00:00 +08:00
System error occurred (see \fBerrno\fR).
.TP 5
2006-12-18 12:32:42 +08:00
.B E_BAD_ARGUMENT
1997-05-15 12:00:00 +08:00
Routine detected an incorrect or out-of-range argument.
.SH SEE ALSO
2002-10-13 11:35:53 +08:00
\fBcurses\fR(3X) and related pages whose names begin "form_" for detailed
1997-05-15 12:00:00 +08:00
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.
2000-07-09 10:46:08 +08:00
.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.
1997-05-15 12:00:00 +08:00
.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: