ncurses 6.0 - patch 20151205
[ncurses.git] / doc / html / man / form_field_new.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
5   *                                                                          *
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:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
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.                               *
24   *                                                                          *
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       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: form_field_new.3x,v 1.19 2015/12/05 23:42:45 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
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">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">form_field_new 3x</H1>
43 <PRE>
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>
45
46
47
48
49 </PRE>
50 <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
52        destroy form fields
53
54
55 </PRE>
56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
57        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
58        FIELD *new_field(int height, int width,
59                         int toprow, int leftcol,
60                         int offscreen, int nbuffers);
61        FIELD *dup_field(FIELD *field, int toprow, int leftcol);
62        FIELD *link_field(FIELD *field, int toprow, int leftcol);
63        int free_field(FIELD *field);
64
65
66 </PRE>
67 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
68        The function <STRONG>new_field</STRONG> allocates a new field and  initial-
69        izes  it  from the parameters given: height, width, row of
70        upper-left corner, column  of  upper-left  corner,  number
71        off-screen rows, and number of additional working buffers.
72
73        The  function  <STRONG>dup_field</STRONG> duplicates a field at a new loca-
74        tion.  Most attributes (including current contents,  size,
75        validation  type, buffer count, growth threshold, justifi-
76        cation, foreground, background,  pad  character,  options,
77        and  user pointer) are copied.  Field status and the field
78        page bit are not copied.
79
80        The function <STRONG>link_field</STRONG> acts like <STRONG>dup_field</STRONG>, but  the  new
81        field  shares  buffers with its parent.  Attribute data is
82        separate.
83
84        The function <STRONG>free_field</STRONG>  de-allocates  storage  associated
85        with a field.
86
87
88 </PRE>
89 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
90        The function, <STRONG>new_field</STRONG>, <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG> return <STRONG>NULL</STRONG>
91        on error.  They set errno according to their success:
92
93        <STRONG>E_OK</STRONG> The routine succeeded.
94
95        <STRONG>E_BAD_ARGUMENT</STRONG>
96             Routine detected an incorrect or  out-of-range  argu-
97             ment.
98
99        <STRONG>E_SYSTEM_ERROR</STRONG>
100             System error occurred, e.g., malloc failure.
101
102        The function <STRONG>free_field</STRONG> returns one of the following:
103
104        <STRONG>E_OK</STRONG> The routine succeeded.
105
106        <STRONG>E_BAD_ARGUMENT</STRONG>
107             Routine  detected  an incorrect or out-of-range argu-
108             ment.
109
110        <STRONG>E_CONNECTED</STRONG>
111             field is connected.
112
113
114 </PRE>
115 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
116        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
117
118
119 </PRE>
120 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
121        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
122        file <STRONG>&lt;curses.h&gt;</STRONG>.
123
124
125 </PRE>
126 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
127        These  routines  emulate the System V forms library.  They
128        were not supported on Version 7 or BSD versions.
129
130        It may be unwise to count on the set of attributes  copied
131        by  <STRONG>dup_field</STRONG>  being  portable; the System V forms library
132        documents are not very explicit about what gets copied and
133        what does not.
134
135
136 </PRE>
137 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
138        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
139        curses by Eric S. Raymond.
140
141
142
143                                                      <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
144 </PRE>
145 <div class="nav">
146 <ul>
147 <li><a href="#h2-NAME">NAME</a></li>
148 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
149 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
150 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
151 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
152 <li><a href="#h2-NOTES">NOTES</a></li>
153 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
154 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
155 </ul>
156 </div>
157 </BODY>
158 </HTML>