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