ncurses 4.2
[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. Please notice that an invisible field
37 appears to be inactive also.
38 .TP 5
39 O_PUBLIC
40 The field contents are displayed as data is entered.
41 .TP 5
42 O_EDIT
43 The field can be edited.
44 .TP 5
45 O_WRAP
46 Words that don't fit on a line are wrapped to the next line.  Words are
47 blank-separated.
48 .TP 5
49 O_BLANK
50 The field is cleared whenever a character is entered at the first position.
51 .TP 5
52 O_AUTOSKIP
53 Skip to the next field when this one fills
54 .TP 5
55 O_NULLOK
56 Allow a blank field.
57 .TP 5
58 O_STATIC
59 Field buffers are fixed to field's original size.
60 .TP 5
61 O_PASSOK
62 Validate field only if modified by user.
63 .SH RETURN VALUE
64 Except for \fBfield_opts\fR, each routine returns one of the following:
65 .TP 5
66 \fBE_OK\fR
67 The routine succeeded.
68 .TP 5
69 \fBE_SYSTEM_ERROR\fR
70 System error occurred (see \fBerrno\fR).
71 .TP 5
72 \fBE_CURRENT\fR
73 The field is the current field.
74 .SH SEE ALSO
75 \fBcurses\fR(3X), \fBform\fR(3X).
76 .TP 5
77 .SH NOTES
78 The header file \fB<form.h>\fR automatically includes the header file
79 \fB<curses.h>\fR.
80 .SH PORTABILITY
81 These routines emulate the System V forms library.  They were not supported on
82 Version 7 or BSD versions.
83 .SH AUTHORS
84 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
85 S. Raymond.
86 .\"#
87 .\"# The following sets edit modes for GNU EMACS
88 .\"# Local Variables:
89 .\"# mode:nroff
90 .\"# fill-column:79
91 .\"# End: