ncurses 6.0 - patch 20160326
[ncurses.git] / doc / html / man / form_field.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2010,2012 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.11 2012/11/03 23:03:59 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 http://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
51        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
64        array  of the given <EM>form</EM>.  The array must be terminated by
65        a <STRONG>NULL</STRONG>.
66
67        The function <STRONG>form_fields</STRONG> returns the field  array  of  the
68        given form.
69
70        The  function  <STRONG>field_count</STRONG>  returns the count of fields in
71        <EM>form</EM>.
72
73        The function <STRONG>move_field</STRONG> moves the given field (which  must
74        be disconnected) to a specified location on the screen.
75
76
77 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
78        The  function  <STRONG>form_fields</STRONG> returns a pointer (which may be
79        <STRONG>NULL</STRONG>).  It does not set errno.
80
81        The function <STRONG>field_count</STRONG> returns <STRONG>ERR</STRONG> if the <EM>form</EM> parameter
82        is <STRONG>NULL</STRONG>.
83
84        The functions <STRONG>set_form_fields</STRONG> and <STRONG>move_field</STRONG> return one of
85        the following codes on error:
86
87        <STRONG>E_OK</STRONG> The routine succeeded.
88
89        <STRONG>E_BAD_ARGUMENT</STRONG>
90             Routine detected an incorrect or  out-of-range  argu-
91             ment.
92
93        <STRONG>E_CONNECTED</STRONG>
94             The field is already connected to a form.
95
96        <STRONG>E_POSTED</STRONG>
97             The form is already posted.
98
99        <STRONG>E_SYSTEM_ERROR</STRONG>
100             System error occurred (see <STRONG>errno</STRONG>).
101
102
103 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></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><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
108        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
109        file <STRONG>&lt;curses.h&gt;</STRONG>.
110
111
112 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
113        These routines emulate the System V forms  library.   They
114        were not supported on Version 7 or BSD versions.
115
116        The   SVr4   forms  library  documentation  specifies  the
117        <STRONG>field_count</STRONG> error value as -1 (which is the value of <STRONG>ERR</STRONG>).
118
119
120 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
121        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
122        curses by Eric S. Raymond.
123
124
125
126                                                          <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
127 </PRE>
128 <div class="nav">
129 <ul>
130 <li><a href="#h2-NAME">NAME</a></li>
131 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
132 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
133 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
134 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
135 <li><a href="#h2-NOTES">NOTES</a></li>
136 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
137 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
138 </ul>
139 </div>
140 </BODY>
141 </HTML>