54e94e516a737a9d3431135979a52686a013e29d
[ncurses.git] / doc / html / man / form_field_new.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998,2002 Free Software Foundation, Inc.                   *
6   *                                                                          *
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:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
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.                               *
25   *                                                                          *
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       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: form_field_new.3x,v 1.11 2002/02/16 22:39:52 tom Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>form_field_new 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>form_field_new 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>form_field_new</STRONG> - create and destroy form fields
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
53        FIELD *new_field(int height, int width,
54                         int toprow, int leftcol,
55                         int offscreen, int nbuffers);
56        FIELD *dup_field(FIELD *field, int toprow, int leftcol);
57        FIELD *link_field(FIELD *field, int toprow, int leftcol);
58        int free_field(FIELD *field);
59
60
61 </PRE>
62 <H2>DESCRIPTION</H2><PRE>
63        The  function <STRONG>new_field</STRONG> allocates a new field and initial-
64        izes it from the parameters given: height, width,  row  of
65        upper-left  corner,  column  of  upper-left corner, number
66        off-screen rows, and number of additional working buffers.
67
68        The  function  <STRONG>dup_field</STRONG> duplicates a field at a new loca-
69        tion.  Most attributes (including current contents,  size,
70        validation  type, buffer count, growth threshold, justifi-
71        cation, foreground, background,  pad  character,  options,
72        and  user pointer) are copied.  Field status and the field
73        page bit are not copied.
74
75        The function <STRONG>link_field</STRONG> acts like <STRONG>dup_field</STRONG>, but  the  new
76        field  shares  buffers with its parent.  Attribute data is
77        separate.
78
79        The function <STRONG>free_field</STRONG>  de-allocates  storage  associated
80        with a field.
81
82
83 </PRE>
84 <H2>RETURN VALUE</H2><PRE>
85        The function, <STRONG>new_field</STRONG>, <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG> return <STRONG>NULL</STRONG>
86        on error.
87
88        The function <STRONG>free_field</STRONG> returns one of the following:
89
90        <STRONG>E_OK</STRONG> The routine succeeded.
91
92        <STRONG>E_SYSTEM_ERROR</STRONG>
93             System error occurred (see <STRONG>errno</STRONG>).
94
95        <STRONG>E_BAD_ARGUMENT</STRONG>
96             Routine detected an incorrect or  out-of-range  argu-
97             ment.
98
99
100 </PRE>
101 <H2>SEE ALSO</H2><PRE>
102        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
103
104
105 </PRE>
106 <H2>NOTES</H2><PRE>
107        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
108        file <STRONG>&lt;curses.h&gt;</STRONG>.
109
110
111 </PRE>
112 <H2>PORTABILITY</H2><PRE>
113        These routines emulate the System V forms  library.   They
114        were not supported on Version 7 or BSD versions.
115
116        It  may be unwise to count on the set of attributes copied
117        by  <STRONG><A HREF="dup_field.3x.html">dup_field(3x)</A></STRONG>  being  portable;  the  System  V  forms
118        library  documents  are  not  very  explicit  on what gets
119        copied and was not.
120
121
122 </PRE>
123 <H2>AUTHORS</H2><PRE>
124        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
125        curses by Eric S. Raymond.
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168 </PRE>
169 <HR>
170 <ADDRESS>
171 Man(1) output converted with
172 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
173 </ADDRESS>
174 </BODY>
175 </HTML>