3 ****************************************************************************
4 * Copyright (c) 1998-2007,2010 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.18 2010/12/04 18:40: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>
50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>form_field_new</STRONG> - create and destroy form fields
55 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
57 FIELD *new_field(int height, int width,
58 int toprow, int leftcol,
59 int offscreen, int nbuffers);
60 FIELD *dup_field(FIELD *field, int toprow, int leftcol);
61 FIELD *link_field(FIELD *field, int toprow, int leftcol);
62 int free_field(FIELD *field);
66 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
67 The function <STRONG>new_field</STRONG> allocates a new field and initial-
68 izes it from the parameters given: height, width, row of
69 upper-left corner, column of upper-left corner, number
70 off-screen rows, and number of additional working buffers.
72 The function <STRONG>dup_field</STRONG> duplicates a field at a new loca-
73 tion. Most attributes (including current contents, size,
74 validation type, buffer count, growth threshold, justifi-
75 cation, foreground, background, pad character, options,
76 and user pointer) are copied. Field status and the field
77 page bit are not copied.
79 The function <STRONG>link_field</STRONG> acts like <STRONG>dup_field</STRONG>, but the new
80 field shares buffers with its parent. Attribute data is
83 The function <STRONG>free_field</STRONG> de-allocates storage associated
88 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
89 The function, <STRONG>new_field</STRONG>, <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG> return <STRONG>NULL</STRONG>
90 on error. They set errno according to their success:
92 <STRONG>E_OK</STRONG> The routine succeeded.
94 <STRONG>E_BAD_ARGUMENT</STRONG>
95 Routine detected an incorrect or out-of-range argu-
98 <STRONG>E_SYSTEM_ERROR</STRONG>
99 System error occurred, e.g., malloc failure.
101 The function <STRONG>free_field</STRONG> returns one of the following:
103 <STRONG>E_OK</STRONG> The routine succeeded.
105 <STRONG>E_BAD_ARGUMENT</STRONG>
106 Routine detected an incorrect or out-of-range argu-
109 <STRONG>E_CONNECTED</STRONG>
114 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
115 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
119 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
120 The header file <STRONG><form.h></STRONG> automatically includes the header
121 file <STRONG><curses.h></STRONG>.
125 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
126 These routines emulate the System V forms library. They
127 were not supported on Version 7 or BSD versions.
129 It may be unwise to count on the set of attributes copied
130 by <STRONG>dup_field</STRONG> being portable; the System V forms library
131 documents are not very explicit about what gets copied and
136 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
137 Juergen Pfeifer. Manual pages and adaptation for new
138 curses by Eric S. Raymond.
142 <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
146 <li><a href="#h2-NAME">NAME</a></li>
147 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
148 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
149 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
150 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
151 <li><a href="#h2-NOTES">NOTES</a></li>
152 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
153 <li><a href="#h2-AUTHORS">AUTHORS</a></li>