forms(3X) DG/UX 5.4R3.00 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
-------------------------------------------------
currentfield form_page(3X)
dataahead form_data(3X)
databehind form_data(3X)
dupfield form_field_new(3X)
dynamicfieldinfo form_field_info(3X)
fieldarg form_field_validation(3X)
fieldback form_field_attributes(3X)
fieldbuffer form_field_buffer(3X)
fieldcount form_field(3X)
fieldfore form_field_attributes(3X)
fieldindex form_page(3X)
fieldinfo form_field_info(3X)
fieldinit form_hook(3X)
fieldjust form_field_just(3X)
fieldopts form_field_opts(3X)
Licensed material--property of copyright holder(s) 1
forms(3X) DG/UX 5.4R3.00 forms(3X)
fieldoptsoff form_field_opts(3X)
fieldoptson form_field_opts(3X)
fieldpad form_field_attributes(3X)
fieldstatus form_field_buffer(3X)
fieldterm form_hook(3X)
fieldtype form_field_validation(3X)
fielduserptr form_field_userptr(3X)
formdriver form_driver(3X)
formfields form_field(3X)
forminit form_hook(3X)
formopts form_opts(3X)
formoptsoff form_opts(3X)
formoptson form_opts(3X)
formpage form_page(3X)
formsub form_win(3X)
formterm form_hook(3X)
formuserptr form_userptr(3X)
formwin form_win(3X)
freefield form_field_new(3X)
freefieldtype form_fieldtype(3X)
freeform form_new(3X)
linkfield form_field_new(3X)
linkfieldtype form_fieldtype(3X)
movefield form_field(3X)
newfield form_field_new(3X)
newfieldtype form_fieldtype(3X)
newform form_new(3X)
newpage form_new_page(3X)
posformcursor form_cursor(3X)
postform form_post(3X)
scaleform form_win(3X)
setcurrentfield form_page(3X)
setfieldback form_field_attributes(3X)
setfieldbuffer form_field_buffer(3X)
setfieldfore form_field_attributes(3X)
setfieldinit form_hook(3X)
setfieldjust form_field_just(3X)
setfieldopts form_field_opts(3X)
setfieldpad form_field_attributes(3X)
setfieldstatus form_field_buffer(3X)
setfieldterm form_hook(3X)
setfieldtype form_field_validation(3X)
setfielduserptr form_field_userptr(3X)
setfieldtypearg form_fieldtype(3X)
setfieldtypechoice form_fieldtype(3X)
setformfields form_field(3X)
setforminit form_hook(3X)
setformopts form_opts(3X)
setformpage form_page(3X)
setformsub form_win(3X)
setformterm form_hook(3X)
setformuserptr form_userptr(3X)
setformwin form_win(3X)
Licensed material--property of copyright holder(s) 2
forms(3X) DG/UX 5.4R3.00 forms(3X)
setmaxfield form_field_buffer(3X)
setnewpage form_new_page(3X)
unpostform form_post(3X)
RETURN VALUE
Routines that return a pointer always return NULL on error. Routines
that return an integer return one of the following:
EOK - The function returned successfully.
ECONNECTED - The field is already connected to a form.
ESYSTEMERROR - System error.
EBADARGUMENT - An argument is incorrect.
ECURRENT - The field is the current field.
EPOSTED - The form is posted.
ENOTPOSTED - The form is not posted.
EINVALIDFIELD - The field contents are invalid.
ENOTCONNECTED - The field is not connected to a form.
ENOROOM - The form does not fit in the subwindow.
EBADSTATE - The routine was called from an
initialization or termination function.
EREQUESTDENIED - The form driver request failed.
EUNKNOWNCOMMAND - 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.
Licensed material--property of copyright holder(s) 3