X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_field_info.3x;h=556c45ba22d559336dfb5c24c496dbde9b0bb1a2;hp=4df607c8b87bb6747b741ed91ccffd4290f7cb2d;hb=fae162795e065e5901068152e91f2962b6b247f3;hpb=71c0306f0824ef2b10c4c5813fb003db48f3012e diff --git a/man/form_field_info.3x b/man/form_field_info.3x index 4df607c8..556c45ba 100644 --- a/man/form_field_info.3x +++ b/man/form_field_info.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * +.\" 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 * @@ -27,26 +28,37 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_info.3x,v 1.11 2010/07/31 16:09:36 tom Exp $ +.\" $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 -\fBform_field_info\fR \- retrieve field characteristics +\fBdynamic_field_info\fP, +\fBfield_info\fR \- retrieve field characteristics .SH SYNOPSIS +.nf \fB#include \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, int *max); -.br +.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 +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 +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. @@ -57,29 +69,24 @@ These routines return one of the following: The routine succeeded. .TP 5 .B E_SYSTEM_ERROR -System error occurred (see \fBerrno\fR). +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 +\fBcurses\fR(3X) and related pages whose names begin \*(``form_\*('' for detailed descriptions of the entry points. .SH NOTES The header file \fB\fR automatically includes the header file \fB\fR. .SH PORTABILITY -These routines emulate the System V forms library. They were not supported on +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. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.