ncurses 5.7 - patch 20090906
[ncurses.git] / man / form_fieldtype.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc.              *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: form_fieldtype.3x,v 1.14 2006/11/04 17:12:00 tom Exp $
31 .TH form_fieldtype 3X ""
32 .SH NAME
33 \fBform_fieldtype\fR - define validation-field types
34 .SH SYNOPSIS
35 \fB#include <form.h>\fR
36 .br
37 FIELDTYPE *new_fieldtype(
38     bool (* const field_check)(FIELD *, const void *),
39     bool (* const char_check)(int, const void *));
40 .br
41 int free_fieldtype(FIELDTYPE *fieldtype);
42 .br
43 int set_fieldtype_arg(
44     FIELDTYPE *fieldtype,
45     void *(* const make_arg)(va_list *),
46     void *(* const copy_arg)(const void *),
47     void  (* const free_arg)(void *));
48 .br
49 int set_fieldtype_choice(
50     FIELDTYPE *fieldtype,
51     bool (* const next_choice)(FIELD *, const void *),
52     bool (* const prev_choice)(FIELD *, const void *));
53 .br
54 FIELDTYPE *link_fieldtype(FIELDTYPE *type1,
55                           FIELDTYPE *type2);
56 .br
57 .SH DESCRIPTION
58 The function \fBnew_fieldtype\fR creates a new field type usable for data
59 validation.  You supply it with \fIfield_check\fR, a predicate to check the
60 validity of an entered data string whenever the user attempts to leave a field.
61 The (FIELD *) argument is passed in so the validation predicate can see the
62 field's buffer, sizes and other attributes; the second argument is an
63 argument-block structure, about which more below.
64 .PP
65 You also supply \fBnew_fieldtype\fR with \fIchar_check\fR,
66 a function to validate input characters as they are entered; it will be passed
67 the character to be checked and a pointer to an argument-block structure.
68 .PP
69 The function \fBfree_fieldtype\fR frees the space allocated for a given
70 validation type.
71 .PP
72 The function \fBset_fieldtype_arg\fR associates three storage-management functions
73 with a field type.
74 The \fImake_arg\fR function is automatically applied to the
75 list of arguments you give \fBset_field_type\fR when attaching validation
76 to a field; its job is to bundle these into an allocated argument-block
77 object which can later be passed to validation predicated.
78 The other two hook arguments should copy and free argument-block structures.
79 They will be used by the forms-driver code.
80 You must supply the \fImake_arg\fR function,
81 the other two are optional, you may supply NULL for them.
82 In this case it is assumed
83 that \fImake_arg\fR does not allocate memory but simply loads the
84 argument into a single scalar value.
85 .PP
86 The function \fBlink_fieldtype\fR creates
87 a new field type from the two given types.
88 They are connected by an logical 'OR'.
89 .PP
90 The form driver requests \fBREQ_NEXT_CHOICE\fR and \fBREQ_PREV_CHOICE\fR assume
91 that the possible values of a field form an ordered set, and provide the forms
92 user with a way to move through the set.
93 The \fBset_fieldtype_choice\fR
94 function allows forms programmers to define successor and predecessor functions
95 for the field type.
96 These functions take the field pointer and an
97 argument-block structure as arguments.
98 .SH RETURN VALUE
99 The pointer-valued routines return NULL on error.
100 They set errno according to their success:
101 .TP 5
102 .B E_OK
103 The routine succeeded.
104 .TP 5
105 .B E_BAD_ARGUMENT
106 Routine detected an incorrect or out-of-range argument.
107 .TP 5
108 .B E_SYSTEM_ERROR
109 System error occurred, e.g., malloc failure.
110 .PP
111 The integer-valued routines return one of the following codes on
112 error:
113 .TP 5
114 .B E_OK
115 The routine succeeded.
116 .TP 5
117 .B E_BAD_ARGUMENT
118 Routine detected an incorrect or out-of-range argument.
119 .TP 5
120 .B E_CONNECTED
121 The field is already connected to a form.
122 .TP 5
123 .B E_CURRENT
124 The field is the current field.
125 .TP 5
126 .B E_SYSTEM_ERROR
127 System error occurred (see \fBerrno\fR).
128 .SH SEE ALSO
129 \fBcurses\fR(3X), \fBform\fR(3X).
130 .SH NOTES
131 The header file \fB<form.h>\fR automatically includes the header file
132 \fB<curses.h>\fR.
133 .PP
134 All of the \fB(char *)\fR arguments of these functions should actually be
135 \fB(void *)\fR.  The type has been left uncorrected for strict compatibility
136 with System V.
137 .SH PORTABILITY
138 These routines emulate the System V forms library.  They were not supported on
139 Version 7 or BSD versions.
140 .SH AUTHORS
141 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
142 S. Raymond.
143 .\"#
144 .\"# The following sets edit modes for GNU EMACS
145 .\"# Local Variables:
146 .\"# mode:nroff
147 .\"# fill-column:79
148 .\"# End: