man/form_variables.3x

.\"***************************************************************************
.\" Copyright 2020-2023,2024 Thomas E. Dickey                                *
.\" Copyright 2010-2013,2017 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            *
.\" "Software"), to deal in the Software without restriction, including      *
.\" without limitation the rights to use, copy, modify, merge, publish,      *
.\" distribute, distribute with modifications, sublicense, and/or sell       *
.\" copies of the Software, and to permit persons to whom the Software is    *
.\" furnished to do so, subject to the following conditions:                 *
.\"                                                                          *
.\" The above copyright notice and this permission notice shall be included  *
.\" in all copies or substantial portions of the Software.                   *
.\"                                                                          *
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
.\"                                                                          *
.\" Except as contained in this notice, the name(s) of the above copyright   *
.\" holders shall not be used in advertising or otherwise to promote the     *
.\" sale, use or other dealings in this Software without prior written       *
.\" authorization.                                                           *
.\"***************************************************************************
.\"
.\" $Id: form_variables.3x,v 1.18 2024/03/16 15:35:01 tom Exp $
.TH form_variables 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
.SH NAME
\fB\%TYPE_ALNUM\fP,
\fB\%TYPE_ALPHA\fP,
\fB\%TYPE_ENUM\fP,
\fB\%TYPE_INTEGER\fP,
\fB\%TYPE_IPV4\fP,
\fB\%TYPE_NUMERIC\fP,
\fB\%TYPE_REGEXP\fP \-
form system global variables
.SH SYNOPSIS
.nf
\fB#include <form.h>
.PP
\fBFIELDTYPE * TYPE_ALNUM;
\fBFIELDTYPE * TYPE_ALPHA;
\fBFIELDTYPE * TYPE_ENUM;
\fBFIELDTYPE * TYPE_INTEGER;
\fBFIELDTYPE * TYPE_IPV4;
\fBFIELDTYPE * TYPE_NUMERIC;
\fBFIELDTYPE * TYPE_REGEXP;
.fi
.SH DESCRIPTION
These are building blocks for the form library,
defining fields that can be created using
the \fBform_fieldtype\fP(3X) functions.
Each provides functions for field- and character-validation,
according to the given datatype.
.SS TYPE_ALNUM
This holds alphanumeric data.
.SS TYPE_ALPHA
This holds alphabetic data.
.SS TYPE_ENUM
This holds an enumerated type.
.SS TYPE_INTEGER
This holds a decimal integer.
.SS TYPE_IPV4
This holds an IPv4 internet address, e.g., "127.0.0.1".
.SS TYPE_NUMERIC
This holds a decimal number, with optional sign and decimal point.
.SS TYPE_REGEXP
This holds a regular expression.
.SH PORTABILITY
The \fBTYPE_IPV4\fP variable is an extension not provided by older
implementations of the form library.
.SH SEE ALSO
\fB\%form\fP(3X)