35d82339d822688ffa4e21aff17427e04ec69c28
[ncurses.git] / doc / html / man / form_field.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998 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.5 1998/11/29 01:05:52 Rick.Ohnemus Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>form_field 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 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>form_field</STRONG> - make and break connections between fields and
48        forms
49
50
51 </PRE>
52 <H2>SYNOPSIS</H2><PRE>
53        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
54        int set_form_fields(FORM *form, FIELD **fields);
55        FIELD **form_fields(const FORM *form);
56        int field_count(const FORM *form);
57        int move_field(FIELD *field, int frow, int fcol);
58
59
60 </PRE>
61 <H2>DESCRIPTION</H2><PRE>
62        The function <STRONG>set_form_fields</STRONG>  changes  the  field  pointer
63        array  of the given <EM>form</EM>.  The array must be terminated by
64        a <STRONG>NULL</STRONG>.
65
66        The function <STRONG>form_fields</STRONG> returns the field  array  of  the
67        given form.
68
69        The  function  <STRONG>field_count</STRONG>  returns the count of fields in
70        <EM>form</EM>.
71
72        The function <STRONG>move_field</STRONG> move the given field  (which  must
73        be disconnected) to a specified location on the screen.
74
75
76 </PRE>
77 <H2>RETURN VALUES</H2><PRE>
78        The function <STRONG>form_fields</STRONG> returns <STRONG>NULL</STRONG> on error.
79
80        The  function  <STRONG>field_count</STRONG> returns <STRONG>ERR</STRONG> (the general <STRONG>curses</STRONG>
81        error return value) on error.
82
83        The functions <STRONG>set_form_fields</STRONG> and <STRONG>move_field</STRONG> return one of
84        the following codes on error:
85
86        <STRONG>E_OK</STRONG> The routine succeeded.
87
88        <STRONG>E_SYSTEM_ERROR</STRONG>
89             System error occurred (see <STRONG>errno</STRONG>).
90
91        <STRONG>E_BAD_ARGUMENT</STRONG>
92             Routine  detected  an incorrect or out-of-range argu-
93             ment.
94
95        <STRONG>E_POSTED</STRONG>
96             The form is already posted.
97
98        <STRONG>E_CONNECTED</STRONG>
99             The field is already connected to a form.
100
101
102 </PRE>
103 <H2>SEE ALSO</H2><PRE>
104        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
105
106
107 </PRE>
108 <H2>NOTES</H2><PRE>
109        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
110        file <STRONG>&lt;curses.h&gt;</STRONG>.
111
112
113 </PRE>
114 <H2>PORTABILITY</H2><PRE>
115        These  routines  emulate the System V forms library.  They
116        were not supported on Version 7 or BSD versions.
117
118        The  SVr4  forms  library  documentation   specifies   the
119        <STRONG>field_count</STRONG> error value as -1 (which is the value of <STRONG>ERR</STRONG>).
120
121
122 </PRE>
123 <H2>AUTHORS</H2><PRE>
124        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
125        curses by Eric S. Raymond.
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168 </PRE>
169 <HR>
170 <ADDRESS>
171 Man(1) output converted with
172 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
173 </ADDRESS>
174 </BODY>
175 </HTML>