3 ****************************************************************************
4 * Copyright 2018-2020,2021 Thomas E. Dickey *
5 * Copyright 1998-2010,2015 Free Software Foundation, Inc. *
7 * Permission is hereby granted, free of charge, to any person obtaining a *
8 * copy of this software and associated documentation files (the *
9 * "Software"), to deal in the Software without restriction, including *
10 * without limitation the rights to use, copy, modify, merge, publish, *
11 * distribute, distribute with modifications, sublicense, and/or sell *
12 * copies of the Software, and to permit persons to whom the Software is *
13 * furnished to do so, subject to the following conditions: *
15 * The above copyright notice and this permission notice shall be included *
16 * in all copies or substantial portions of the Software. *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
21 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
22 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
23 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
24 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
26 * Except as contained in this notice, the name(s) of the above copyright *
27 * holders shall not be used in advertising or otherwise to promote the *
28 * sale, use or other dealings in this Software without prior written *
30 ****************************************************************************
31 * @Id: form_field_new.3x,v 1.26 2021/12/25 21:41:58 tom Exp @
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>form_field_new 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
43 <H1 class="no-header">form_field_new 3x</H1>
45 <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG> <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>new_field</STRONG>, <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG>, <STRONG>free_field</STRONG> - create and destroy form
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
58 <STRONG>FIELD</STRONG> <STRONG>*new_field(int</STRONG> <EM>height</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>width</EM><STRONG>,</STRONG>
59 <STRONG>int</STRONG> <EM>toprow</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>leftcol</EM><STRONG>,</STRONG>
60 <STRONG>int</STRONG> <EM>offscreen</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>nbuffers</EM><STRONG>);</STRONG>
61 <STRONG>FIELD</STRONG> <STRONG>*dup_field(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>toprow</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>leftcol</EM><STRONG>);</STRONG>
62 <STRONG>FIELD</STRONG> <STRONG>*link_field(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>toprow</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>leftcol</EM><STRONG>);</STRONG>
63 <STRONG>int</STRONG> <STRONG>free_field(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG>
66 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
67 The function <STRONG>new_field</STRONG> allocates a new field and initializes it from
68 the parameters given: height, width, row of upper-left corner, column
69 of upper-left corner, number off-screen rows, and number of additional
72 The function <STRONG>dup_field</STRONG> duplicates a field at a new location. Most
73 attributes (including current contents, size, validation type, buffer
74 count, growth threshold, justification, foreground, background, pad
75 character, options, and user pointer) are copied. Field status and the
76 field page bit are not copied.
78 The function <STRONG>link_field</STRONG> acts like <STRONG>dup_field</STRONG>, but the new field shares
79 buffers with its parent. Attribute data is separate.
81 The function <STRONG>free_field</STRONG> de-allocates storage associated with a field.
84 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
85 The functions <STRONG>new_field</STRONG>, <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG> return <STRONG>NULL</STRONG> on error.
86 They set <STRONG>errno</STRONG> according to their success:
88 <STRONG>E_OK</STRONG> The routine succeeded.
90 <STRONG>E_BAD_ARGUMENT</STRONG>
91 Routine detected an incorrect or out-of-range argument.
93 <STRONG>E_SYSTEM_ERROR</STRONG>
94 System error occurred, e.g., malloc failure.
96 The function <STRONG>free_field</STRONG> returns one of the following:
98 <STRONG>E_OK</STRONG> The routine succeeded.
100 <STRONG>E_BAD_ARGUMENT</STRONG>
101 Routine detected an incorrect or out-of-range argument.
103 <STRONG>E_CONNECTED</STRONG>
107 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
108 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
111 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
112 The header file <STRONG><form.h></STRONG> automatically includes the header file
113 <STRONG><curses.h></STRONG>.
116 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
117 These routines emulate the System V forms library. They were not
118 supported on Version 7 or BSD versions.
120 It may be unwise to count on the set of attributes copied by <STRONG>dup_field</STRONG>
121 being portable; the System V forms library documents are not very
122 explicit about what gets copied and what does not.
125 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
126 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
131 <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
135 <li><a href="#h2-NAME">NAME</a></li>
136 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
137 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
138 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
139 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
140 <li><a href="#h2-NOTES">NOTES</a></li>
141 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
142 <li><a href="#h2-AUTHORS">AUTHORS</a></li>