<!--
* t
****************************************************************************
- * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. *
+ * Copyright (c) 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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: form_field_new.3x,v 1.18 2010/12/04 18:40:45 tom Exp @
+ * @Id: form_field_new.3x,v 1.19 2015/12/05 23:42:45 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
-</PRE>
-<H2><a name="h2-NAME">NAME</a></H2><PRE>
- <STRONG>form_field_new</STRONG> - create and destroy form fields
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
+ <STRONG>new_field</STRONG>, <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG>, <STRONG>free_field</STRONG> - create and
+ destroy form fields
-</PRE>
-<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
FIELD *new_field(int height, int width,
int toprow, int leftcol,
int free_field(FIELD *field);
-</PRE>
-<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
- The function <STRONG>new_field</STRONG> allocates a new field and initial-
- izes it from the parameters given: height, width, row of
- upper-left corner, column of upper-left corner, number
+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
+ The function <STRONG>new_field</STRONG> allocates a new field and initial-
+ izes it from the parameters given: height, width, row of
+ upper-left corner, column of upper-left corner, number
off-screen rows, and number of additional working buffers.
- The function <STRONG>dup_field</STRONG> duplicates a field at a new loca-
- tion. Most attributes (including current contents, size,
- validation type, buffer count, growth threshold, justifi-
- cation, foreground, background, pad character, options,
- and user pointer) are copied. Field status and the field
+ The function <STRONG>dup_field</STRONG> duplicates a field at a new loca-
+ tion. Most attributes (including current contents, size,
+ validation type, buffer count, growth threshold, justifi-
+ cation, foreground, background, pad character, options,
+ and user pointer) are copied. Field status and the field
page bit are not copied.
- The function <STRONG>link_field</STRONG> acts like <STRONG>dup_field</STRONG>, but the new
- field shares buffers with its parent. Attribute data is
+ The function <STRONG>link_field</STRONG> acts like <STRONG>dup_field</STRONG>, but the new
+ field shares buffers with its parent. Attribute data is
separate.
- The function <STRONG>free_field</STRONG> de-allocates storage associated
+ The function <STRONG>free_field</STRONG> de-allocates storage associated
with a field.
-</PRE>
-<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
The function, <STRONG>new_field</STRONG>, <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG> return <STRONG>NULL</STRONG>
on error. They set errno according to their success:
<STRONG>E_OK</STRONG> The routine succeeded.
<STRONG>E_BAD_ARGUMENT</STRONG>
- Routine detected an incorrect or out-of-range argu-
+ Routine detected an incorrect or out-of-range argu-
ment.
<STRONG>E_SYSTEM_ERROR</STRONG>
<STRONG>E_OK</STRONG> The routine succeeded.
<STRONG>E_BAD_ARGUMENT</STRONG>
- Routine detected an incorrect or out-of-range argu-
+ Routine detected an incorrect or out-of-range argu-
ment.
<STRONG>E_CONNECTED</STRONG>
field is connected.
-</PRE>
-<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
-</PRE>
-<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
The header file <STRONG><form.h></STRONG> automatically includes the header
file <STRONG><curses.h></STRONG>.
-</PRE>
-<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- These routines emulate the System V forms library. They
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+ These routines emulate the System V forms library. They
were not supported on Version 7 or BSD versions.
- It may be unwise to count on the set of attributes copied
- by <STRONG>dup_field</STRONG> being portable; the System V forms library
+ It may be unwise to count on the set of attributes copied
+ by <STRONG>dup_field</STRONG> being portable; the System V forms library
documents are not very explicit about what gets copied and
what does not.
-</PRE>
-<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
- Juergen Pfeifer. Manual pages and adaptation for new
+</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
+ Juergen Pfeifer. Manual pages and adaptation for new
curses by Eric S. Raymond.
projects / ncurses.git / blobdiff