The
forms(S)
library is built using the
curses(S)
library. Any program using
forms
routines must call one of the
curses( )
initialization routines such as
initscr(S).
The
forms
package gives the application programmer a terminal-independent
way to create and customize forms for user interaction.
The
forms
package includes:
field routines, which create and customize fields,
link fields, and assign field types
fieldtype routines, which create new field types
for validating fields
form routines, which create and customize forms,
assign pre/post processing functions, and
display and interact with forms
Current default values for field attributes
The
forms
package establishes initial current default values for field
attributes.
During field initialization, each field attribute is assigned the
current default value for that attribute.
An application can change or retrieve a current default attribute value
by calling a set or retrieve routine with a NULL
field pointer.
If an application changes a current default field attribute value,
subsequent fields created using
new_field(S)
have the new default attribute value.
(The attributes of previously created fields are not changed if a
current default attribute value is changed.)
Routine name index
The following table lists each
forms
routine and the name of the
manual page on which it is described.
forms
Routine Name
Manual Page Name
current_field
form_page(S)
data_ahead
form_data(S)
data_behind
form_data(S)
dup_field
form_field_new(S)
dynamic_field_info
form_field_info(S)
field_arg
form_field_validation(S)
field_back
form_field_attributes(S)
field_buffer
form_field_buffer(S)
field_count
form_field(S)
field_fore
form_field_attributes(S)
field_index
form_page(S)
field_info
form_field_info(S)
field_init
form_hook(S)
field_just
form_field_just(S)
field_opts
form_field_opts(S)
field_opts_off
form_field_opts(S)
field_opts_on
form_field_opts(S)
field_pad
form_field_attributes(S)
field_status
form_field_buffer(S)
field_term
form_hook(S)
field_type
form_field_validation(S)
field_userptr
form_field_userptr(S)
form_driver
form_driver(S)
form_fields
form_field(S)
form_init
form_hook(S)
form_opts
form_opts(S)
form_opts_off
form_opts(S)
form_opts_on
form_opts(S)
form_page
form_page(S)
form_sub
form_win(S)
form_term
form_hook(S)
form_userptr
form_userptr(S)
form_win
form_win(S)
free_field
form_field_new(S)
free_fieldtype
form_fieldtype(S)
free_form
form_new(S)
link_field
form_field_new(S)
link_fieldtype
form_fieldtype(S)
move_field
form_field(S)
new_field
form_field_new(S)
new_fieldtype
form_fieldtype(S)
new_form
form_new(S)
new_page
form_new_page(S)
pos_form_cursor
form_cursor(S)
post_form
form_post(S)
scale_form
form_win(S)
set_current_field
form_page(S)
set_field_back
form_field_attributes(S)
set_field_buffer
form_field_buffer(S)
set_field_fore
form_field_attributes(S)
set_field_init
form_hook(S)
set_field_just
form_field_just(S)
set_field_opts
form_field_opts(S)
set_field_pad
form_field_attributes(S)
set_field_status
form_field_buffer(S)
set_field_term
form_hook(S)
set_field_type
form_field_validation(S)
set_field_userptr
form_field_userptr(S)
set_fieldtype_arg
form_fieldtype(S)
set_fieldtype_choice
form_fieldtype(S)
set_form_fields
form_field(S)
set_form_init
form_hook(S)
set_form_opts
form_opts(S)
set_form_page
form_page(S)
set_form_sub
form_win(S)
set_form_term
form_hook(S)
set_form_userptr
form_userptr(S)
set_form_win
form_win(S)
set_max_field
form_field_buffer(S)
set_new_page
form_new_page(S)
unpost_form
form_post(S)
Return values
Routines that return a pointer always return NULL on error.
Routines that return an integer return one of the following:
E_OK
The function returned successfully
E_CONNECTED
The field is already connected to a form
E_SYSTEM_ERROR
System error
E_BAD_ARGUMENT
An argument is incorrect
E_CURRENT
The field is the current field
E_POSTED
The form is posted
E_NOT_POSTED
The form is not posted
E_INVALID_FIELD
The field contents are invalid
E_NOT_CONNECTED
The field is not connected to a form
E_NO_ROOM
The form does not fit in the subwindow
E_BAD_STATE
The routine was called from an initialization or termination function
E_REQUEST_DENIED
The form driver request failed
E_UNKNOWN_COMMAND
An unknown request was passed to the form driver
Warning
The header file form.h automatically includes the header files
eti.h and curses.h.
Files
/usr/lib/libform.a
the library
See also
curses(S)
and S man pages whose names begin with
``form_''
for detailed, routine descriptions