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