d3dc8db1f1b5d3c42c585137489f5ef08cbab60d
[ncurses.git] / man / form_field_opts.3x
1 '\" t
2 .TH form_field_opts 3X ""
3 .SH NAME
4 \fBform_field_opts\fR - set and get field options
5 .SH SYNOPSIS
6 \fB#include <form.h>\fR
7 .br
8 int set_field_opts(FIELD *field, OPTIONS opts);
9 .br
10 int field_opts_on(FIELD *field, OPTIONS opts);
11 .br
12 int field_opts_off(FIELD *field, OPTIONS opts);
13 .br
14 OPTIONS field_opts(const FIELD *field);
15 .br
16 .SH DESCRIPTION
17 The function \fBset_field_opts\fR sets all the given field's option bits (field
18 option bits may be logically-OR'ed together).
19
20 The function \fBfield_opts_on\fR turns on the given option bits, and leaves
21 others alone.
22
23 The function \fBfield_opts_off\fR turns off the given option bits, and leaves
24 others alone.
25
26 The function \fBfield_opts\fR returns the field's current option bits.  
27
28 The following options are defined (all are on by default):
29 .TP 5
30 O_VISIBLE
31 The field is displayed.  If this option is off, display of the field is
32 suppressed, 
33 .TP 5
34 O_ACTIVE
35 The field is visited during processing.  If this option is off, the field will
36 not be reachable by navigation keys.
37 .TP 5
38 O_PUBLIC
39 The field contents are displayed as data is entered.
40 .TP 5
41 O_EDIT
42 The field can be edited.
43 .TP 5
44 O_WRAP
45 Words that don't fit on a line are wrapped to the next line.  Words are
46 blank-separated.
47 .TP 5
48 O_BLANK
49 The field is cleared whenever a character is entered at the first position.
50 .TP 5
51 O_AUTOSKIP
52 Skip to the next field when this one fills
53 .TP 5
54 O_NULLOK
55 Allow a blank field.
56 .TP 5
57 O_STATIC
58 Field buffers are fixed to field's original size.
59 .TP 5
60 O_PASSOK
61 Validate field only if modified by user.
62 .SH RETURN VALUE
63 Except for \fBfield_opts\fR, each routine returns one of the following:
64 .TP 5
65 \fBE_OK\fR
66 The routine succeeded.
67 .TP 5
68 \fBE_SYSTEM_ERROR\fR
69 System error occurred (see \fBerrno\fR).
70 .TP 5
71 \fBE_CURRENT\fR
72 The field is the current field.
73 .SH SEE ALSO
74 \fBcurses\fR(3X), \fBform\fR(3X).
75 .TP 5
76 .SH NOTES
77 The header file \fB<form.h>\fR automatically includes the header file
78 \fB<curses.h>\fR.
79 .SH PORTABILITY
80 These routines emulate the System V forms library.  They were not supported on
81 Version 7 or BSD versions.
82 .SH AUTHORS
83 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
84 S. Raymond.
85 .\"#
86 .\"# The following sets edit modes for GNU EMACS
87 .\"# Local Variables:
88 .\"# mode:nroff
89 .\"# fill-column:79
90 .\"# End: