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