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