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

   1 <HTML>
   2 <BODY>
   3 <PRE>
   4 <!-- Manpage converted by man2html 3.0.1 -->
   5
   6 </PRE>
   7 <H2>NAME</H2><PRE>
   8        <B>form_field_new</B> - create and destroy form fields
   9
  10
  11 </PRE>
  12 <H2>SYNOPSIS</H2><PRE>
  13        <B>#include</B> <B>&lt;form.h&gt;</B>
  14        FIELD *new_field(int height, int width,
  15                         int toprow, int leftcol,
  16                         int offscreen, int nbuffers);
  17        FIELD *dup_field(FIELD *field, int toprow, int leftcol);
  18        FIELD *link_field(FIELD *field, int toprow, int leftcol);
  19        int free_field(FIELD *field);
  20
  21
  22 </PRE>
  23 <H2>DESCRIPTION</H2><PRE>
  24        The  function <B>new_field</B> allocates a new field and initial-
  25        izes it from the parameters given: height, width,  row  of
  26        upper-left  corner,  column  of  upper-left corner, number
  27        off-screen rows, and number of additional working buffers.
  28
  29        The  function  <B>dup_field</B> duplicates a field at a new loca-
  30        tion.  Most attributes (including current contents,  size,
  31        validation  type, buffer count, growth threshold, justifi-
  32        cation, foreground, background,  pad  character,  options,
  33        and  user pointer) are copied.  Field status and the field
  34        page bit are not copied.
  35
  36        The function <B>link_field</B> acts like <B>dup_field</B>, but  the  new
  37        field  shares  buffers with its parent.  Attribute data is
  38        separate.
  39
  40        The function <B>free_field</B>  de-allocates  storage  associated
  41        with a field.
  42
  43
  44 </PRE>
  45 <H2>RETURN VALUE</H2><PRE>
  46        The function, <B>new_field</B>, <B>dup_field</B>, <B>link_field</B> return <B>NULL</B>
  47        on error.
  48
  49        The function <B>free_field</B> returns one of the following:
  50
  51        <B>E_OK</B> The routine succeeded.
  52
  53        <B>E_SYSTEM_ERROR</B>
  54             System error occurred (see <B>errno</B>).
  55
  56        <B>E_BAD_ARGUMENT</B>
  57             Routine detected an incorrect or  out-of-range  argu-
  58             ment.
  59
  60
  61 </PRE>
  62 <H2>SEE ALSO</H2><PRE>
  63        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>.
  64
  65
  66 </PRE>
  67 <H2>NOTES</H2><PRE>
  68        The header file <B>&lt;form.h&gt;</B> automatically includes the header
  69        file <B>&lt;curses.h&gt;</B>.
  70
  71
  72 </PRE>
  73 <H2>PORTABILITY</H2><PRE>
  74        These routines emulate the System V forms  library.   They
  75        were not supported on Version 7 or BSD versions.
  76
  77        It  may be unwise to count on the set of attributes copied
  78        by  <B><A HREF="dup_field.3x.html">dup_field(3x)</A></B>  being  portable;  the  System  V  forms
  79        library  documents  are  not  very  explicit  on what gets
  80        copied and was not.
  81
  82
  83 </PRE>
  84 <H2>AUTHORS</H2><PRE>
  85        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
  86        curses by Eric S. Raymond.
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129 </PRE>
 130 <HR>
 131 <ADDRESS>
 132 Man(1) output converted with
 133 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 134 </ADDRESS>
 135 </BODY>
 136 </HTML>