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