1<!-- 2 **************************************************************************** 3 * Copyright 2018-2023,2024 Thomas E. Dickey * 4 * Copyright 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.41 2024/03/16 15:35:01 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 2024-03-16 ncurses 6.5 Library calls</TITLE> 38<link rel="author" href="mailto:bug-ncurses@gnu.org"> 39 40</HEAD> 41<BODY> 42<H1 class="no-header">form_field_new 3x 2024-03-16 ncurses 6.5 Library calls</H1> 43<PRE> 44<STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG> Library calls <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><form.h></STRONG> 56 57 <STRONG>FIELD</STRONG> <STRONG>*new_field(int</STRONG> <EM>height</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>width</EM><STRONG>,</STRONG> 58 <STRONG>int</STRONG> <EM>toprow</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>leftcol</EM><STRONG>,</STRONG> 59 <STRONG>int</STRONG> <EM>offscreen</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>nbuffers</EM><STRONG>);</STRONG> 60 <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> 61 <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> 62 <STRONG>int</STRONG> <STRONG>free_field(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG> 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-PORTABILITY">PORTABILITY</a></H2><PRE> 107 These routines emulate the System V forms library. They were not 108 supported on Version 7 or BSD versions. 109 110 It may be unwise to count on the set of attributes copied by <STRONG>dup_field</STRONG> 111 being portable; the System V forms library documents are not very 112 explicit about what gets copied and what does not. 113 114 115</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE> 116 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. 117 Raymond. 118 119 120</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> 121 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG> 122 123 124 125ncurses 6.5 2024-03-16 <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG> 126</PRE> 127<div class="nav"> 128<ul> 129<li><a href="#h2-NAME">NAME</a></li> 130<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> 131<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> 132<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> 133<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> 134<li><a href="#h2-AUTHORS">AUTHORS</a></li> 135<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> 136</ul> 137</div> 138</BODY> 139</HTML> 140