form_field_opts(3X)

NAME

form_field_opts, set_field_opts, field_opts_on, field_opts_off, field_opts − forms field option routines

SYNOPSIS

#include <form.h>

int set_field_opts(FIELD ∗field, OPTIONS opts);

int field_opts_on(FIELD ∗field, OPTIONS opts);

int field_opts_off(FIELD ∗field, OPTIONS opts);

OPTIONS field_opts(FIELD ∗field);

DESCRIPTION

set_field_opts() turns on the named options of field and turns off all remaining options. Options are boolean values that can be OR-ed together.

field_opts_on() turns on the named options; no other options are changed.

field_opts_off() turns off the named options; no other options are changed.

field_opts() returns the options set for field.

Field Options:
O_VISIBLEThe field is displayed.
O_ACTIVEThe field is visited during processing.
O_PUBLICThe field contents are displayed as data is entered.
O_EDITThe field can be edited.
O_WRAPWords not fitting on a line are wrapped to the next
line.
O_BLANKThe whole field is cleared if a character is entered
in the first position.
O_AUTOSKIPSkip to the next field when the current field becomes
full.
O_NULLOKA blank field is considered valid.
O_STATICThe field buffers are fixed in size.
O_PASSOKValidate field only if modified by user.

RETURN VALUES

set_field_opts, field_opts_on and field_opts_off return one of the following:

E_OK−The function returned successfully.
E_SYSTEM_ERROR−System error.
E_CURRENT−The field is the current field.

NOTES

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

Museum