DOC HOME SITE MAP MAN PAGES GNU INFO SEARCH PRINT BOOK
 

forms(S-osr5)


forms -- character-based-forms package

Syntax

cc ...-lform -lcurses

#include <form.h>

Description

The forms(S-osr5) library is built using the curses(S-osr5) library. Any program using forms routines must call one of the curses( ) initialization routines such as initscr(S-osr5).

The forms package gives the application programmer a terminal-independent way to create and customize forms for user interaction. The forms package includes:

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-osr5) 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-osr5)
data_ahead form_data(S-osr5)
data_behind form_data(S-osr5)
dup_field form_field_new(S-osr5)
dynamic_field_info form_field_info(S-osr5)
field_arg form_field_validation(S-osr5)
field_back form_field_attributes(S-osr5)
field_buffer form_field_buffer(S-osr5)
field_count form_field(S-osr5)
field_fore form_field_attributes(S-osr5)
field_index form_page(S-osr5)
field_info form_field_info(S-osr5)
field_init form_hook(S-osr5)
field_just form_field_just(S-osr5)
field_opts form_field_opts(S-osr5)
field_opts_off form_field_opts(S-osr5)
field_opts_on form_field_opts(S-osr5)
field_pad form_field_attributes(S-osr5)
field_status form_field_buffer(S-osr5)
field_term form_hook(S-osr5)
field_type form_field_validation(S-osr5)
field_userptr form_field_userptr(S-osr5)
form_driver form_driver(S-osr5)
form_fields form_field(S-osr5)
form_init form_hook(S-osr5)
form_opts form_opts(S-osr5)
form_opts_off form_opts(S-osr5)
form_opts_on form_opts(S-osr5)
form_page form_page(S-osr5)
form_sub form_win(S-osr5)
form_term form_hook(S-osr5)
form_userptr form_userptr(S-osr5)
form_win form_win(S-osr5)
free_field form_field_new(S-osr5)
free_fieldtype form_fieldtype(S-osr5)
free_form form_new(S-osr5)
link_field form_field_new(S-osr5)
link_fieldtype form_fieldtype(S-osr5)
move_field form_field(S-osr5)
new_field form_field_new(S-osr5)
new_fieldtype form_fieldtype(S-osr5)
new_form form_new(S-osr5)
new_page form_new_page(S-osr5)
pos_form_cursor form_cursor(S-osr5)
post_form form_post(S-osr5)
scale_form form_win(S-osr5)
set_current_field form_page(S-osr5)
set_field_back form_field_attributes(S-osr5)
set_field_buffer form_field_buffer(S-osr5)
set_field_fore form_field_attributes(S-osr5)
set_field_init form_hook(S-osr5)
set_field_just form_field_just(S-osr5)
set_field_opts form_field_opts(S-osr5)
set_field_pad form_field_attributes(S-osr5)
set_field_status form_field_buffer(S-osr5)
set_field_term form_hook(S-osr5)
set_field_type form_field_validation(S-osr5)
set_field_userptr form_field_userptr(S-osr5)
set_fieldtype_arg form_fieldtype(S-osr5)
set_fieldtype_choice form_fieldtype(S-osr5)
set_form_fields form_field(S-osr5)
set_form_init form_hook(S-osr5)
set_form_opts form_opts(S-osr5)
set_form_page form_page(S-osr5)
set_form_sub form_win(S-osr5)
set_form_term form_hook(S-osr5)
set_form_userptr form_userptr(S-osr5)
set_form_win form_win(S-osr5)
set_max_field form_field_buffer(S-osr5)
set_new_page form_new_page(S-osr5)
unpost_form form_post(S-osr5)

 forms
 Routine Name            Manual Page Name
 current_field           form_page(S-osr5)
 data_ahead              form_data(S-osr5)
 data_behind             form_data(S-osr5)
 dup_field               form_field_new(S-osr5)
 dynamic_field_info      form_field_info(S-osr5)
 field_arg               form_field_validation(S-osr5)
 field_back              form_field_attributes(S-osr5)
 field_buffer            form_field_buffer(S-osr5)
 field_count             form_field(S-osr5)
 field_fore              form_field_attributes(S-osr5)
 field_index             form_page(S-osr5)
 field_info              form_field_info(S-osr5)
 field_init              form_hook(S-osr5)
 field_just              form_field_just(S-osr5)
 field_opts              form_field_opts(S-osr5)
 field_opts_off          form_field_opts(S-osr5)
 field_opts_on           form_field_opts(S-osr5)
 field_pad               form_field_attributes(S-osr5)
 field_status            form_field_buffer(S-osr5)
 field_term              form_hook(S-osr5)
 field_type              form_field_validation(S-osr5)
 field_userptr           form_field_userptr(S-osr5)
 form_driver             form_driver(S-osr5)
 form_fields             form_field(S-osr5)
 form_init               form_hook(S-osr5)
 form_opts               form_opts(S-osr5)
 form_opts_off           form_opts(S-osr5)
 form_opts_on            form_opts(S-osr5)
 form_page               form_page(S-osr5)
 form_sub                form_win(S-osr5)
 form_term               form_hook(S-osr5)
 form_userptr            form_userptr(S-osr5)
 form_win                form_win(S-osr5)
 free_field              form_field_new(S-osr5)
 free_fieldtype          form_fieldtype(S-osr5)
 free_form               form_new(S-osr5)
 link_field              form_field_new(S-osr5)
 link_fieldtype          form_fieldtype(S-osr5)
 move_field              form_field(S-osr5)
 new_field               form_field_new(S-osr5)
 new_fieldtype           form_fieldtype(S-osr5)
 new_form                form_new(S-osr5)
 new_page                form_new_page(S-osr5)
 pos_form_cursor         form_cursor(S-osr5)
 post_form               form_post(S-osr5)
 scale_form              form_win(S-osr5)
 set_current_field       form_page(S-osr5)
 set_field_back          form_field_attributes(S-osr5)
 set_field_buffer        form_field_buffer(S-osr5)
 set_field_fore          form_field_attributes(S-osr5)
 set_field_init          form_hook(S-osr5)
 set_field_just          form_field_just(S-osr5)
 set_field_opts          form_field_opts(S-osr5)
 set_field_pad           form_field_attributes(S-osr5)
 set_field_status        form_field_buffer(S-osr5)
 set_field_term          form_hook(S-osr5)
 set_field_type          form_field_validation(S-osr5)
 set_field_userptr       form_field_userptr(S-osr5)
 set_fieldtype_arg       form_fieldtype(S-osr5)
 set_fieldtype_choice    form_fieldtype(S-osr5)
 set_form_fields         form_field(S-osr5)
 set_form_init           form_hook(S-osr5)
 set_form_opts           form_opts(S-osr5)
 set_form_page           form_page(S-osr5)
 set_form_sub            form_win(S-osr5)
 set_form_term           form_hook(S-osr5)
 set_form_userptr        form_userptr(S-osr5)
 set_form_win            form_win(S-osr5)
 set_max_field           form_field_buffer(S-osr5)
 set_new_page            form_new_page(S-osr5)
 unpost_form             form_post(S-osr5)

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-osr5) and S man pages whose names begin with ``form_'' for detailed, routine descriptions

Standards conformance

forms(S-osr5) is not part of any currently supported standard; it was developed by UNIX System Laboratories, Inc. and is maintained by The SCO Group.
© 2005 The SCO Group, Inc. All rights reserved.
SCO OpenServer Release 6.0.0 -- 02 June 2005