.\"***************************************************************************
-.\" Copyright 2018-2019,2020 Thomas E. Dickey *
+.\" Copyright 2018-2020,2021 Thomas E. Dickey *
.\" Copyright 1998-2010,2017 Free Software Foundation, Inc. *
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: form_field_validation.3x,v 1.33 2020/12/12 19:57:55 tom Exp $
+.\" $Id: form_field_validation.3x,v 1.35 2021/12/25 21:49:32 tom Exp $
.TH form_field_validation 3X ""
.ie \n(.g .ds `` \(lq
.el .ds `` ``
.el .IP \(bu 2
..
.SH NAME
-\fBform_field_validation\fR \- data type validation for fields
+\fBform_field_validation\fP \- data type validation for fields
.SH SYNOPSIS
-\fB#include <form.h>\fR
+\fB#include <form.h>\fP
.sp
\fBvoid *field_arg(const FIELD *\fP\fIfield\fP\fB);\fP
.br
Returns a pointer to the \fIfield type\fP associated with the form field,
i.e., by calling \fBset_field_type\fP.
.SS set_field_type
-The function \fBset_field_type\fR associates
+The function \fBset_field_type\fP associates
a field type with a given form field.
This is the type checked by validation functions.
Most field types are configurable,
Field types are implemented via the \fBFIELDTYPE\fP data
structure, which contains several pointers to functions.
.PP
-See the \fBform_fieldtype\fR(3X) manual page,
+See the \fBform_fieldtype\fP(3X) manual page,
which describes functions which can be used to construct
a field-type dynamically.
.PP
Required parameter:
.RS
.bP
-a third \fBint\fR argument, a minimum field width.
+a third \fBint\fP argument, a minimum field width.
.RE
.TP 5
TYPE_ALPHA
Required parameter:
.RS
.bP
-a third \fBint\fR argument, a minimum field width.
+a third \fBint\fP argument, a minimum field width.
.RE
.TP 5
TYPE_ENUM
Required parameters:
.RS
.bP
-a third \fB(char **)\fR argument pointing to a string list;
+a third \fB(char **)\fP argument pointing to a string list;
.bP
-a fourth \fBint\fR flag argument to enable case-sensitivity;
+a fourth \fBint\fP flag argument to enable case-sensitivity;
.bP
-a fifth \fBint\fR flag argument specifying whether a partial
+a fifth \fBint\fP 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.
Required parameters:
.RS
.bP
-a third \fBint\fR argument controlling the precision,
+a third \fBint\fP argument controlling the precision,
.bP
-a fourth \fBlong\fR argument constraining minimum value,
+a fourth \fBlong\fP argument constraining minimum value,
.bP
-a fifth \fBlong\fR constraining maximum value.
+a fifth \fBlong\fP constraining maximum value.
If the maximum value is less than or equal to the minimum value, the range is
simply ignored.
.RE
.IP
On return, the field buffer is formatted according to the
-\fBprintf\fR format specification \*(``.*ld\*('',
+\fBprintf\fP format specification \*(``.*ld\*('',
where the \*(``*\*('' is replaced by the precision argument.
.IP
-For details of the precision handling see \fBprintf\fR(3).
+For details of the precision handling see \fBprintf\fP(3).
.TP 5
TYPE_NUMERIC
Numeric data (may have a decimal-point part).
Required parameters:
.RS
.bP
-a third \fBint\fR argument controlling the precision,
+a third \fBint\fP argument controlling the precision,
.bP
-a fourth \fBdouble\fR argument constraining minimum value,
+a fourth \fBdouble\fP argument constraining minimum value,
.bP
-and a fifth \fBdouble\fR constraining maximum value.
+and a fifth \fBdouble\fP 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,
.RE
.IP
On return, the field buffer is formatted according to the
-\fBprintf\fR format specification \*(``.*f\*('',
+\fBprintf\fP format specification \*(``.*f\*('',
where the \*(``*\*('' is replaced by the precision argument.
.IP
-For details of the precision handling see \fBprintf\fR(3).
+For details of the precision handling see \fBprintf\fP(3).
.TP 5
TYPE_REGEXP
Regular expression data.
Required parameter:
.RS
.bP
-a third argument, a regular expression \fB(char *)\fR string.
+a third argument, a regular expression \fB(char *)\fP string.
The data is valid if the regular expression matches it.
.RE
.IP
Regular expressions
-are in the format of \fBregcomp\fR and \fBregexec\fR.
+are in the format of \fBregcomp\fP and \fBregexec\fP.
.IP
The regular expression must match the whole field.
If you have for example, an eight character wide field,
This is an ncurses extension;
this field type may not be available in other curses implementations.
.SH RETURN VALUE
-The functions \fBfield_type\fR and \fBfield_arg\fR return \fBNULL\fR on error.
-The function \fBset_field_type\fR returns one of the following:
+The functions \fBfield_type\fP and \fBfield_arg\fP return \fBNULL\fP on error.
+The function \fBset_field_type\fP returns one of the following:
.TP 5
.B E_OK
The routine succeeded.
.TP 5
.B E_SYSTEM_ERROR
-System error occurred (see \fBerrno\fR(3)).
+System error occurred (see \fBerrno\fP(3)).
.SH SEE ALSO
-\fBcurses\fR(3X),
-\fBform\fR(3X),
-\fBform_fieldtype\fR(3X),
-\fBform_variables\fR(3X).
+\fBcurses\fP(3X),
+\fBform\fP(3X),
+\fBform_fieldtype\fP(3X),
+\fBform_variables\fP(3X).
.SH NOTES
-The header file \fB<form.h>\fR automatically includes the header file
-\fB<curses.h>\fR.
+The header file \fB<form.h>\fP automatically includes the header file
+\fB<curses.h>\fP.
.SH PORTABILITY
These routines emulate the System V forms library.
They were not supported on
projects / ncurses.git / blobdiff