:man| Alphabetical   Categories   About us 
 
form (3X) | C library functions | Unix Manual Pages | :man

NAME

form - curses extension for programming forms

CONTENTS

Synopsis
Description
Current Default Values for Field Attributes
Routine Name Index
Return Value
See Also
Notes
Portability
Authors

SYNOPSIS

#include <form.h>

DESCRIPTION

The form library provides terminal-independent facilities for composing form screens on character-cell terminals. The library includes: field routines, which create and modify form fields; and form routines, which group fields into forms, display forms on the screen, and handle interaction with the user.

The form library uses the curses libraries, and a curses initialization routine such as initscr must be called before using any of these functions. To use the form library, link with the options -lform -lcurses.

Current Default Values for Field Attributes

The form library maintains a default value for field attributes. You can get or set this default by calling the appropriate set_ or retrieval routine with a NULL field pointer. Changing this default with a set_ function affects future field creations, but does not change the rendering of fields already created.

Routine Name Index

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

curses Routine NameManual Page Name
current_fieldform_page(3X)
data_aheadform_data(3X)
data_behindform_data(3X)
dup_fieldform_field_new(3X)
dynamic_fieldinfoform_field_info(3X)
field_argform_field_validation(3X)
field_backform_field_attributes(3X)
field_bufferform_field_buffer(3X)
field_countform_field(3X)
field_foreform_field_attributes(3X)
field_indexform_page(3X)
field_infoform_field_info(3X)
field_initform_hook(3X)
field_justform_field_just(3X)
field_optsform_field_opts(3X)
field_opts_offform_field_opts(3X)
field_opts_onform_field_opts(3X)
field_padform_field_attributes(3X)
field_statusform_field_buffer(3X)
field_termform_hook(3X)
field_typeform_field_validation(3X)
field_userptrform_field_userptr(3X)
form_driverform_driver(3X)
form_fieldsform_field(3X)
form_initform_hook(3X)
form_optsform_opts(3X)
form_opts_offform_opts(3X)
form_opts_onform_opts(3X)
form_pageform_page(3X)
form_request_by_nameform_requestname(3X)
form_request_nameform_requestname(3X)
form_subform_win(3X)
form_termform_hook(3X)
form_userptrform_userptr(3X)
form_winform_win(3X)
free_fieldform_field_new(3X)
free_formform_new(3X)
link_fieldform_field_new(3X)
link_fieldtypeform_fieldtype(3X)
move_fieldform_field(3X)
new_fieldform_field_new(3X)
new_formform_new(3X)
new_pageform_new_page(3X)
pos_form_cursorform_cursor(3X)
post_formform_post(3X)
scale_formform_win(3X)
set_current_fieldform_page(3X)
set_field_backform_field_attributes(3X)
set_field_bufferform_field_buffer(3X)
set_field_foreform_field_attributes(3X)
set_field_initform_hook(3X)
set_field_justform_field_just(3X)
set_field_optsform_field_opts(3X)
set_field_padform_field_attributes(3X)
set_field_statusform_field_buffer(3X)
set_field_termform_hook(3X)
set_field_typeform_field_validation(3X)
set_field_userptrform_field_userptr(3X)
set_fieldtype_argform_fieldtype(3X)
set_fieldtype_choiceform_fieldtype(3X)
set_form_fieldsform_field(3X)
set_form_initform_hook(3X)
set_form_optsform_field_opts(3X)
set_form_pageform_page(3X)
set_form_subform_win(3X)
set_form_termform_hook(3X)
set_form_userptrform_userptr(3X)
set_form_winform_win(3X)
set_max_fieldform_field_buffer(3X)
set_new_pageform_new_page(3X)
unpost_formform_post(3X)

RETURN VALUE

Routines that return pointers return NULL on error. Routines that return an integer return one of the following error codes: -->
E_OK The routine succeeded.
E_CONNECTED
The field is already connected to a form.
E_SYSTEM_ERROR
System error occurred (see errno).
E_BAD_ARGUMENT
Routine detected an incorrect or out-of-range argument.
E_POSTED
The form is already posted.
E_BAD_STATE
Routine was called from an initialization or termination function.
E_NO_ROOM
Form is too large for its window.
E_NOT_POSTED
The form has not been posted.
E_UNKNOWN_COMMAND
The form driver code saw an unknown request code.
E_INVALID_FIELD
Contents of a field are not valid.
E_NOT_CONNECTED
No fields are connected to the form.
E_REQUEST_DENIED
The form driver could not process the request.

SEE ALSO

curses(3) and related pages whose names begin "form_" for detaileddescriptions of the entry points.

NOTES

give you a link error using GNU ld(1) and many other linkers).

PORTABILITY

AUTHORS

 
Created by Blin Media, 2008-2013