X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_field_validation.3x.html;h=8150c2c1a7a1921923fc01cd071590cd9f503e60;hb=HEAD;hp=3574c0c0e32484f029a05be8f68c82d1f50386c9;hpb=f79c210479470378389aab5b8d4d42d4a7f3d9a4;p=ncurses.git diff --git a/doc/html/man/form_field_validation.3x.html b/doc/html/man/form_field_validation.3x.html index 3574c0c0..e66d71c2 100644 --- a/doc/html/man/form_field_validation.3x.html +++ b/doc/html/man/form_field_validation.3x.html @@ -1,6 +1,6 @@
-form_field_validation(3x) Library calls form_field_validation(3x) @@ -57,7 +57,7 @@ FIELDTYPE *field_type(const FIELD *field); int set_field_type(FIELD *field, FIELDTYPE *type, ...); - /* predefined field types */ + /* predefined field types */ FIELDTYPE *TYPE_ALNUM; FIELDTYPE *TYPE_ALPHA; FIELDTYPE *TYPE_ENUM; @@ -92,7 +92,7 @@ Several field types are predefined by the form library. -
+
It is possible to set up new programmer-defined field types. Field types are implemented via the FIELDTYPE data structure, which contains several pointers to functions. @@ -102,100 +102,102 @@ The predefined types are as follows: - TYPE_ALNUM - Alphanumeric data. Required parameter: - o a third int argument, a minimum field width. +
+ Alphanumeric data. Required parameter: - TYPE_ALPHA - Character data. Required parameter: + o a third int argument, a minimum field width. - o a third int argument, a minimum field width. - TYPE_ENUM - Accept one of a specified set of strings. Required parameters: +
+ Character data. Required parameter: - o a third (char **) argument pointing to a string list; + o a third int argument, a minimum field width. - o a fourth int flag argument to enable case-sensitivity; - o a fifth int 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. +
+ Accept one of a specified set of strings. Required parameters: - The library copies the string list, so you may use a list that - lives in automatic variables on the stack. + o a third (char **) argument pointing to a string list; - TYPE_INTEGER - Integer data, parsable to an integer by atoi(3). Required - parameters: + o a fourth int flag argument to enable case-sensitivity; - o a third int argument controlling the precision, + o a fifth int 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. - o a fourth long argument constraining minimum value, + The library copies the string list, so you may use a list that lives in + automatic variables on the stack. - o a fifth long constraining maximum value. 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 printf - format specification ".*ld", where the "*" is replaced by the - precision argument. +
+ Integer data, parsable to an integer by atoi(3). Required parameters: - For details of the precision handling see printf(3). + o a third int argument controlling the precision, - TYPE_NUMERIC - Numeric data (may have a decimal-point part). Required - parameters: + o a fourth long argument constraining minimum value, - o a third int argument controlling the precision, + o a fifth long constraining maximum value. If the maximum value is + less than or equal to the minimum value, the range is simply + ignored. - o a fourth double argument constraining minimum value, + On return, the field buffer is formatted according to the printf format + specification ".*ld", where the "*" is replaced by the precision + argument. - o and a fifth double 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. + For details of the precision handling see printf(3). - On return, the field buffer is formatted according to the printf - format specification ".*f", where the "*" is replaced by the - precision argument. - For details of the precision handling see printf(3). +
+ Numeric data (may have a decimal-point part). Required parameters: - TYPE_REGEXP - Regular expression data. Required parameter: + o a third int argument controlling the precision, - o a third argument, a regular expression (char *) string. The - data is valid if the regular expression matches it. + o a fourth double argument constraining minimum value, - Regular expressions are in the format of regcomp and regexec. + o and a fifth double 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. - The regular expression must match the whole field. If you have - for example, an eight character wide field, a regular expression - "^[0-9]*$" always means that you have to fill all eight positions - with digits. If you want to allow fewer digits, you may use for - example "^[0-9]* *$" which is good for trailing spaces (up to an - empty field), or "^ *[0-9]* *$" which is good for leading and - trailing spaces around the digits. + On return, the field buffer is formatted according to the printf format + specification ".*f", where the "*" is replaced by the precision + argument. - TYPE_IPV4 - An Internet Protocol Version 4 address. Required parameter: + For details of the precision handling see printf(3). - o none - The form library checks whether or not the buffer has the form - a.b.c.d, where a, b, c, and d are numbers in the range 0 to 255. - Trailing blanks in the buffer are ignored. The address itself is - not validated. +
+ Regular expression data. Required parameter: - This is an ncurses extension; this field type may not be available - in other curses implementations. + o a third argument, a regular expression (char *) string. The data + is valid if the regular expression matches it. + + Regular expressions are in the format of regcomp and regexec. + + The regular expression must match the whole field. If you have for + example, an eight character wide field, a regular expression "^[0-9]*$" + always means that you have to fill all eight positions with digits. If + you want to allow fewer digits, you may use for example "^[0-9]* *$" + which is good for trailing spaces (up to an empty field), or "^ *[0-9]* + *$" which is good for leading and trailing spaces around the digits. + + +
+ An Internet Protocol Version 4 address. Required parameter: + + o none + + The form library checks whether or not the buffer has the form a.b.c.d, + where a, b, c, and d are numbers in the range 0 to 255. Trailing + blanks in the buffer are ignored. The address itself is not validated. + + This is an ncurses extension; this field type may not be available in + other curses implementations.
- The functions field_type and field_arg return NULL on error. The + The functions field_type and field_arg return NULL on error. The function set_field_type returns one of the following: E_OK The routine succeeded. @@ -204,15 +206,6 @@ System error occurred (see errno(3)). -
- curses(3x), form(3x), form_fieldtype(3x), form_variables(3x). - - -
- The header file <form.h> automatically includes the header file - <curses.h>. - -
These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions. @@ -223,8 +216,12 @@ Raymond. +
+ curses(3x), form(3x), form_fieldtype(3x), form_variables(3x) + + -ncurses 6.4 2022-02-12 form_field_validation(3x) +ncurses 6.5 2024-03-16 form_field_validation(3x)