ncursesw-morphos/doc/html/man/form_field_info.3x.html

130 lines
5.9 KiB
HTML
Raw Normal View History

2002-10-13 11:35:53 +08:00
<!--
* t
****************************************************************************
* Copyright (c) 1998-2010,2015 Free Software Foundation, Inc. *
2002-10-13 11:35:53 +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. *
****************************************************************************
* @Id: form_field_info.3x,v 1.13 2015/12/05 23:01:16 tom Exp @
2002-10-13 11:35:53 +08:00
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
1997-05-15 12:00:00 +08:00
<HTML>
2002-10-13 11:35:53 +08:00
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
2002-10-13 11:35:53 +08:00
<TITLE>form_field_info 3x</TITLE>
<link rev=made href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
1999-10-24 12:32:42 +08:00
<BODY>
<H1 class="no-header">form_field_info 3x</H1>
1997-05-15 12:00:00 +08:00
<PRE>
2005-10-10 02:41:57 +08:00
<STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG> <STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG>
2004-02-09 10:15:26 +08:00
2000-07-09 10:46:08 +08:00
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
<STRONG>dynamic_field_info</STRONG>, <STRONG>field_info</STRONG> - retrieve field character-
istics
1997-05-15 12:00:00 +08:00
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
2002-10-13 11:35:53 +08:00
<STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
1997-05-15 12:00:00 +08:00
int field_info(const FIELD *field, int *rows, int *cols,
int *frow, int *fcol, int *nrow, int *nbuf);
int dynamic_field_info(const FIELD *field, int *rows, int
2002-10-13 11:35:53 +08:00
*cols, int *max);
1997-05-15 12:00:00 +08:00
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
2002-10-13 11:35:53 +08:00
The function <STRONG>field_info</STRONG> returns the sizes and other
attributes passed in to the field at its creation time.
The attributes are: height, width, row of upper-left cor-
ner, column of upper-left corner, number off-screen rows,
1997-05-15 12:00:00 +08:00
and number of working buffers.
2002-10-13 11:35:53 +08:00
The function <STRONG>dynamic_field_info</STRONG> 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
2005-10-10 02:41:57 +08:00
argument will be set to 0. A field can be made dynamic by
turning off the <STRONG>O_STATIC</STRONG> option with <STRONG>field_opts_off</STRONG>.
1997-05-15 12:00:00 +08:00
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
1997-05-15 12:00:00 +08:00
These routines return one of the following:
2002-10-13 11:35:53 +08:00
<STRONG>E_OK</STRONG> The routine succeeded.
1997-05-15 12:00:00 +08:00
2002-10-13 11:35:53 +08:00
<STRONG>E_SYSTEM_ERROR</STRONG>
System error occurred (see <STRONG>errno</STRONG>).
1997-05-15 12:00:00 +08:00
2002-10-13 11:35:53 +08:00
<STRONG>E_BAD_ARGUMENT</STRONG>
Routine detected an incorrect or out-of-range argu-
1997-05-15 12:00:00 +08:00
ment.
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
2002-10-13 11:35:53 +08:00
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
1997-05-15 12:00:00 +08:00
detailed descriptions of the entry points.
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
2002-10-13 11:35:53 +08:00
The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
file <STRONG>&lt;curses.h&gt;</STRONG>.
1997-05-15 12:00:00 +08:00
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
These routines emulate the System V forms library. They
1997-05-15 12:00:00 +08:00
were not supported on Version 7 or BSD versions.
A null (zero pointer) is accepted for any of the return
values, to ignore that value. Not all implementations
2000-07-09 10:46:08 +08:00
allow this, e.g., Solaris 2.7 does not.
1997-05-15 12:00:00 +08:00
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
Juergen Pfeifer. Manual pages and adaptation for new
1997-05-15 12:00:00 +08:00
curses by Eric S. Raymond.
2004-02-09 10:15:26 +08:00
2005-10-10 02:41:57 +08:00
<STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG>
1997-05-15 12:00:00 +08:00
</PRE>
<div class="nav">
<ul>
<li><a href="#h2-NAME">NAME</a></li>
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
<li><a href="#h2-NOTES">NOTES</a></li>
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
<li><a href="#h2-AUTHORS">AUTHORS</a></li>
</ul>
</div>
1997-05-15 12:00:00 +08:00
</BODY>
</HTML>