X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_field_info.3x;h=ba2cd884ae8fa759b4799e4c7ba7990947f29a60;hp=bde31285695104c572388a4ff58a9afdd3e4962f;hb=321b81e6b3fa425daddac02420d862100dc3aac8;hpb=027ae42953e3186daed8f3882da73de48291b606 diff --git a/man/form_field_info.3x b/man/form_field_info.3x index bde31285..ba2cd884 100644 --- a/man/form_field_info.3x +++ b/man/form_field_info.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2015,2018 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,10 +27,11 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_info.3x,v 1.10 2006/11/04 17:14:31 tom Exp $ +.\" $Id: form_field_info.3x,v 1.14 2018/07/28 21:34:06 tom Exp $ .TH form_field_info 3X "" .SH NAME -\fBform_field_info\fR - retrieve field characteristics +\fBdynamic_field_info\fP, +\fBfield_info\fR \- retrieve field characteristics .SH SYNOPSIS \fB#include \fR .br @@ -41,12 +42,14 @@ int dynamic_field_info(const FIELD *field, int *rows, int *cols, int *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 +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. @@ -68,18 +71,13 @@ descriptions of the entry points. 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.