forms(3X) UNIX System V forms(3X)
NAME
forms - character based forms package
SYNOPSIS
#include <form.h>
DESCRIPTION
The form library is built using the curses library, and any program using
forms routines must call one of the curses initialization routines such
as initscr. A program using these routines must be compiled with -lform
and -lcurses on the cc command line.
The forms package gives the applications programmer a terminal-
independent method of creating and customizing forms for user-
interaction. The forms package includes: field routines, which are used
to create and customize fields, link fields and assign field types;
fieldtype routines, which are used to create new field types for
validating fields; and form routines, which are used to 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 the
appropriate set or retrieve routine with a NULL field pointer. If an
application changes a current default field attribute value, subsequent
fields created using newfield will 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 formpage(3X)
data_ahead formdata(3X)
data_behind formdata(3X)
dup_field formfieldnew(3X)
dynamic_field_info formfieldinfo(3X)
field_arg formfieldvalidation(3X)
field_back formfieldattributes(3X)
field_buffer formfieldbuffer(3X)
field_count formfield(3X)
field_fore formfieldattributes(3X)
field_index formpage(3X)
field_info formfieldinfo(3X)
field_init formhook(3X)
field_just formfieldjust(3X)
field_opts formfieldopts(3X)
10/89 Page 1
forms(3X) UNIX System V forms(3X)
forms Routine Name Manual Page Name
________________________________________________
field_opts_off formfieldopts(3X)
field_opts_on formfieldopts(3X)
field_pad formfieldattributes(3X)
field_status formfieldbuffer(3X)
field_term formhook(3X)
field_type formfieldvalidation(3X)
field_userptr formfielduserptr(3X)
form_driver formdriver(3X)
form_fields formfield(3X)
form_init formhook(3X)
form_opts formopts(3X)
form_opts_off formopts(3X)
form_opts_on formopts(3X)
form_page formpage(3X)
form_sub formwin(3X)
form_term formhook(3X)
form_userptr formuserptr(3X)
form_win formwin(3X)
free_field formfieldnew(3X)
free_fieldtype formfieldtype(3X)
free_form formnew(3X)
link_field formfieldnew(3X)
link_fieldtype formfieldtype(3X)
move_field formfield(3X)
new_field formfieldnew(3X)
new_fieldtype formfieldtype(3X)
new_form formnew(3X)
new_page formnewpage(3X)
pos_form_cursor formcursor(3X)
post_form formpost(3X)
scale_form formwin(3X)
set_current_field formpage(3X)
set_field_back formfieldattributes(3X)
set_field_buffer formfieldbuffer(3X)
set_field_fore formfieldattributes(3X)
set_field_init formhook(3X)
set_field_just formfieldjust(3X)
set_field_opts formfieldopts(3X)
set_field_pad formfieldattributes(3X)
set_field_status formfieldbuffer(3X)
set_field_term formhook(3X)
set_field_type formfieldvalidation(3X)
set_field_userptr formfielduserptr(3X)
set_fieldtype_arg formfieldtype(3X)
set_fieldtype_choice formfieldtype(3X)
set_form_fields formfield(3X)
set_form_init formhook(3X)
set_form_opts formopts(3X)
set_form_page formpage(3X)
set_form_sub formwin(3X)
Page 2 10/89
forms(3X) UNIX System V forms(3X)
forms Routine Name Manual Page Name
________________________________________________
set_form_term formhook(3X)
set_form_userptr formuserptr(3X)
set_form_win formwin(3X)
set_max_field formfieldbuffer(3X)
set_new_page formnewpage(3X)
unpost_form formpost(3X)
RETURN VALUE
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 the
form driver.
NOTES
The header file <form.h> automatically includes the header files <eti.h>
and <curses.h>.
SEE ALSO
curses(3X), and 3X pages whose names begin "form" for detailed routine
descriptions.
10/89 Page 3