ncurses 5.4
[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,2003 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.6 2003/05/10 20:33:49 jmc 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 <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>NAME</H2><PRE>
51        <STRONG>form_field</STRONG> - make and break connections between fields and
52        forms
53
54
55 </PRE>
56 <H2>SYNOPSIS</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>DESCRIPTION</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>RETURN VALUES</H2><PRE>
82        The function <STRONG>form_fields</STRONG> returns <STRONG>NULL</STRONG> on error.
83
84        The  function  <STRONG>field_count</STRONG> returns <STRONG>ERR</STRONG> (the general <STRONG>curses</STRONG>
85        error return value) on error.
86
87        The functions <STRONG>set_form_fields</STRONG> and <STRONG>move_field</STRONG> return one of
88        the following codes on error:
89
90        <STRONG>E_OK</STRONG> The routine succeeded.
91
92        <STRONG>E_SYSTEM_ERROR</STRONG>
93             System error occurred (see <STRONG>errno</STRONG>).
94
95        <STRONG>E_BAD_ARGUMENT</STRONG>
96             Routine  detected  an incorrect or out-of-range argu-
97             ment.
98
99        <STRONG>E_POSTED</STRONG>
100             The form is already posted.
101
102        <STRONG>E_CONNECTED</STRONG>
103             The field is already connected to a form.
104
105
106 </PRE>
107 <H2>SEE ALSO</H2><PRE>
108        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
109
110
111 </PRE>
112 <H2>NOTES</H2><PRE>
113        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
114        file <STRONG>&lt;curses.h&gt;</STRONG>.
115
116
117 </PRE>
118 <H2>PORTABILITY</H2><PRE>
119        These  routines  emulate the System V forms library.  They
120        were not supported on Version 7 or BSD versions.
121
122        The  SVr4  forms  library  documentation   specifies   the
123        <STRONG>field_count</STRONG> error value as -1 (which is the value of <STRONG>ERR</STRONG>).
124
125
126 </PRE>
127 <H2>AUTHORS</H2><PRE>
128        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
129        curses by Eric S. Raymond.
130
131
132
133                                                    <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
134 </PRE>
135 <HR>
136 <ADDRESS>
137 Man(1) output converted with
138 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
139 </ADDRESS>
140 </BODY>
141 </HTML>