te
Copyright 1989 AT&T
Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
forms - character based forms package

#include <form.h>

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.

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 new_field() will have the new default attribute value. (The attributes of previously created fields are not changed if a current default attribute value is changed.)

The following table lists each forms routine and the name of the manual page on which it is described.

forms Routine Name

current_field

data_ahead

data_behind

dup_field

dynamic_field_info

field_arg

field_back

field_buffer

field_count

field_fore

field_index

field_info

field_init

field_just

field_opts

field_opts_off

field_opts_on

field_pad

field_status

field_term

field_type

field_userptr

form_driver

form_fields

form_init

form_opts

form_opts_off

form_opts_on

form_page

form_sub

form_term

form_userptr

form_win

free_field

free_fieldtype

free_form

link_field

link_fieldtype

move_field

new_field

new_fieldtype

new_form

new_page

pos_form_cursor

post_form

scale_form

set_current_field

set_field_back

set_field_buffer

set_field_fore

set_field_init

set_field_just

set_field_opts

set_field_pad

set_field_status

set_field_term

set_field_type

set_field_userptr

set_fieldtype_arg

set_fieldtype_choice

set_form_fields

set_form_init

set_form_opts

set_form_page

set_form_sub

set_form_term

set_form_userptr

set_form_win

set_max_field

set_new_page

unpost_form

Routines that return a pointer always return NULL on error. Routines that return an integer return one of the following:

E_OK

E_CONNECTED

E_SYSTEM_ERROR

E_BAD_ARGUMENT

E_CURRENT

E_POSTED

E_NOT_POSTED

E_INVALID_FIELD

E_NOT_CONNECTED

E_NO_ROOM

E_BAD_STATE

E_REQUEST_DENIED

E_UNKNOWN_COMMAND

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
MT-Level	Unsafe

curses(3CURSES), attributes(5)

The header <form.h> automatically includes the headers <eti.h> and <curses.h>.