doc/html/man/form_field_new.3x.html

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
   2 <!--
   3   * t
   4   ****************************************************************************
   5   * Copyright (c) 1998-2003,2006 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.15 2006/12/24 14:56:41 tom Exp @
  32 -->
  33 <HTML>
  34 <HEAD>
  35 <TITLE>form_field_new 3x</TITLE>
  36 <link rev=made href="mailto:bug-ncurses@gnu.org">
  37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  38 </HEAD>
  39 <BODY>
  40 <H1>form_field_new 3x</H1>
  41 <HR>
  42 <PRE>
  43 <!-- Manpage converted by man2html 3.0.1 -->
  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>
  50 <H2>NAME</H2><PRE>
  51        <STRONG>form_field_new</STRONG> - create and destroy form fields
  52
  53
  54 </PRE>
  55 <H2>SYNOPSIS</H2><PRE>
  56        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
  57        FIELD *new_field(int height, int width,
  58                         int toprow, int leftcol,
  59                         int offscreen, int nbuffers);
  60        FIELD *dup_field(FIELD *field, int toprow, int leftcol);
  61        FIELD *link_field(FIELD *field, int toprow, int leftcol);
  62        int free_field(FIELD *field);
  63
  64
  65 </PRE>
  66 <H2>DESCRIPTION</H2><PRE>
  67        The  function <STRONG>new_field</STRONG> allocates a new field and initial-
  68        izes it from the parameters given: height, width,  row  of
  69        upper-left  corner,  column  of  upper-left corner, number
  70        off-screen rows, and number of additional working buffers.
  71
  72        The  function  <STRONG>dup_field</STRONG> duplicates a field at a new loca-
  73        tion.  Most attributes (including current contents,  size,
  74        validation  type, buffer count, growth threshold, justifi-
  75        cation, foreground, background,  pad  character,  options,
  76        and  user pointer) are copied.  Field status and the field
  77        page bit are not copied.
  78
  79        The function <STRONG>link_field</STRONG> acts like <STRONG>dup_field</STRONG>, but  the  new
  80        field  shares  buffers with its parent.  Attribute data is
  81        separate.
  82
  83        The function <STRONG>free_field</STRONG>  de-allocates  storage  associated
  84        with a field.
  85
  86
  87 </PRE>
  88 <H2>RETURN VALUE</H2><PRE>
  89        The function, <STRONG>new_field</STRONG>, <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG> return <STRONG>NULL</STRONG>
  90        on error.  They set errno according to their success:
  91
  92        <STRONG>E_OK</STRONG> The routine succeeded.
  93
  94        <STRONG>E_BAD_ARGUMENT</STRONG>
  95             Routine detected an incorrect or  out-of-range  argu-
  96             ment.
  97
  98        <STRONG>E_SYSTEM_ERROR</STRONG>
  99             System error occurred, e.g., malloc failure.
 100
 101        The function <STRONG>free_field</STRONG> returns one of the following:
 102
 103        <STRONG>E_OK</STRONG> The routine succeeded.
 104
 105        <STRONG>E_BAD_ARGUMENT</STRONG>
 106             Routine  detected  an incorrect or out-of-range argu-
 107             ment.
 108
 109        <STRONG>E_CONNECTED</STRONG>
 110             field is connected.
 111
 112
 113 </PRE>
 114 <H2>SEE ALSO</H2><PRE>
 115        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
 116
 117
 118 </PRE>
 119 <H2>NOTES</H2><PRE>
 120        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
 121        file <STRONG>&lt;curses.h&gt;</STRONG>.
 122
 123
 124 </PRE>
 125 <H2>PORTABILITY</H2><PRE>
 126        These  routines  emulate the System V forms library.  They
 127        were not supported on Version 7 or BSD versions.
 128
 129        It may be unwise to count on the set of attributes  copied
 130        by  <STRONG>dup_field</STRONG>  being  portable; the System V forms library
 131        documents are not very explicit about what gets copied and
 132        what doesn't.
 133
 134
 135 </PRE>
 136 <H2>AUTHORS</H2><PRE>
 137        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
 138        curses by Eric S. Raymond.
 139
 140
 141
 142                                                      <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
 143 </PRE>
 144 <HR>
 145 <ADDRESS>
 146 Man(1) output converted with
 147 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 148 </ADDRESS>
 149 </BODY>
 150 </HTML>