doc/html/man/form_field.3x.html

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright (c) 1998-2010,2012 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.3x,v 1.11 2012/11/03 23:03:59 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 http://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>form_field 3x</TITLE>
  38 <link rev=made href="mailto:bug-ncurses@gnu.org">
  39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">form_field 3x</H1>
  43 <PRE>
  44 <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>                                           <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE>
  50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>form_field</STRONG> - make and break connections between fields and
  52        forms
  53
  54
  55 </PRE>
  56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  57        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
  58        int set_form_fields(FORM *form, FIELD **fields);
  59        FIELD **form_fields(const FORM *form);
  60        int field_count(const FORM *form);
  61        int move_field(FIELD *field, int frow, int fcol);
  62
  63
  64 </PRE>
  65 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  66        The function <STRONG>set_form_fields</STRONG>  changes  the  field  pointer
  67        array  of the given <EM>form</EM>.  The array must be terminated by
  68        a <STRONG>NULL</STRONG>.
  69
  70        The function <STRONG>form_fields</STRONG> returns the field  array  of  the
  71        given form.
  72
  73        The  function  <STRONG>field_count</STRONG>  returns the count of fields in
  74        <EM>form</EM>.
  75
  76        The function <STRONG>move_field</STRONG> moves the given field (which  must
  77        be disconnected) to a specified location on the screen.
  78
  79
  80 </PRE>
  81 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  82        The  function  <STRONG>form_fields</STRONG> returns a pointer (which may be
  83        <STRONG>NULL</STRONG>).  It does not set errno.
  84
  85        The function <STRONG>field_count</STRONG> returns <STRONG>ERR</STRONG> if the <EM>form</EM> parameter
  86        is <STRONG>NULL</STRONG>.
  87
  88        The functions <STRONG>set_form_fields</STRONG> and <STRONG>move_field</STRONG> return one of
  89        the following codes on error:
  90
  91        <STRONG>E_OK</STRONG> The routine succeeded.
  92
  93        <STRONG>E_BAD_ARGUMENT</STRONG>
  94             Routine detected an incorrect or  out-of-range  argu-
  95             ment.
  96
  97        <STRONG>E_CONNECTED</STRONG>
  98             The field is already connected to a form.
  99
 100        <STRONG>E_POSTED</STRONG>
 101             The form is already posted.
 102
 103        <STRONG>E_SYSTEM_ERROR</STRONG>
 104             System error occurred (see <STRONG>errno</STRONG>).
 105
 106
 107 </PRE>
 108 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 109        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
 110
 111
 112 </PRE>
 113 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 114        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
 115        file <STRONG>&lt;curses.h&gt;</STRONG>.
 116
 117
 118 </PRE>
 119 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 120        These routines emulate the System V forms  library.   They
 121        were not supported on Version 7 or BSD versions.
 122
 123        The   SVr4   forms  library  documentation  specifies  the
 124        <STRONG>field_count</STRONG> error value as -1 (which is the value of <STRONG>ERR</STRONG>).
 125
 126
 127 </PRE>
 128 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 129        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
 130        curses by Eric S. Raymond.
 131
 132
 133
 134                                                          <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
 135 </PRE>
 136 <div class="nav">
 137 <ul>
 138 <li><a href="#h2-NAME">NAME</a></li>
 139 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 140 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 141 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 142 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 143 <li><a href="#h2-NOTES">NOTES</a></li>
 144 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 145 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 146 </ul>
 147 </div>
 148 </BODY>
 149 </HTML>