ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / form_field_new.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright 2018,2020 Thomas E. Dickey                                     *
5   * Copyright 1998-2010,2015 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.22 2020/03/28 19:06:28 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
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">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">form_field_new 3x</H1>
44 <PRE>
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>
46
47
48
49
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
52        fields
53
54
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</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);
63
64
65 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
66        The function <STRONG>new_field</STRONG> allocates a new field and  initializes  it  from
67        the  parameters  given: height, width, row of upper-left corner, column
68        of upper-left corner, number off-screen rows, and number of  additional
69        working buffers.
70
71        The  function  <STRONG>dup_field</STRONG>  duplicates  a  field at a new location.  Most
72        attributes (including current contents, size, validation  type,  buffer
73        count,  growth  threshold,  justification,  foreground, background, pad
74        character, options, and user pointer) are copied.  Field status and the
75        field page bit are not copied.
76
77        The  function  <STRONG>link_field</STRONG> acts like <STRONG>dup_field</STRONG>, but the new field shares
78        buffers with its parent.  Attribute data is separate.
79
80        The function <STRONG>free_field</STRONG> de-allocates storage associated with a field.
81
82
83 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
84        The functions <STRONG>new_field</STRONG>, <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG> return  <STRONG>NULL</STRONG>  on  error.
85        They set <STRONG>errno</STRONG> according to their success:
86
87        <STRONG>E_OK</STRONG> The routine succeeded.
88
89        <STRONG>E_BAD_ARGUMENT</STRONG>
90             Routine detected an incorrect or out-of-range argument.
91
92        <STRONG>E_SYSTEM_ERROR</STRONG>
93             System error occurred, e.g., malloc failure.
94
95        The function <STRONG>free_field</STRONG> returns one of the following:
96
97        <STRONG>E_OK</STRONG> The routine succeeded.
98
99        <STRONG>E_BAD_ARGUMENT</STRONG>
100             Routine detected an incorrect or out-of-range argument.
101
102        <STRONG>E_CONNECTED</STRONG>
103             field is connected.
104
105
106 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
107        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
108
109
110 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
111        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
112        <STRONG>&lt;curses.h&gt;</STRONG>.
113
114
115 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
116        These routines emulate the System V forms library.  They were not  sup-
117        ported on Version 7 or BSD versions.
118
119        It  may be unwise to count on the set of attributes copied by <STRONG>dup_field</STRONG>
120        being portable; the System V  forms  library  documents  are  not  very
121        explicit about what gets copied and what does not.
122
123
124 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
125        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
126        Raymond.
127
128
129
130                                                             <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
131 </PRE>
132 <div class="nav">
133 <ul>
134 <li><a href="#h2-NAME">NAME</a></li>
135 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
136 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
137 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
138 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
139 <li><a href="#h2-NOTES">NOTES</a></li>
140 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
141 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
142 </ul>
143 </div>
144 </BODY>
145 </HTML>