ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / form_variables.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright 2020 Thomas E. Dickey                                          *
4   * Copyright 2010-2013,2017 Free Software Foundation, Inc.                  *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: form_variables.3x,v 1.6 2020/02/02 23:34:34 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>form_variables 3x</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">form_variables 3x</H1>
43 <PRE>
44 <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG>                                          <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>TYPE_ALNUM</STRONG>, <STRONG>TYPE_ALPHA</STRONG>, <STRONG>TYPE_ENUM</STRONG>, <STRONG>TYPE_INTEGER</STRONG>, <STRONG>TYPE_IPV4</STRONG>,
51        <STRONG>TYPE_NUMERIC</STRONG>, <STRONG>TYPE_REGEXP</STRONG> - form system global variables
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
56
57        <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_ALNUM;</STRONG>
58        <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_ALPHA;</STRONG>
59        <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_ENUM;</STRONG>
60        <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_INTEGER;</STRONG>
61        <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_IPV4;</STRONG>
62        <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_NUMERIC;</STRONG>
63        <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_REGEXP;</STRONG>
64
65
66 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
67        These are building blocks for the form library,  defining  fields  that
68        can  be  created  using <STRONG><A HREF="form_fieldtype.3x.html">set_fieldtype(3x)</A></STRONG>.  Each provides functions for
69        field- and character-validation, according to the given datatype.
70
71
72 </PRE><H3><a name="h3-TYPE_ALNUM">TYPE_ALNUM</a></H3><PRE>
73        This holds alphanumeric data.
74
75
76 </PRE><H3><a name="h3-TYPE_ALPHA">TYPE_ALPHA</a></H3><PRE>
77        This holds alphabetic data.
78
79
80 </PRE><H3><a name="h3-TYPE_ENUM">TYPE_ENUM</a></H3><PRE>
81        This holds an enumerated type.
82
83
84 </PRE><H3><a name="h3-TYPE_INTEGER">TYPE_INTEGER</a></H3><PRE>
85        This holds a decimal integer.
86
87
88 </PRE><H3><a name="h3-TYPE_IPV4">TYPE_IPV4</a></H3><PRE>
89        This holds an IPv4 internet address, e.g., "127.0.0.1".
90
91
92 </PRE><H3><a name="h3-TYPE_NUMERIC">TYPE_NUMERIC</a></H3><PRE>
93        This holds a decimal number, with optional sign and decimal point.
94
95
96 </PRE><H3><a name="h3-TYPE_REGEXP">TYPE_REGEXP</a></H3><PRE>
97        This holds a regular expression.
98
99
100 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
101        The <STRONG>TYPE_IPV4</STRONG> variable is an extension not provided by older  implemen-
102        tations of the form library.
103
104
105 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
106        <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
107
108
109
110                                                             <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG>
111 </PRE>
112 <div class="nav">
113 <ul>
114 <li><a href="#h2-NAME">NAME</a></li>
115 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
116 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
117 <ul>
118 <li><a href="#h3-TYPE_ALNUM">TYPE_ALNUM</a></li>
119 <li><a href="#h3-TYPE_ALPHA">TYPE_ALPHA</a></li>
120 <li><a href="#h3-TYPE_ENUM">TYPE_ENUM</a></li>
121 <li><a href="#h3-TYPE_INTEGER">TYPE_INTEGER</a></li>
122 <li><a href="#h3-TYPE_IPV4">TYPE_IPV4</a></li>
123 <li><a href="#h3-TYPE_NUMERIC">TYPE_NUMERIC</a></li>
124 <li><a href="#h3-TYPE_REGEXP">TYPE_REGEXP</a></li>
125 </ul>
126 </li>
127 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
128 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
129 </ul>
130 </div>
131 </BODY>
132 </HTML>