ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / form_fieldtype.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
5   * Copyright 1998-2006,2010 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_fieldtype.3x,v 1.21 2020/03/28 19:06:28 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>form_fieldtype 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">form_fieldtype 3x</H1>
44 <PRE>
45 <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>                                          <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>form_fieldtype</STRONG> - define validation-field types
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
56        FIELDTYPE *new_fieldtype(
57            bool (* const field_check)(FIELD *, const void *),
58            bool (* const char_check)(int, const void *));
59        int free_fieldtype(FIELDTYPE *fieldtype);
60        int set_fieldtype_arg(
61            FIELDTYPE *fieldtype,
62            void *(* const make_arg)(va_list *),
63            void *(* const copy_arg)(const void *),
64            void  (* const free_arg)(void *));
65        int set_fieldtype_choice(
66            FIELDTYPE *fieldtype,
67            bool (* const next_choice)(FIELD *, const void *),
68            bool (* const prev_choice)(FIELD *, const void *));
69        FIELDTYPE *link_fieldtype(FIELDTYPE *type1,
70                                  FIELDTYPE *type2);
71
72
73 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
74        The  function  <STRONG>new_fieldtype</STRONG>  creates  a new field type usable for data
75        validation.  You supply it with <EM>field</EM><STRONG>_</STRONG><EM>check</EM>, a predicate to  check  the
76        validity  of an entered data string whenever the user attempts to leave
77        a field.  The (FIELD *) argument is passed in so the validation  predi-
78        cate can see the field's buffer, sizes and other attributes; the second
79        argument is an argument-block structure, about which more below.
80
81        You also supply <STRONG>new_fieldtype</STRONG> with <EM>char</EM><STRONG>_</STRONG><EM>check</EM>, a function  to  validate
82        input  characters  as they are entered; it will be passed the character
83        to be checked and a pointer to an argument-block structure.
84
85        The function <STRONG>free_fieldtype</STRONG> frees the space allocated for a given vali-
86        dation type.
87
88        The  function  <STRONG>set_fieldtype_arg</STRONG>  associates  three  storage-management
89        functions with a field type.  The <EM>make</EM><STRONG>_</STRONG><EM>arg</EM>  function  is  automatically
90        applied to the list of arguments you give <STRONG>set_field_type</STRONG> when attaching
91        validation to a field; its job is to bundle  these  into  an  allocated
92        argument-block  object  which  can later be passed to validation predi-
93        cated.  The other two hook arguments should  copy  and  free  argument-
94        block  structures.   They  will  be used by the forms-driver code.  You
95        must supply the <EM>make</EM><STRONG>_</STRONG><EM>arg</EM> function, the other two are optional, you  may
96        supply  NULL  for  them.  In this case it is assumed that <EM>make</EM><STRONG>_</STRONG><EM>arg</EM> does
97        not allocate memory but simply loads the argument into a single  scalar
98        value.
99
100        The function <STRONG>link_fieldtype</STRONG> creates a new field type from the two given
101        types.  They are connected by an logical 'OR'.
102
103        The form driver requests  <STRONG>REQ_NEXT_CHOICE</STRONG>  and  <STRONG>REQ_PREV_CHOICE</STRONG>  assume
104        that  the  possible  values of a field form an ordered set, and provide
105        the forms user with a way to move  through  the  set.   The  <STRONG>set_field-</STRONG>
106        <STRONG>type_choice</STRONG>  function  allows forms programmers to define successor and
107        predecessor functions for the field type.   These  functions  take  the
108        field pointer and an argument-block structure as arguments.
109
110
111 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
112        The  pointer-valued  routines  return  NULL  on  error.  They set <STRONG>errno</STRONG>
113        according to their success:
114
115        <STRONG>E_OK</STRONG> The routine succeeded.
116
117        <STRONG>E_BAD_ARGUMENT</STRONG>
118             Routine detected an incorrect or out-of-range argument.
119
120        <STRONG>E_SYSTEM_ERROR</STRONG>
121             System error occurred, e.g., malloc failure.
122
123        The integer-valued routines return one of the following codes on error:
124
125        <STRONG>E_OK</STRONG> The routine succeeded.
126
127        <STRONG>E_BAD_ARGUMENT</STRONG>
128             Routine detected an incorrect or out-of-range argument.
129
130        <STRONG>E_CONNECTED</STRONG>
131             The field is already connected to a form.
132
133        <STRONG>E_CURRENT</STRONG>
134             The field is the current field.
135
136        <STRONG>E_SYSTEM_ERROR</STRONG>
137             System error occurred (see <STRONG>errno(3)</STRONG>).
138
139
140 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
141        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
142
143
144 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
145        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
146        <STRONG>&lt;curses.h&gt;</STRONG>.
147
148        All  of  the  <STRONG>(char</STRONG>  <STRONG>*)</STRONG> arguments of these functions should actually be
149        <STRONG>(void</STRONG> <STRONG>*)</STRONG>.  The type has been left uncorrected for strict  compatibility
150        with System V.
151
152
153 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
154        These  routines emulate the System V forms library.  They were not sup-
155        ported on Version 7 or BSD versions.
156
157
158 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
159        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
160        Raymond.
161
162
163
164                                                             <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
165 </PRE>
166 <div class="nav">
167 <ul>
168 <li><a href="#h2-NAME">NAME</a></li>
169 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
170 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
171 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
172 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
173 <li><a href="#h2-NOTES">NOTES</a></li>
174 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
175 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
176 </ul>
177 </div>
178 </BODY>
179 </HTML>