man/form_variables.3x

   1 .\"***************************************************************************
   2 .\" Copyright 2020-2023,2024 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.18 2024/03/16 15:35:01 tom Exp $
  31 .TH form_variables 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
  32 .SH NAME
  33 \fB\%TYPE_ALNUM\fP,
  34 \fB\%TYPE_ALPHA\fP,
  35 \fB\%TYPE_ENUM\fP,
  36 \fB\%TYPE_INTEGER\fP,
  37 \fB\%TYPE_IPV4\fP,
  38 \fB\%TYPE_NUMERIC\fP,
  39 \fB\%TYPE_REGEXP\fP \-
  40 form system global variables
  41 .SH SYNOPSIS
  42 .nf
  43 \fB#include <form.h>
  44 .PP
  45 \fBFIELDTYPE * TYPE_ALNUM;
  46 \fBFIELDTYPE * TYPE_ALPHA;
  47 \fBFIELDTYPE * TYPE_ENUM;
  48 \fBFIELDTYPE * TYPE_INTEGER;
  49 \fBFIELDTYPE * TYPE_IPV4;
  50 \fBFIELDTYPE * TYPE_NUMERIC;
  51 \fBFIELDTYPE * TYPE_REGEXP;
  52 .fi
  53 .SH DESCRIPTION
  54 These are building blocks for the form library,
  55 defining fields that can be created using
  56 the \fBform_fieldtype\fP(3X) functions.
  57 Each provides functions for field- and character-validation,
  58 according to the given datatype.
  59 .SS TYPE_ALNUM
  60 This holds alphanumeric data.
  61 .SS TYPE_ALPHA
  62 This holds alphabetic data.
  63 .SS TYPE_ENUM
  64 This holds an enumerated type.
  65 .SS TYPE_INTEGER
  66 This holds a decimal integer.
  67 .SS TYPE_IPV4
  68 This holds an IPv4 internet address, e.g., "127.0.0.1".
  69 .SS TYPE_NUMERIC
  70 This holds a decimal number, with optional sign and decimal point.
  71 .SS TYPE_REGEXP
  72 This holds a regular expression.
  73 .SH PORTABILITY
  74 The \fBTYPE_IPV4\fP variable is an extension not provided by older
  75 implementations of the form library.
  76 .SH SEE ALSO
  77 \fB\%form\fP(3X)