2 .\"***************************************************************************
3 .\" Copyright (c) 1998 Free Software Foundation, Inc. *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a *
6 .\" copy of this software and associated documentation files (the *
7 .\" "Software"), to deal in the Software without restriction, including *
8 .\" without limitation the rights to use, copy, modify, merge, publish, *
9 .\" distribute, distribute with modifications, sublicense, and/or sell *
10 .\" copies of the Software, and to permit persons to whom the Software is *
11 .\" furnished to do so, subject to the following conditions: *
13 .\" The above copyright notice and this permission notice shall be included *
14 .\" in all copies or substantial portions of the Software. *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 .\" Except as contained in this notice, the name(s) of the above copyright *
25 .\" holders shall not be used in advertising or otherwise to promote the *
26 .\" sale, use or other dealings in this Software without prior written *
28 .\"***************************************************************************
30 .\" $Id: form_field_opts.3x,v 1.7 1998/11/29 01:06:54 Rick.Ohnemus Exp $
31 .TH form_field_opts 3X ""
33 \fBform_field_opts\fR - set and get field options
35 \fB#include <form.h>\fR
37 int set_field_opts(FIELD *field, OPTIONS opts);
39 int field_opts_on(FIELD *field, OPTIONS opts);
41 int field_opts_off(FIELD *field, OPTIONS opts);
43 OPTIONS field_opts(const FIELD *field);
46 The function \fBset_field_opts\fR sets all the given field's option bits (field
47 option bits may be logically-OR'ed together).
49 The function \fBfield_opts_on\fR turns on the given option bits, and leaves
52 The function \fBfield_opts_off\fR turns off the given option bits, and leaves
55 The function \fBfield_opts\fR returns the field's current option bits.
57 The following options are defined (all are on by default):
60 The field is displayed. If this option is off, display of the field is
64 The field is visited during processing. If this option is off, the field will
65 not be reachable by navigation keys. Please notice that an invisible field
66 appears to be inactive also.
69 The field contents are displayed as data is entered.
72 The field can be edited.
75 Words that don't fit on a line are wrapped to the next line. Words are
79 The field is cleared whenever a character is entered at the first position.
82 Skip to the next field when this one fills
88 Field buffers are fixed to field's original size.
91 Validate field only if modified by user.
93 Except for \fBfield_opts\fR, each routine returns one of the following:
96 The routine succeeded.
99 System error occurred (see \fBerrno\fR).
102 The field is the current field.
104 \fBcurses\fR(3X), \fBform\fR(3X).
107 The header file \fB<form.h>\fR automatically includes the header file
110 These routines emulate the System V forms library. They were not supported on
111 Version 7 or BSD versions.
113 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
116 .\"# The following sets edit modes for GNU EMACS
117 .\"# Local Variables: