formfieldopts(3X) formfieldopts(3X)
NAME
formfieldopts - set and get field options
SYNOPSIS
##include <>
int setfieldopts(FIELD *field, OPTIONS opts);
int fieldoptson(FIELD *field, OPTIONS opts);
int fieldoptsoff(FIELD *field, OPTIONS opts);
OPTIONS fieldopts(const FIELD *field);
DESCRIPTION
The function setfieldopts sets all the given field's option bits
(field option bits may be logically-OR'ed together).
The function fieldoptson turns on the given option bits, and leaves
others alone.
The function fieldoptsoff turns off the given option bits, and leaves
others alone.
The function fieldopts returns the field's current option bits.
The following options are defined (all are on by default):
OVISIBLE
The field is displayed. If this option is off, display of the
field is suppressed.
OACTIVE
The field is visited during processing. If this option is off,
the field will not be reachable by navigation keys. Please notice
that an invisible field appears to be inactive also.
OPUBLIC
The field contents are displayed as data is entered.
OEDIT
The field can be edited.
OWRAP
Words that don't fit on a line are wrapped to the next line.
Words are blank-separated.
OBLANK
The field is cleared whenever a character is entered at the first
position.
OAUTOSKIP
Skip to the next field when this one fills.
ONULOK
Allow a blank field.
OSTATIC
Field buffers are fixed to field's original size.
OPASOK
Validate field only if modified by user.
RETURN VALUE
Except for fieldopts, each routine returns one of the following:
EOK The routine succeeded.
ESYSTEMEROR
System error occurred (see errno).
ECURENT
The field is the current field.
SEE ALSO
curses(3X), form(3X).
NOTES The header file <> automatically includes the header file
<>.
PORTABILITY
These routines emulate the System V forms library. They were not sup-
ported on Version 7 or BSD versions.
AUTHORS
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
Raymond.
formfieldopts(3X)
|