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