3 ****************************************************************************
4 * Copyright (c) 1998-2010,2015 Free Software Foundation, Inc. *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
29 ****************************************************************************
30 * @Id: form_field_new.3x,v 1.19 2015/12/05 23:42:45 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>form_field_new 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 <H1 class="no-header">form_field_new 3x</H1>
44 <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>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>new_field</STRONG>, <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG>, <STRONG>free_field</STRONG> - create and
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
56 FIELD *new_field(int height, int width,
57 int toprow, int leftcol,
58 int offscreen, int nbuffers);
59 FIELD *dup_field(FIELD *field, int toprow, int leftcol);
60 FIELD *link_field(FIELD *field, int toprow, int leftcol);
61 int free_field(FIELD *field);
64 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
65 The function <STRONG>new_field</STRONG> allocates a new field and initial-
66 izes it from the parameters given: height, width, row of
67 upper-left corner, column of upper-left corner, number
68 off-screen rows, and number of additional working buffers.
70 The function <STRONG>dup_field</STRONG> duplicates a field at a new loca-
71 tion. Most attributes (including current contents, size,
72 validation type, buffer count, growth threshold, justifi-
73 cation, foreground, background, pad character, options,
74 and user pointer) are copied. Field status and the field
75 page bit are not copied.
77 The function <STRONG>link_field</STRONG> acts like <STRONG>dup_field</STRONG>, but the new
78 field shares buffers with its parent. Attribute data is
81 The function <STRONG>free_field</STRONG> de-allocates storage associated
85 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
86 The function, <STRONG>new_field</STRONG>, <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG> return <STRONG>NULL</STRONG>
87 on error. They set errno according to their success:
89 <STRONG>E_OK</STRONG> The routine succeeded.
91 <STRONG>E_BAD_ARGUMENT</STRONG>
92 Routine detected an incorrect or out-of-range argu-
95 <STRONG>E_SYSTEM_ERROR</STRONG>
96 System error occurred, e.g., malloc failure.
98 The function <STRONG>free_field</STRONG> returns one of the following:
100 <STRONG>E_OK</STRONG> The routine succeeded.
102 <STRONG>E_BAD_ARGUMENT</STRONG>
103 Routine detected an incorrect or out-of-range argu-
106 <STRONG>E_CONNECTED</STRONG>
110 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
111 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
114 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
115 The header file <STRONG><form.h></STRONG> automatically includes the header
116 file <STRONG><curses.h></STRONG>.
119 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
120 These routines emulate the System V forms library. They
121 were not supported on Version 7 or BSD versions.
123 It may be unwise to count on the set of attributes copied
124 by <STRONG>dup_field</STRONG> being portable; the System V forms library
125 documents are not very explicit about what gets copied and
129 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
130 Juergen Pfeifer. Manual pages and adaptation for new
131 curses by Eric S. Raymond.
135 <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
139 <li><a href="#h2-NAME">NAME</a></li>
140 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
141 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
142 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
143 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
144 <li><a href="#h2-NOTES">NOTES</a></li>
145 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
146 <li><a href="#h2-AUTHORS">AUTHORS</a></li>