ncurses 6.1 - patch 20190216
[ncurses.git] / man / form_field_opts.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2018,2019 Free Software Foundation, Inc.              *
4 .\"                                                                          *
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:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
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.                               *
23 .\"                                                                          *
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       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: form_field_opts.3x,v 1.24 2019/01/20 20:19:03 tom Exp $
31 .TH form_field_opts 3X ""
32 .SH NAME
33 \fBset_field_opts\fP,
34 \fBfield_opts_on\fP,
35 \fBfield_opts_off\fP,
36 \fBfield_opts\fP \- set and get field options
37 .SH SYNOPSIS
38 \fB#include <form.h>\fR
39 .br
40 int set_field_opts(FIELD *field, Field_Options opts);
41 .br
42 int field_opts_on(FIELD *field, Field_Options opts);
43 .br
44 int field_opts_off(FIELD *field, Field_Options opts);
45 .br
46 Field_Options field_opts(const FIELD *field);
47 .br
48 .SH DESCRIPTION
49 The function \fBset_field_opts\fR sets all the given field's option bits (field
50 option bits may be logically-OR'ed together).
51 .PP
52 The function \fBfield_opts_on\fR turns on the given option bits, and leaves
53 others alone.
54 .PP
55 The function \fBfield_opts_off\fR turns off the given option bits, and leaves
56 others alone.
57 .PP
58 The function \fBfield_opts\fR returns the field's current option bits.
59 .PP
60 The following standard options are defined (all are on by default):
61 .TP 5
62 O_ACTIVE
63 The field is visited during processing.
64 If this option is off, the field will
65 not be reachable by navigation keys.
66 Please notice that an invisible field
67 appears to be inactive also.
68 .TP 5
69 O_AUTOSKIP
70 Skip to the next field when this one fills.
71 .TP 5
72 O_BLANK
73 The field is cleared whenever a character is entered at the first position.
74 .TP 5
75 O_EDIT
76 The field can be edited.
77 .TP 5
78 O_NULLOK
79 Allow a blank field.
80 .TP 5
81 O_PASSOK
82 Validate field only if modified by user.
83 .TP 5
84 O_PUBLIC
85 The field contents are displayed as data is entered.
86 .TP 5
87 O_STATIC
88 Field buffers are fixed to field's original size.
89 Turn this option off to create a dynamic field.
90 .TP 5
91 O_VISIBLE
92 The field is displayed.
93 If this option is off, display of the field is
94 suppressed.
95 .TP 5
96 O_WRAP
97 Words that do not fit on a line are wrapped to the next line.
98 Words are
99 blank-separated.
100 .PP
101 These extension options are defined (extensions are off by default):
102 .TP 5
103 O_DYNAMIC_JUSTIFY
104 Permit dynamic fields to be justified, like static fields.
105 .TP 5
106 O_NO_LEFT_STRIP
107 Preserve leading whitespace in the field buffer, which is normally discarded.
108 .TP 5
109 O_EDGE_INSERT_STAY
110 When inserting into a field up to the boundary position,
111 optionally delay the scrolling,
112 so that the last inserted character remains visible,
113 but advance the cursor to reflect the insertion.
114 This allows the form library to display the
115 inserted character in one-character fields
116 as well as allowing the library to maintain consistent state.
117 .TP 5
118 O_INPUT_FIELD
119 The \fBset_max_field\fP function checks for this extension,
120 which allows a dynamic field to shrink if the new
121 limit is smaller than the current field size.
122 .SH RETURN VALUE
123 Except for \fBfield_opts\fR, each routine returns one of the following:
124 .TP 5
125 .B E_OK
126 The routine succeeded.
127 .TP 5
128 .B E_BAD_ARGUMENT
129 Routine detected an incorrect or out-of-range argument.
130 .TP 5
131 .B E_CURRENT
132 The field is the current field.
133 .TP 5
134 .B E_SYSTEM_ERROR
135 System error occurred (see \fBerrno\fR(3)).
136 .SH SEE ALSO
137 \fBcurses\fR(3X),
138 \fBform\fR(3X).
139 \fBform_field_just\fR(3X).
140 .SH NOTES
141 The header file \fB<form.h>\fR automatically includes the header file
142 \fB<curses.h>\fR.
143 .SH PORTABILITY
144 These routines emulate the System V forms library.
145 They were not supported on
146 Version 7 or BSD versions.
147 .SH AUTHORS
148 Juergen Pfeifer.
149 Manual pages and adaptation for new curses by Eric S. Raymond.