3 ****************************************************************************
4 * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
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: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
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. *
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 *
29 ****************************************************************************
30 * @Id: form_fieldtype.3x,v 1.16 2010/12/04 18:40:45 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
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_fieldtype 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">
42 <H1 class="no-header">form_fieldtype 3x</H1>
44 <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>form_fieldtype</STRONG> - define validation-field types
55 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
57 FIELDTYPE *new_fieldtype(
58 bool (* const field_check)(FIELD *, const void *),
59 bool (* const char_check)(int, const void *));
60 int free_fieldtype(FIELDTYPE *fieldtype);
61 int set_fieldtype_arg(
63 void *(* const make_arg)(va_list *),
64 void *(* const copy_arg)(const void *),
65 void (* const free_arg)(void *));
66 int set_fieldtype_choice(
68 bool (* const next_choice)(FIELD *, const void *),
69 bool (* const prev_choice)(FIELD *, const void *));
70 FIELDTYPE *link_fieldtype(FIELDTYPE *type1,
75 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
76 The function <STRONG>new_fieldtype</STRONG> creates a new field type usable
77 for data validation. You supply it with <EM>field</EM><STRONG>_</STRONG><EM>check</EM>, a
78 predicate to check the validity of an entered data string
79 whenever the user attempts to leave a field. The (FIELD
80 *) argument is passed in so the validation predicate can
81 see the field's buffer, sizes and other attributes; the
82 second argument is an argument-block structure, about
85 You also supply <STRONG>new_fieldtype</STRONG> with <EM>char</EM><STRONG>_</STRONG><EM>check</EM>, a function
86 to validate input characters as they are entered; it will
87 be passed the character to be checked and a pointer to an
88 argument-block structure.
90 The function <STRONG>free_fieldtype</STRONG> frees the space allocated for
91 a given validation type.
93 The function <STRONG>set_fieldtype_arg</STRONG> associates three storage-
94 management functions with a field type. The <EM>make</EM><STRONG>_</STRONG><EM>arg</EM>
95 function is automatically applied to the list of arguments
96 you give <STRONG>set_field_type</STRONG> when attaching validation to a
97 field; its job is to bundle these into an allocated argu-
98 ment-block object which can later be passed to validation
99 predicated. The other two hook arguments should copy and
100 free argument-block structures. They will be used by the
101 forms-driver code. You must supply the <EM>make</EM><STRONG>_</STRONG><EM>arg</EM> function,
102 the other two are optional, you may supply NULL for them.
103 In this case it is assumed that <EM>make</EM><STRONG>_</STRONG><EM>arg</EM> does not allocate
104 memory but simply loads the argument into a single scalar
107 The function <STRONG>link_fieldtype</STRONG> creates a new field type from
108 the two given types. They are connected by an logical
111 The form driver requests <STRONG>REQ_NEXT_CHOICE</STRONG> and
112 <STRONG>REQ_PREV_CHOICE</STRONG> assume that the possible values of a field
113 form an ordered set, and provide the forms user with a way
114 to move through the set. The <STRONG>set_fieldtype_choice</STRONG> func-
115 tion allows forms programmers to define successor and pre-
116 decessor functions for the field type. These functions
117 take the field pointer and an argument-block structure as
122 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
123 The pointer-valued routines return NULL on error. They
124 set errno according to their success:
126 <STRONG>E_OK</STRONG> The routine succeeded.
128 <STRONG>E_BAD_ARGUMENT</STRONG>
129 Routine detected an incorrect or out-of-range argu-
132 <STRONG>E_SYSTEM_ERROR</STRONG>
133 System error occurred, e.g., malloc failure.
135 The integer-valued routines return one of the following
138 <STRONG>E_OK</STRONG> The routine succeeded.
140 <STRONG>E_BAD_ARGUMENT</STRONG>
141 Routine detected an incorrect or out-of-range argu-
144 <STRONG>E_CONNECTED</STRONG>
145 The field is already connected to a form.
147 <STRONG>E_CURRENT</STRONG>
148 The field is the current field.
150 <STRONG>E_SYSTEM_ERROR</STRONG>
151 System error occurred (see <STRONG>errno</STRONG>).
155 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
156 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
160 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
161 The header file <STRONG><form.h></STRONG> automatically includes the header
162 file <STRONG><curses.h></STRONG>.
164 All of the <STRONG>(char</STRONG> <STRONG>*)</STRONG> arguments of these functions should
165 actually be <STRONG>(void</STRONG> <STRONG>*)</STRONG>. The type has been left uncorrected
166 for strict compatibility with System V.
170 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
171 These routines emulate the System V forms library. They
172 were not supported on Version 7 or BSD versions.
176 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
177 Juergen Pfeifer. Manual pages and adaptation for new
178 curses by Eric S. Raymond.
182 <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
186 <li><a href="#h2-NAME">NAME</a></li>
187 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
188 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
189 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
190 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
191 <li><a href="#h2-NOTES">NOTES</a></li>
192 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
193 <li><a href="#h2-AUTHORS">AUTHORS</a></li>