ncurses 6.2 - patch 20201003
[ncurses.git] / man / form_variables.3x
1 .\"***************************************************************************
2 .\" Copyright 2020 Thomas E. Dickey                                          *
3 .\" Copyright 2010-2013,2017 Free Software Foundation, Inc.                  *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: form_variables.3x,v 1.6 2020/02/02 23:34:34 tom Exp $
31 .TH form_variables 3X ""
32 .na
33 .hy 0
34 .SH NAME
35 \fBTYPE_ALNUM\fR,
36 \fBTYPE_ALPHA\fR,
37 \fBTYPE_ENUM\fR,
38 \fBTYPE_INTEGER\fR,
39 \fBTYPE_IPV4\fR,
40 \fBTYPE_NUMERIC\fR,
41 \fBTYPE_REGEXP\fR
42 \- form system global variables
43 .ad
44 .hy
45 .SH SYNOPSIS
46 .nf
47 \fB#include <form.h>\fR
48 .PP
49 \fBFIELDTYPE * TYPE_ALNUM;\fR
50 \fBFIELDTYPE * TYPE_ALPHA;\fR
51 \fBFIELDTYPE * TYPE_ENUM;\fR
52 \fBFIELDTYPE * TYPE_INTEGER;\fR
53 \fBFIELDTYPE * TYPE_IPV4;\fR
54 \fBFIELDTYPE * TYPE_NUMERIC;\fR
55 \fBFIELDTYPE * TYPE_REGEXP;\fR
56 .fi
57 .SH DESCRIPTION
58 These are building blocks for the form library,
59 defining fields that can be created using \fBset_fieldtype\fP(3X).
60 Each provides functions for field- and character-validation,
61 according to the given datatype.
62 .SS TYPE_ALNUM
63 This holds alphanumeric data.
64 .SS TYPE_ALPHA
65 This holds alphabetic data.
66 .SS TYPE_ENUM
67 This holds an enumerated type.
68 .SS TYPE_INTEGER
69 This holds a decimal integer.
70 .SS TYPE_IPV4
71 This holds an IPv4 internet address, e.g., "127.0.0.1".
72 .SS TYPE_NUMERIC
73 This holds a decimal number, with optional sign and decimal point.
74 .SS TYPE_REGEXP
75 This holds a regular expression.
76 .SH PORTABILITY
77 The \fBTYPE_IPV4\fP variable is an extension not provided by older
78 implementations of the form library.
79 .SH SEE ALSO
80 \fBform\fR(3X).