form_field_opts()

set and get field options 

Curses Function


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(const FIELD *field);


DESCRIPTION

The function set_field_opts() sets all the given field's option bits (field option bits may be logically-OR'ed together).

The function field_opts_on() turns on the given option bits, and leaves others alone.

The function field_opts_off() turns off the given option bits, and leaves others alone.

The function field_opts() returns the field's current option bits.

The following options are defined (all are on by default):

O_VISIBLE 

The field is displayed. If this option is off, display of the field is suppressed.

O_ACTIVE 

The field is visited during processing. If this option is off, the field will not be reachable by navigation keys.

O_PUBLIC 

The field contents are displayed as data is entered.

O_EDIT 

The field can be edited.

O_WRAP 

Words that don't fit on a line are wrapped to the next line. Words are blank-separated.

O_BLANK 

The field is cleared whenever a character is entered at the first position.

O_AUTOSKIP 

Skip to the next field when this one fills

O_NULLOK 

Allow a blank field.

O_STATIC 

Field buffers are fixed to field's original size.

O_PASSOK 

Validate field only if modified by user.


RETURN VALUES

Except for field_opts(), each routine returns one of the following:

E_OK 

The routine succeeded.

E_SYSTEM_ERROR 

System error occurred.

E_CURRENT 

The field is the current field


NOTES

The header file <formh> automatically includes the header file <cursesh>


PORTABILITY

These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions.


AUTHORS

Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond.


AVAILABILITY

PTC MKS Toolkit for Professional Developers
PTC MKS Toolkit for Enterprise Developers
PTC MKS Toolkit for Enterprise Developers 64-Bit Edition


SEE ALSO

Functions:
curses(), form()


PTC MKS Toolkit 10.1 Documentation Build 15.