ncurses 4.1
[ncurses.git] / Ada95 / html / form_field.3x.html
1 <HTML>
2 <BODY BGCOLOR="#99ccbb" TEXT="#000000" LINK="#4060b0" VLINK="#000080" ALINK="#ff4040">
3 <PRE>
4        <STRONG>form_field</STRONG> - make and break connections between fields and
5        forms
6
7
8 </PRE>
9 <H2>SYNOPSIS</H2><PRE>
10        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
11        int set_form_fields(FORM *form, FIELD **fields);
12        FIELD **form_fields(const FORM *form);
13        int field_count(const FORM *form);
14        int move_field(FIELD *field, int frow, int fcol);
15
16
17 </PRE>
18 <H2>DESCRIPTION</H2><PRE>
19        The function <STRONG>set_form_fields</STRONG>  changes  the  field  pointer
20        array  of the given <EM>form</EM>.  The array must be terminated by
21        a <STRONG>NULL</STRONG>.
22
23        The function <STRONG>form_fields</STRONG> returns the field  array  of  the
24        given form.
25
26        The  function  <STRONG>field_count</STRONG>  returns the count of fields in
27        <EM>form</EM>.
28
29        The function <STRONG>move_field</STRONG> move the given field  (which  must
30        be disconnected) to a specified location on the screen.
31
32
33 </PRE>
34 <H2>RETURN VALUES</H2><PRE>
35        The function <STRONG>form_fields</STRONG> returns <STRONG>NULL</STRONG> on error.
36
37        The  function  <STRONG>field_count</STRONG> returns <STRONG>ERR</STRONG> (the general <STRONG>curses</STRONG>
38        error return value) on error.
39
40        The functions <STRONG>set_form_fields</STRONG> and <STRONG>move_field</STRONG> return one of
41        the following codes on error:
42
43        <STRONG>E_OK</STRONG> The routine succeeded.
44
45        <STRONG>E_SYSTEM_ERROR</STRONG>
46             System error occurred (see <STRONG>errno</STRONG>).
47
48        <STRONG>E_BAD_ARGUMENT</STRONG>
49             Routine  detected  an incorrect or out-of-range argu-
50             ment.
51
52        <STRONG>E_POSTED</STRONG>
53             The form is already posted.
54
55        <STRONG>E_CONNECTED</STRONG>
56             The field is already connected to a form.
57
58
59 </PRE>
60 <H2>SEE ALSO</H2><PRE>
61        <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3X)</A></STRONG>.
62
63
64 </PRE>
65 <H2>NOTES</H2><PRE>
66
67
68 </PRE>
69 <H2>PORTABILITY</H2><PRE>
70        These  routines  emulate the System V forms library.  They
71        were not supported on Version 7 or BSD versions.
72
73        The  SVr4  forms  library  documentation   specifies   the
74        <STRONG>field_count</STRONG> error value as -1 (which is the value of <STRONG>ERR</STRONG>).
75
76
77 </PRE>
78 <H2>AUTHORS</H2><PRE>
79        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
80        curses by Eric S. Raymond.
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122 </PRE>
123 </BODY>
124 </HTML>