xref: /illumos-gate/usr/src/man/man3curses/form_field_opts.3curses (revision 3c30f56df862431210f98c7c8f13cf1362b9c574)
te
Copyright 1989 AT&T
Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
FORM_FIELD_OPTS 3CURSES "Dec 31, 1996"
NAME
form_field_opts, set_field_opts, field_opts_on, field_opts_off, field_opts - forms field option routines
SYNOPSIS

cc [ flag... ] file... -lform  -lcurses  [ library... ]
#include <form.h>

int set_field_opts(FIELD *field, OPTIONS opts);

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. O_VISIBLE

The field is displayed.

O_ACTIVE

The field is visited during processing.

O_PUBLIC

The field contents are displayed as data is entered.

O_EDIT

The field can be edited.

O_WRAP

Words not fitting on a line are wrapped to the next line.

O_BLANK

The whole field is cleared if a character is entered in the first position.

O_AUTOSKIP

Skip to the next field when the current field becomes full.

O_NULLOK

A blank field is considered valid.

O_STATIC

The field buffers are fixed in size.

O_PASSOK

Validate 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.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Unsafe
SEE ALSO

curses(3CURSES), forms(3CURSES), attributes(5)

NOTES

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