summaryrefslogtreecommitdiff
path: root/doc/html/man/form_field_validation.3x.html
diff options
context:
space:
mode:
authorBaptiste Daroussin <bapt@FreeBSD.org>2026-01-14 13:37:49 +0100
committerBaptiste Daroussin <bapt@FreeBSD.org>2026-01-14 13:37:49 +0100
commitc5a1e08b52b2f6c05e0116d46277904b711b6bdb (patch)
treea6ad7350d1b1100356ca59616d22c51dd29743eb /doc/html/man/form_field_validation.3x.html
parent24fa7a5107c5b75d1c197accf0305be64bc72882 (diff)
Vendor import ncurses 6.6vendor/ncurses/6.6vendor/ncurses
Diffstat (limited to 'doc/html/man/form_field_validation.3x.html')
-rw-r--r--doc/html/man/form_field_validation.3x.html56
1 files changed, 26 insertions, 30 deletions
diff --git a/doc/html/man/form_field_validation.3x.html b/doc/html/man/form_field_validation.3x.html
index e66d71c26462..93e496e513d2 100644
--- a/doc/html/man/form_field_validation.3x.html
+++ b/doc/html/man/form_field_validation.3x.html
@@ -1,6 +1,6 @@
<!--
****************************************************************************
- * Copyright 2018-2023,2024 Thomas E. Dickey *
+ * Copyright 2018-2024,2025 Thomas E. Dickey *
* Copyright 1998-2010,2017 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
@@ -27,25 +27,23 @@
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: form_field_validation.3x,v 1.53 2024/03/16 15:35:01 tom Exp @
+ * @Id: form_field_validation.3x,v 1.62 2025/08/16 19:11:47 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>form_field_validation 3x 2024-03-16 ncurses 6.5 Library calls</TITLE>
+<TITLE>form_field_validation 3x 2025-08-16 ncurses 6.6 Library calls</TITLE>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
</HEAD>
<BODY>
-<H1 class="no-header">form_field_validation 3x 2024-03-16 ncurses 6.5 Library calls</H1>
+<H1 class="no-header">form_field_validation 3x 2025-08-16 ncurses 6.6 Library calls</H1>
<PRE>
<STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG> Library calls <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
-
-
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
<STRONG>form_field_validation</STRONG> - data type validation for fields
@@ -57,7 +55,7 @@
<STRONG>FIELDTYPE</STRONG> <STRONG>*field_type(const</STRONG> <STRONG>FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG>
<STRONG>int</STRONG> <STRONG>set_field_type(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>,</STRONG> <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG><EM>type</EM><STRONG>,</STRONG> <STRONG>...);</STRONG>
- <EM>/*</EM> <EM>predefined</EM> <EM>field</EM> <EM>types</EM> <EM>*/</EM>
+ <EM>/*</EM> <EM>field</EM> <EM>types</EM> <EM>*/</EM>
<STRONG>FIELDTYPE</STRONG> <STRONG>*TYPE_ALNUM;</STRONG>
<STRONG>FIELDTYPE</STRONG> <STRONG>*TYPE_ALPHA;</STRONG>
<STRONG>FIELDTYPE</STRONG> <STRONG>*TYPE_ENUM;</STRONG>
@@ -69,33 +67,31 @@
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
By default, no validation is done on form fields. You can associate a
- form with with a <EM>field</EM> <EM>type</EM>, making the form library validate input.
+ form with a <EM>field</EM> <EM>type</EM>, making the form library validate input.
</PRE><H3><a name="h3-field_arg">field_arg</a></H3><PRE>
Returns a pointer to the field's argument block. The <EM>argument</EM> <EM>block</EM> is
- an opaque structure containing a copy of the arguments provided in a
+ an opaque structure containing a copy of the arguments provided in a
<STRONG>set_field_type</STRONG> call.
</PRE><H3><a name="h3-field_type">field_type</a></H3><PRE>
- Returns a pointer to the <EM>field</EM> <EM>type</EM> associated with the form field,
+ Returns a pointer to the <EM>field</EM> <EM>type</EM> associated with the form field,
i.e., by calling <STRONG>set_field_type</STRONG>.
</PRE><H3><a name="h3-set_field_type">set_field_type</a></H3><PRE>
- The function <STRONG>set_field_type</STRONG> associates a field type with a given form
- field. This is the type checked by validation functions. Most field
- types are configurable, via arguments which the caller provides when
+ The function <STRONG>set_field_type</STRONG> associates a field type with a given form
+ field. This is the type checked by validation functions. Most field
+ types are configurable, via arguments which the caller provides when
calling <STRONG>set_field_type</STRONG>.
- Several field types are predefined by the form library.
-
-</PRE><H2><a name="h2-PREDEFINED-TYPES">PREDEFINED TYPES</a></H2><PRE>
- It is possible to set up new programmer-defined field types. Field
- types are implemented via the <STRONG>FIELDTYPE</STRONG> data structure, which contains
- several pointers to functions.
+</PRE><H2><a name="h2-FIELD-TYPES">FIELD TYPES</a></H2><PRE>
+ The <EM>form</EM> library defines several field types. They are implemented via
+ the <STRONG>FIELDTYPE</STRONG> data structure, which contains several pointers to
+ functions.
See the <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> manual page, which describes functions which
can be used to construct a field-type dynamically.
@@ -122,8 +118,8 @@
<STRONG>o</STRONG> a fourth <STRONG>int</STRONG> flag argument to enable case-sensitivity;
- <STRONG>o</STRONG> a fifth <STRONG>int</STRONG> flag argument specifying whether a partial match must
- be a unique one. If this flag is off, a prefix matches the first
+ <STRONG>o</STRONG> a fifth <STRONG>int</STRONG> flag argument specifying whether a partial match must
+ be a unique one. If this flag is off, a prefix matches the first
of any set of more than one list elements with that prefix.
The library copies the string list, so you may use a list that lives in
@@ -142,7 +138,7 @@
ignored.
On return, the field buffer is formatted according to the <STRONG>printf</STRONG> format
- specification ".*ld", where the "*" is replaced by the precision
+ specification ".*ld", where the "*" is replaced by the precision
argument.
For details of the precision handling see <STRONG>printf(3)</STRONG>.
@@ -155,9 +151,9 @@
<STRONG>o</STRONG> a fourth <STRONG>double</STRONG> argument constraining minimum value,
- <STRONG>o</STRONG> and a fifth <STRONG>double</STRONG> constraining maximum value. If your system
- supports locales, the decimal point character must be the one
- specified by your locale. If the maximum value is less than or
+ <STRONG>o</STRONG> and a fifth <STRONG>double</STRONG> constraining maximum value. If your system
+ supports locales, the decimal point character must be the one
+ specified by your locale. If the maximum value is less than or
equal to the minimum value, the range is simply ignored.
On return, the field buffer is formatted according to the <STRONG>printf</STRONG> format
@@ -195,9 +191,11 @@
This is an <EM>ncurses</EM> extension; this field type may not be available in
other curses implementations.
+ It is possible to set up new programmer-defined field types.
+
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
- The functions <STRONG>field_type</STRONG> and <STRONG>field_arg</STRONG> return <STRONG>NULL</STRONG> on error. The
+ The functions <STRONG>field_type</STRONG> and <STRONG>field_arg</STRONG> return <EM>NULL</EM> on error. The
function <STRONG>set_field_type</STRONG> returns one of the following:
<STRONG>E_OK</STRONG> The routine succeeded.
@@ -219,9 +217,7 @@
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>, <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>, <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG>
-
-
-ncurses 6.5 2024-03-16 <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
+ncurses 6.6 2025-08-16 <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
</PRE>
<div class="nav">
<ul>
@@ -234,7 +230,7 @@ ncurses 6.5 2024-03-16 <STRONG><A HREF="form_field
<li><a href="#h3-set_field_type">set_field_type</a></li>
</ul>
</li>
-<li><a href="#h2-PREDEFINED-TYPES">PREDEFINED TYPES</a>
+<li><a href="#h2-FIELD-TYPES">FIELD TYPES</a>
<ul>
<li><a href="#h3-TYPE_ALNUM">TYPE_ALNUM</a></li>
<li><a href="#h3-TYPE_ALPHA">TYPE_ALPHA</a></li>
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-19 11:31:56 +0000