-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
* t
****************************************************************************
- * Copyright (c) 1998,2000,2001 Free Software Foundation, Inc. *
+ * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: form_fieldtype.3x,v 1.9 2001/08/04 20:36:25 William.Setzer Exp @
+ * @Id: form_fieldtype.3x,v 1.16 2010/12/04 18:40:45 tom Exp @
-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
+<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
<TITLE>form_fieldtype 3x</TITLE>
<link rev=made href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<H1>form_fieldtype 3x</H1>
<HR>
<PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
+
+
+
</PRE>
+<H2>
<a name="h2-NAME">NAME</a></H2><PRE>
<STRONG>form_fieldtype</STRONG> - define validation-field types
</PRE>
+<H2>
<a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
FIELDTYPE *new_fieldtype(
bool (* const field_check)(FIELD *, const void *),
</PRE>
-<H2>
DESCRIPTION</H2><PRE>
+<H2>
<a name="h2-DESCRIPTION">DESCRIPTION</a></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
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
- the field's buffer, sizes and other attributes; the second
- argument is an argument-block structure, about which more
- below.
+ whenever the user attempts to leave a field. The (FIELD
+ *) argument is passed in so the validation predicate can
+ see the field's buffer, sizes and other attributes; the
+ second 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
to validate input characters as they are entered; it will
The function <STRONG>free_fieldtype</STRONG> 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
- is automatically applied to the list of arguments you give
- <STRONG>set_field_type</STRONG> 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
- 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
+ The function <STRONG>set_fieldtype_arg</STRONG> associates three storage-
+ management functions with a field type. The <EM>make</EM><STRONG>_</STRONG><EM>arg</EM>
+ function is automatically applied to the list of arguments
+ you give <STRONG>set_field_type</STRONG> when attaching validation to a
+ field; its job is to bundle these into an allocated argu-
+ ment-block object which can later be passed to validation
+ predicated. The other two hook arguments should copy and
+ free argument-block structures. They will be used by the
+ forms-driver code. You must supply the <EM>make</EM><STRONG>_</STRONG><EM>arg</EM> function,
+ the other two are optional, you may supply NULL for them.
+ In this case it is assumed that <EM>make</EM><STRONG>_</STRONG><EM>arg</EM> does not allocate
memory but simply loads the argument into a single scalar
value.
+ The function <STRONG>link_fieldtype</STRONG> creates a new field type from
+ the two given types. They are connected by an logical
+ 'OR'.
+
The form driver requests <STRONG>REQ_NEXT_CHOICE</STRONG> and
<STRONG>REQ_PREV_CHOICE</STRONG> assume that the possible values of a field
form an ordered set, and provide the forms user with a way
</PRE>
-<H2>RETURN VALUE</H2><PRE>
- The pointer-valued routines return NULL on error.
+<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+ The pointer-valued routines return NULL on error. They
+ set errno according to their success:
+
+ <STRONG>E_OK</STRONG> The routine succeeded.
+
+ <STRONG>E_BAD_ARGUMENT</STRONG>
+ Routine detected an incorrect or out-of-range argu-
+ ment.
+
+ <STRONG>E_SYSTEM_ERROR</STRONG>
+ System error occurred, e.g., malloc failure.
The integer-valued routines return one of the following
codes on error:
<STRONG>E_OK</STRONG> The routine succeeded.
- <STRONG>E_SYSTEM_ERROR</STRONG>
- System error occurred (see <STRONG>errno</STRONG>).
-
<STRONG>E_BAD_ARGUMENT</STRONG>
Routine detected an incorrect or out-of-range argu-
ment.
<STRONG>E_CONNECTED</STRONG>
The field is already connected to a form.
+ <STRONG>E_CURRENT</STRONG>
+ The field is the current field.
+
+ <STRONG>E_SYSTEM_ERROR</STRONG>
+ System error occurred (see <STRONG>errno</STRONG>).
+
</PRE>
+<H2>
<a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
</PRE>
+<H2>
<a name="h2-NOTES">NOTES</a></H2><PRE>
The header file <STRONG><form.h></STRONG> automatically includes the header
file <STRONG><curses.h></STRONG>.
</PRE>
-<H2>
PORTABILITY</H2><PRE>
+<H2>
<a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
These routines emulate the System V forms library. They
were not supported on Version 7 or BSD versions.
</PRE>
+<H2>
<a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
Juergen Pfeifer. Manual pages and adaptation for new
curses by Eric S. Raymond.
-
-
-
-
-
-
-
+ <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
</PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+<li><a href="#h2-NOTES">NOTES</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-AUTHORS">AUTHORS</a></li>
+</ul>
+</div>
</BODY>
</HTML>
projects / ncurses.git / blobdiff