<HTML>
<BODY>
<PRE>
- <STRONG>form_fieldtype</STRONG> - define validation-field types
+<!-- Manpage converted by man2html 3.0.1 -->
+
+</PRE>
+<H2>NAME</H2><PRE>
+ <B>form_fieldtype</B> - define validation-field types
</PRE>
<H2>SYNOPSIS</H2><PRE>
- <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
+ <B>#include</B> <B><form.h></B>
FIELDTYPE *new_fieldtype(
bool (* const field_check)(FIELD *, const void *),
bool (* const char_check)(int, const void *));
</PRE>
<H2>DESCRIPTION</H2><PRE>
- The function <STRONG>new_fieldtype</STRONG> creates a new field type usable
- for data validation. You supply it with <EM>field</EM><STRONG>_</STRONG><EM>check</EM>, a
+ The function <B>new_fieldtype</B> creates a new field type usable
+ for data validation. You supply it with <I>field</I><B>_</B><I>check</I>, a
predicate to check the validity of an entered data string
whenever the user attempt to leave a field. The (FIELD *)
argument is passed in so the validation predicate can see
argument is an argument-block structure, about which more
below.
- You also supply <STRONG>new_fieldtype</STRONG> with <EM>char</EM><STRONG>_</STRONG><EM>check</EM>, a function
+ You also supply <B>new_fieldtype</B> with <I>char</I><B>_</B><I>check</I>, a function
to validate input characters as they are entered; it will
be passed the character to be checked and a pointer to an
argument-block structure.
- The function <STRONG>free_fieldtype</STRONG> frees the space allocated for
+ The function <B>free_fieldtype</B> frees the space allocated for
a given validation type.
- The function <STRONG>set_fieldtype</STRONG> associates three storage-man-
- agement functions with a field type. The <EM>mak</EM><STRONG>_</STRONG><EM>arg</EM> function
+ The function <B>set_fieldtype</B> associates three storage-man-
+ agement functions with a field type. The <I>mak</I><B>_</B><I>arg</I> function
is automatically applied to the list of arguments you give
- <STRONG>set_field_type</STRONG> when attaching validation to a field; its
+ <B>set_field_type</B> when attaching validation to a field; its
job is to bundle these into an allocated argument-block
object which can later be passed to validation predicated.
The other two hook arguments should copy and free argu-
ment-block structures. They will be used by the forms-
- driver code. You must supply the <EM>mak</EM><STRONG>_</STRONG><EM>arg</EM> function, the
+ driver code. You must supply the <I>mak</I><B>_</B><I>arg</I> function, the
other two are optional, you may supply NULL for them. In
- this case it is assumed, that <EM>mak</EM><STRONG>_</STRONG><EM>arg</EM> doesn't allocate
+ this case it is assumed, that <I>mak</I><B>_</B><I>arg</I> doesn't allocate
memory but simply loads the argument into a single scalar
value.
+ The form driver requests <B>REQ_NEXT_CHOICE</B> and
+ <B>REQ_PREV_CHOICE</B> assume that the possible values of a field
form an ordered set, and provide the forms user with a way
- to move through the set. The <STRONG>set_fieldtype_choice</STRONG> func-
+ to move through the set. The <B>set_fieldtype_choice</B> func-
tion allows forms programmers to define successor and pre-
decessor functions for the field type. These functions
take the field pointer and an argument-block structure as
The integer-valued routines return one of the following
codes on error:
- <STRONG>E_OK</STRONG> The routine succeeded.
+ <B>E_OK</B> The routine succeeded.
- <STRONG>E_SYSTEM_ERROR</STRONG>
- System error occurred (see <STRONG>errno</STRONG>).
+ <B>E_SYSTEM_ERROR</B>
+ System error occurred (see <B>errno</B>).
- <STRONG>E_BAD_ARGUMENT</STRONG>
+ <B>E_BAD_ARGUMENT</B>
Routine detected an incorrect or out-of-range argu-
ment.
- <STRONG>E_CONNECTED</STRONG>
+ <B>E_CONNECTED</B>
The field is already connected to a form.
</PRE>
<H2>SEE ALSO</H2><PRE>
- <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3X)</A></STRONG>.
+ <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>.
</PRE>
<H2>NOTES</H2><PRE>
- The header file <STRONG><form.h></STRONG> automatically includes the header
- file <STRONG><curses.h></STRONG>.
+ The header file <B><form.h></B> automatically includes the header
+ file <B><curses.h></B>.
- All of the <STRONG>(char</STRONG> <STRONG>*)</STRONG> arguments of these functions should
- actually be <STRONG>(void</STRONG> <STRONG>*)</STRONG>. The type has been left uncorrected
+ All of the <B>(char</B> <B>*)</B> arguments of these functions should
+ actually be <B>(void</B> <B>*)</B>. The type has been left uncorrected
for strict compatibility with System V.
+
</PRE>
+<HR>
+<ADDRESS>
+Man(1) output converted with
+<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
+</ADDRESS>
</BODY>
</HTML>
projects / ncurses.git / blobdiff