By default, no validation is done on form fields. You can associate a
- form with with a fieldtype, making the form library validate input.
+ form with with a fieldtype, making the form library validate input.
- Returns a pointer to the field's argument block. The argumentblock is
+ Returns a pointer to the field's argument block. The argumentblock is
an opaque structure containing a copy of the arguments provided in a
- set_field_type call.
+ set_field_type call.
- Returns a pointer to the fieldtype associated with the form field,
- i.e., by calling set_field_type.
+ Returns a pointer to the fieldtype associated with the form field,
+ i.e., by calling set_field_type.
- The function set_field_type associates a field type with a given form
+ The function set_field_type associates a field type with a given form
field. This is the type checked by validation functions. Most field
types are configurable, via arguments which the caller provides when
- calling set_field_type.
+ calling set_field_type.
Several field types are predefined by the form library.
It is possible to set up new programmer-defined field types. Field
- types are implemented via the FIELDTYPE data structure, which contains
+ types are implemented via the FIELDTYPE data structure, which contains
several pointers to functions.
- See the form_fieldtype(3X) manual page, which describes functions which
+ See the form_fieldtype(3x) manual page, which describes functions which
can be used to construct a field-type dynamically.
The predefined types are as follows:
@@ -105,21 +105,21 @@
TYPE_ALNUM
Alphanumeric data. Required parameter:
- o a third int argument, a minimum field width.
+ o a third int argument, a minimum field width.
TYPE_ALPHA
Character data. Required parameter:
- o a third int argument, a minimum field width.
+ o a third int argument, a minimum field width.
TYPE_ENUM
Accept one of a specified set of strings. Required parameters:
- o a third (char**) argument pointing to a string list;
+ o a third (char**) argument pointing to a string list;
- o a fourth int flag argument to enable case-sensitivity;
+ o a fourth int flag argument to enable case-sensitivity;
- o a fifth int flag argument specifying whether a partial match
+ o a fifth int flag argument specifying whether a partial match
must be a unique one. If this flag is off, a prefix matches
the first of any set of more than one list elements with that
prefix.
@@ -128,49 +128,49 @@
lives in automatic variables on the stack.
TYPE_INTEGER
- Integer data, parsable to an integer by atoi(3). Required
+ Integer data, parsable to an integer by atoi(3). Required
parameters:
- o a third int argument controlling the precision,
+ o a third int argument controlling the precision,
- o a fourth long argument constraining minimum value,
+ o a fourth long argument constraining minimum value,
- o a fifth long constraining maximum value. If the maximum value
+ o a fifth long constraining maximum value. If the maximum value
is less than or equal to the minimum value, the range is
simply ignored.
- On return, the field buffer is formatted according to the printf
+ On return, the field buffer is formatted according to the printf
format specification ".*ld", where the "*" is replaced by the
precision argument.
- For details of the precision handling see printf(3).
+ For details of the precision handling see printf(3).
TYPE_NUMERIC
Numeric data (may have a decimal-point part). Required
parameters:
- o a third int argument controlling the precision,
+ o a third int argument controlling the precision,
- o a fourth double argument constraining minimum value,
+ o a fourth double argument constraining minimum value,
- o and a fifth double constraining maximum value. If your system
+ o and a fifth double constraining maximum value. If your system
supports locales, the decimal point character must be the one
specified by your locale. If the maximum value is less than
or equal to the minimum value, the range is simply ignored.
- On return, the field buffer is formatted according to the printf
+ On return, the field buffer is formatted according to the printf
format specification ".*f", where the "*" is replaced by the
precision argument.
- For details of the precision handling see printf(3).
+ For details of the precision handling see printf(3).
TYPE_REGEXP
Regular expression data. Required parameter:
- o a third argument, a regular expression (char*) string. The
+ o a third argument, a regular expression (char*) string. The
data is valid if the regular expression matches it.
- Regular expressions are in the format of regcomp and regexec.
+ Regular expressions are in the format of regcomp and regexec.
The regular expression must match the whole field. If you have
for example, an eight character wide field, a regular expression
@@ -183,10 +183,10 @@
TYPE_IPV4
An Internet Protocol Version 4 address. Required parameter:
- o none
+ o none
The form library checks whether or not the buffer has the form
- a.b.c.d, where a, b, c, and d are numbers in the range 0 to 255.
+ a.b.c.d, where a, b, c, and d are numbers in the range 0 to 255.
Trailing blanks in the buffer are ignored. The address itself is
not validated.
@@ -195,22 +195,22 @@
- The functions field_type and field_arg return NULL on error. The
- function set_field_type returns one of the following:
+ The functions field_type and field_arg return NULL on error. The
+ function set_field_type returns one of the following:
- E_OK The routine succeeded.
+ E_OK The routine succeeded.
- E_SYSTEM_ERROR
- System error occurred (see errno(3)).
+ E_SYSTEM_ERROR
+ System error occurred (see errno(3)).
- The header file <form.h> automatically includes the header file
- <curses.h>.
+ The header file <form.h> automatically includes the header file
+ <curses.h>.