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

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright (c) 1998-2012,2018 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.12 2018/07/28 21:34:06 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 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><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>form_field</STRONG> - make and break connections between fields and forms
  51
  52
  53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  54        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
  55        int set_form_fields(FORM *form, FIELD **fields);
  56        FIELD **form_fields(const FORM *form);
  57        int field_count(const FORM *form);
  58        int move_field(FIELD *field, int frow, int fcol);
  59
  60
  61 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  62        The  function  <STRONG>set_form_fields</STRONG>  changes  the field pointer array of the
  63        given <EM>form</EM>.  The array must be terminated by a <STRONG>NULL</STRONG>.
  64
  65        The function <STRONG>form_fields</STRONG> returns the field array of the given form.
  66
  67        The function <STRONG>field_count</STRONG> returns the count of fields in <EM>form</EM>.
  68
  69        The function <STRONG>move_field</STRONG> moves the given field (which  must  be  discon-
  70        nected) to a specified location on the screen.
  71
  72
  73 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  74        The  function  <STRONG>form_fields</STRONG>  returns  a pointer (which may be <STRONG>NULL</STRONG>).  It
  75        does not set errno.
  76
  77        The function <STRONG>field_count</STRONG> returns <STRONG>ERR</STRONG> if the <EM>form</EM> parameter is <STRONG>NULL</STRONG>.
  78
  79        The functions <STRONG>set_form_fields</STRONG> and <STRONG>move_field</STRONG> return one of the  follow-
  80        ing codes on error:
  81
  82        <STRONG>E_OK</STRONG> The routine succeeded.
  83
  84        <STRONG>E_BAD_ARGUMENT</STRONG>
  85             Routine detected an incorrect or out-of-range argument.
  86
  87        <STRONG>E_CONNECTED</STRONG>
  88             The field is already connected to a form.
  89
  90        <STRONG>E_POSTED</STRONG>
  91             The form is already posted.
  92
  93        <STRONG>E_SYSTEM_ERROR</STRONG>
  94             System error occurred (see <STRONG>errno</STRONG>).
  95
  96
  97 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  98        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
  99
 100
 101 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 102        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
 103        <STRONG>&lt;curses.h&gt;</STRONG>.
 104
 105
 106 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 107        These routines emulate the System V forms library.  They were not  sup-
 108        ported on Version 7 or BSD versions.
 109
 110        The  SVr4  forms  library documentation specifies the <STRONG>field_count</STRONG> error
 111        value as -1 (which is the value of <STRONG>ERR</STRONG>).
 112
 113
 114 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 115        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
 116        Raymond.
 117
 118
 119
 120                                                                 <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
 121 </PRE>
 122 <div class="nav">
 123 <ul>
 124 <li><a href="#h2-NAME">NAME</a></li>
 125 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 126 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 127 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 128 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 129 <li><a href="#h2-NOTES">NOTES</a></li>
 130 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 131 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 132 </ul>
 133 </div>
 134 </BODY>
 135 </HTML>