| <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> |
| <!-- |
| * t |
| **************************************************************************** |
| * Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * |
| * * |
| * Permission is hereby granted, free of charge, to any person obtaining a * |
| * copy of this software and associated documentation files (the * |
| * "Software"), to deal in the Software without restriction, including * |
| * without limitation the rights to use, copy, modify, merge, publish, * |
| * distribute, distribute with modifications, sublicense, and/or sell * |
| * copies of the Software, and to permit persons to whom the Software is * |
| * furnished to do so, subject to the following conditions: * |
| * * |
| * The above copyright notice and this permission notice shall be included * |
| * in all copies or substantial portions of the Software. * |
| * * |
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * |
| * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * |
| * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * |
| * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * |
| * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * |
| * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * |
| * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * |
| * * |
| * Except as contained in this notice, the name(s) of the above copyright * |
| * holders shall not be used in advertising or otherwise to promote the * |
| * sale, use or other dealings in this Software without prior written * |
| * authorization. * |
| **************************************************************************** |
| * @Id: form_field_new.3x,v 1.16 2007/06/02 20:40:07 tom Exp @ |
| --> |
| <HTML> |
| <HEAD> |
| <TITLE>form_field_new 3x</TITLE> |
| <link rev=made href="mailto:bug-ncurses@gnu.org"> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| </HEAD> |
| <BODY> |
| <H1>form_field_new 3x</H1> |
| <HR> |
| <PRE> |
| <!-- Manpage converted by man2html 3.0.1 --> |
| <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> |
| |
| |
| |
| |
| </PRE> |
| <H2>NAME</H2><PRE> |
| <STRONG>form_field_new</STRONG> - create and destroy form fields |
| |
| |
| </PRE> |
| <H2>SYNOPSIS</H2><PRE> |
| <STRONG>#include</STRONG> <STRONG><form.h></STRONG> |
| FIELD *new_field(int height, int width, |
| int toprow, int leftcol, |
| int offscreen, int nbuffers); |
| FIELD *dup_field(FIELD *field, int toprow, int leftcol); |
| FIELD *link_field(FIELD *field, int toprow, int leftcol); |
| int free_field(FIELD *field); |
| |
| |
| </PRE> |
| <H2>DESCRIPTION</H2><PRE> |
| The function <STRONG>new_field</STRONG> allocates a new field and initial- |
| izes it from the parameters given: height, width, row of |
| upper-left corner, column of upper-left corner, number |
| off-screen rows, and number of additional working buffers. |
| |
| The function <STRONG>dup_field</STRONG> duplicates a field at a new loca- |
| tion. Most attributes (including current contents, size, |
| validation type, buffer count, growth threshold, justifi- |
| cation, foreground, background, pad character, options, |
| and user pointer) are copied. Field status and the field |
| page bit are not copied. |
| |
| The function <STRONG>link_field</STRONG> acts like <STRONG>dup_field</STRONG>, but the new |
| field shares buffers with its parent. Attribute data is |
| separate. |
| |
| The function <STRONG>free_field</STRONG> de-allocates storage associated |
| with a field. |
| |
| |
| </PRE> |
| <H2>RETURN VALUE</H2><PRE> |
| The function, <STRONG>new_field</STRONG>, <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG> return <STRONG>NULL</STRONG> |
| on error. They set errno according to their success: |
| |
| <STRONG>E_OK</STRONG> The routine succeeded. |
| |
| <STRONG>E_BAD_ARGUMENT</STRONG> |
| Routine detected an incorrect or out-of-range argu- |
| ment. |
| |
| <STRONG>E_SYSTEM_ERROR</STRONG> |
| System error occurred, e.g., malloc failure. |
| |
| The function <STRONG>free_field</STRONG> returns one of the following: |
| |
| <STRONG>E_OK</STRONG> The routine succeeded. |
| |
| <STRONG>E_BAD_ARGUMENT</STRONG> |
| Routine detected an incorrect or out-of-range argu- |
| ment. |
| |
| <STRONG>E_CONNECTED</STRONG> |
| field is connected. |
| |
| |
| </PRE> |
| <H2>SEE ALSO</H2><PRE> |
| <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. |
| |
| |
| </PRE> |
| <H2>NOTES</H2><PRE> |
| The header file <STRONG><form.h></STRONG> automatically includes the header |
| file <STRONG><curses.h></STRONG>. |
| |
| |
| </PRE> |
| <H2>PORTABILITY</H2><PRE> |
| These routines emulate the System V forms library. They |
| were not supported on Version 7 or BSD versions. |
| |
| It may be unwise to count on the set of attributes copied |
| by <STRONG>dup_field</STRONG> being portable; the System V forms library |
| documents are not very explicit about what gets copied and |
| what does not. |
| |
| |
| </PRE> |
| <H2>AUTHORS</H2><PRE> |
| Juergen Pfeifer. Manual pages and adaptation for new |
| curses by Eric S. Raymond. |
| |
| |
| |
| <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG> |
| </PRE> |
| <HR> |
| <ADDRESS> |
| Man(1) output converted with |
| <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> |
| </ADDRESS> |
| </BODY> |
| </HTML> |
