'\" te
.\" Copyright 1989 AT&T
.\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
.TH form_field_opts 3CURSES "31 Dec 1996" "SunOS 5.11" "Curses Library Functions"
.SH NAME
form_field_opts, set_field_opts, field_opts_on, field_opts_off, field_opts \- forms field option routines
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lform\fR \fB -lcurses \fR [ \fIlibrary\fR... ]
#include <form.h>

\fBint\fR \fBset_field_opts\fR(\fBFIELD *\fR\fIfield\fR, \fBOPTIONS\fR \fIopts\fR);
.fi

.LP
.nf
\fBint\fR \fBset_field_opts\fR(\fBFIELD *\fR\fIfield\fR, \fBOPTIONS\fR \fIopts\fR);
.fi

.LP
.nf
\fBint\fR \fBfield_opts_on\fR(\fBFIELD *\fR\fIfield\fR, \fBOPTIONS\fR \fIopts\fR);
.fi

.LP
.nf
\fBint\fR \fBfield_opts_off\fR(\fBFIELD *\fR\fIfield\fR, \fBOPTIONS\fR \fIopts\fR);
.fi

.LP
.nf
\fBOPTIONS\fR \fBfield_opts\fR(\fBFIELD *\fR\fIfield\fR);
.fi

.SH DESCRIPTION
.sp
.LP
\fBset_field_opts()\fR turns on the named options of \fIfield\fR and turns off all remaining options. Options are boolean values that can be OR-ed together.
.sp
.LP
\fBfield_opts_on()\fR turns on the named options; no other options are changed.
.sp
.LP
\fBfield_opts_off()\fR turns off the named options; no other options are changed.
.sp
.LP
\fBfield_opts()\fR returns the options set for \fIfield\fR. 
.sp
.ne 2
.mk
.na
\fBO_VISIBLE\fR
.ad
.RS 14n
.rt  
The field is displayed.
.RE

.sp
.ne 2
.mk
.na
\fBO_ACTIVE\fR
.ad
.RS 14n
.rt  
	The field is visited during processing.
.RE

.sp
.ne 2
.mk
.na
\fBO_PUBLIC\fR
.ad
.RS 14n
.rt  
The field contents are displayed as data is entered.
.RE

.sp
.ne 2
.mk
.na
\fBO_EDIT\fR
.ad
.RS 14n
.rt  
	The field can be edited.
.RE

.sp
.ne 2
.mk
.na
\fBO_WRAP\fR
.ad
.RS 14n
.rt  
Words not fitting on a line are wrapped to the next line.
.RE

.sp
.ne 2
.mk
.na
\fBO_BLANK\fR
.ad
.RS 14n
.rt  
The whole field is cleared if a character is entered 	in the first position.
.RE

.sp
.ne 2
.mk
.na
\fBO_AUTOSKIP\fR
.ad
.RS 14n
.rt  
Skip to the next field when the current field becomes 	full.
.RE

.sp
.ne 2
.mk
.na
\fBO_NULLOK\fR
.ad
.RS 14n
.rt  
A blank field is considered valid.
.RE

.sp
.ne 2
.mk
.na
\fBO_STATIC\fR
.ad
.RS 14n
.rt  
The field buffers are fixed in size.
.RE

.sp
.ne 2
.mk
.na
\fBO_PASSOK\fR
.ad
.RS 14n
.rt  
Validate field only if modified by user.
.RE

.SH RETURN VALUES
.sp
.LP
\fBset_field_opts\fR, \fBfield_opts_on\fR and \fBfield_opts_off\fR return one of the following: 
.sp
.ne 2
.mk
.na
\fBE_OK\fR
.ad
.RS 18n
.rt  
The function returned successfully.
.RE

.sp
.ne 2
.mk
.na
\fBE_SYSTEM_ERROR\fR
.ad
.RS 18n
.rt  
System error.
.RE

.sp
.ne 2
.mk
.na
\fBE_CURRENT\fR
.ad
.RS 18n
.rt  
The field is the current field.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
MT-LevelUnsafe
.TE

.SH SEE ALSO
.sp
.LP
\fBcurses\fR(3CURSES), \fBforms\fR(3CURSES), \fBattributes\fR(5)
.SH NOTES
.sp
.LP
The header \fB<form.h>\fR automatically includes the headers  \fB<eti.h>\fR and \fB<curses.h>\fR\&.