Curses Library Functions forms(3CURSES)
NAME
forms - character based forms package
SYNOPSIS
#include
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 rou-
tines, which are used to create new field types for validat-
ing 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 NUL 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 attri-
bute 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 formpage(3X)
dataahead formdata(3X)
SunOS 5.11 Last change: 31 Dec 1996 1
Curses Library Functions forms(3CURSES)
databehind formdata(3X)
dupfield formfieldnew(3X)
dynamicfieldinfo formfieldinfo(3X)
fieldarg formfieldvalidation(3X)
fieldback formfieldattributes(3X)
fieldbuffer formfieldbuffer(3X)
fieldcount formfield(3X)
fieldfore formfieldattributes(3X)
fieldindex formpage(3X)
fieldinfo formfieldinfo(3X)
fieldinit formhook(3X)
fieldjust formfieldjust(3X)
fieldopts formfieldopts(3X)
fieldoptsoff formfieldopts(3X)
fieldoptson formfieldopts(3X)
fieldpad formfieldattributes(3X)
fieldstatus formfieldbuffer(3X)
SunOS 5.11 Last change: 31 Dec 1996 2
Curses Library Functions forms(3CURSES)
fieldterm formhook(3X)
fieldtype formfieldvalidation(3X)
fielduserptr formfielduserptr(3X)
formdriver formdriver(3X)
formfields formfield(3X)
forminit formhook(3X)
formopts formopts(3X)
formoptsoff formopts(3X)
formoptson formopts(3X)
formpage formpage(3X)
formsub formwin(3X)
formterm formhook(3X)
formuserptr formuserptr(3X)
formwin formwin(3X)
freefield formfieldnew(3X)
freefieldtype formfieldtype(3X)
freeform formnew(3X)
SunOS 5.11 Last change: 31 Dec 1996 3
Curses Library Functions forms(3CURSES)
linkfield formfieldnew(3X)
linkfieldtype formfieldtype(3X)
movefield formfield(3X)
newfield formfieldnew(3X)
newfieldtype formfieldtype(3X)
newform formnew(3X)
newpage formnewpage(3X)
posformcursor formcursor(3X)
postform formpost(3X)
scaleform formwin(3X)
setcurrentfield formpage(3X)
setfieldback formfieldattributes(3X)
setfieldbuffer formfieldbuffer(3X)
setfieldfore formfieldattributes(3X)
setfieldinit formhook(3X)
setfieldjust formfieldjust(3X)
setfieldopts formfieldopts(3X)
SunOS 5.11 Last change: 31 Dec 1996 4
Curses Library Functions forms(3CURSES)
setfieldpad formfieldattributes(3X)
setfieldstatus formfieldbuffer(3X)
setfieldterm formhook(3X)
setfieldtype formfieldvalidation(3X)
setfielduserptr formfielduserptr(3X)
setfieldtypearg formfieldtype(3X)
setfieldtypechoice formfieldtype(3X)
setformfields formfield(3X)
setforminit formhook(3X)
setformopts formopts(3X)
setformpage formpage(3X)
setformsub formwin(3X)
setformterm formhook(3X)
setformuserptr formuserptr(3X)
setformwin formwin(3X)
setmaxfield formfieldbuffer(3X)
setnewpage formnewpage(3X)
SunOS 5.11 Last change: 31 Dec 1996 5
Curses Library Functions forms(3CURSES)
unpostform formpost(3X)
RETURN VALUES
Routines that return a pointer always return NUL on error.
Routines that return an integer return one of the following:
EOK The function returned successfully.
ECONECTED The field is already connected to a
form.
ESYSTEMEROR System error.
EBADARGUMENT An argument is incorrect.
ECURENT The field is the current field.
EPOSTED The form is posted.
ENOTPOSTED The form is not posted.
EINVALIDFIELD The field contents are invalid.
ENOTCONECTED The field is not connected to a form.
ENOROM The form does not fit in the subwindow.
EBADSTATE The routine was called from an initial-
ization or termination function.
EREQUESTDENIED The form driver request failed.
EUNKNOWNCOMAND An unknown request was passed to the
form driver.
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SunOS 5.11 Last change: 31 Dec 1996 6
Curses Library Functions forms(3CURSES)
ATRIBUTE TYPE ATRIBUTE VALUE
MT-Level Unsafe
SEE ALSO
curses(3CURSES), attributes(5)
NOTES
The header automatically includes the headers
and .
SunOS 5.11 Last change: 31 Dec 1996 7
|
