X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_fieldtype.3x.html;h=468c9dbedae8511a127322fa4fb22f8c74b84899;hp=d4ff4f34b8efb213865eb393d2fc3d4c0f5ec6de;hb=d97989d1e0db7282c723cabb44b991b951790006;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/doc/html/man/form_fieldtype.3x.html b/doc/html/man/form_fieldtype.3x.html index d4ff4f34..468c9dbe 100644 --- a/doc/html/man/form_fieldtype.3x.html +++ b/doc/html/man/form_fieldtype.3x.html @@ -1,8 +1,7 @@ - +
+ +- +form_fieldtype(3x) form_fieldtype(3x) --
+ + + +
form_fieldtype - define validation-field types --
+
#include <form.h> FIELDTYPE *new_fieldtype( bool (* const field_check)(FIELD *, const void *), @@ -67,109 +69,110 @@ FIELDTYPE *type2); --
- The function new_fieldtype creates a new field type usable - for data validation. You supply it with field_check, a - predicate to check the validity of an entered data string - whenever the user attempt to leave a field. The (FIELD *) - argument is passed in so the validation predicate can see - the field's buffer, sizes and other attributes; the second - argument is an argument-block structure, about which more - below. - - You also supply new_fieldtype with char_check, a function - to validate input characters as they are entered; it will - be passed the character to be checked and a pointer to an - argument-block structure. - - The function free_fieldtype frees the space allocated for - a given validation type. - - The function set_fieldtype associates three storage-man- - agement functions with a field type. The mak_arg function - is automatically applied to the list of arguments you give - set_field_type when attaching validation to a field; its - job is to bundle these into an allocated argument-block - object which can later be passed to validation predicated. - The other two hook arguments should copy and free argu- - ment-block structures. They will be used by the forms- - driver code. You must supply the mak_arg function, the - other two are optional, you may supply NULL for them. In - this case it is assumed, that mak_arg doesn't allocate - memory but simply loads the argument into a single scalar +
+ The function new_fieldtype creates a new field type usable for data + validation. You supply it with field_check, a predicate to check the + validity of an entered data string whenever the user attempts to leave + a field. The (FIELD *) argument is passed in so the validation predi- + cate can see the field's buffer, sizes and other attributes; the second + argument is an argument-block structure, about which more below. + + You also supply new_fieldtype with char_check, a function to validate + input characters as they are entered; it will be passed the character + to be checked and a pointer to an argument-block structure. + + The function free_fieldtype frees the space allocated for a given vali- + dation type. + + The function set_fieldtype_arg associates three storage-management + functions with a field type. The make_arg function is automatically + applied to the list of arguments you give set_field_type when attaching + validation to a field; its job is to bundle these into an allocated + argument-block object which can later be passed to validation predi- + cated. The other two hook arguments should copy and free argument- + block structures. They will be used by the forms-driver code. You + must supply the make_arg function, the other two are optional, you may + supply NULL for them. In this case it is assumed that make_arg does + not allocate memory but simply loads the argument into a single scalar value. - The form driver requests REQ_NEXT_CHOICE and - REQ_PREV_CHOICE assume that the possible values of a field - form an ordered set, and provide the forms user with a way - to move through the set. The set_fieldtype_choice func- - tion allows forms programmers to define successor and pre- - decessor functions for the field type. These functions - take the field pointer and an argument-block structure as - arguments. + The function link_fieldtype creates a new field type from the two given + types. They are connected by an logical 'OR'. + The form driver requests REQ_NEXT_CHOICE and REQ_PREV_CHOICE assume + that the possible values of a field form an ordered set, and provide + the forms user with a way to move through the set. The set_field- + type_choice function allows forms programmers to define successor and + predecessor functions for the field type. These functions take the + field pointer and an argument-block structure as arguments. --
- The pointer-valued routines return NULL on error. - The integer-valued routines return one of the following - codes on error: +
+ The pointer-valued routines return NULL on error. They set errno + according to their success: E_OK The routine succeeded. - E_SYSTEM_ERROR - System error occurred (see errno). - E_BAD_ARGUMENT - Routine detected an incorrect or out-of-range argu- - ment. - - E_CONNECTED - The field is already connected to a form. + Routine detected an incorrect or out-of-range argument. + E_SYSTEM_ERROR + System error occurred, e.g., malloc failure. --
- curses(3x), form(3x). + The integer-valued routines return one of the following codes on error: + E_OK The routine succeeded. --
- The header file <form.h> automatically includes the header - file <curses.h>. + E_BAD_ARGUMENT + Routine detected an incorrect or out-of-range argument. - All of the (char *) arguments of these functions should - actually be (void *). The type has been left uncorrected - for strict compatibility with System V. + E_CONNECTED + The field is already connected to a form. + E_CURRENT + The field is the current field. --
- These routines emulate the System V forms library. They - were not supported on Version 7 or BSD versions. + E_SYSTEM_ERROR + System error occurred (see errno(3)). --
- Juergen Pfeifer. Manual pages and adaptation for new - curses by Eric S. Raymond. +
+ curses(3x), form(3x). +
+ The header file <form.h> automatically includes the header file + <curses.h>. + All of the (char *) arguments of these functions should actually be + (void *). The type has been left uncorrected for strict compatibility + with System V. +
+ These routines emulate the System V forms library. They were not sup- + ported on Version 7 or BSD versions. +
+ Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. + Raymond. + form_fieldtype(3x)-