1 .\"***************************************************************************
2 .\" Copyright 2018-2022,2023 Thomas E. Dickey *
3 .\" Copyright 1998-2014,2015 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.42 2023/11/25 13:58:47 tom Exp $
31 .TH form_field_opts 3X 2023-11-25 "ncurses 6.4" "Library calls"
37 set and get field options
42 \fBint set_field_opts(FIELD *\fIfield\fP, Field_Options \fIopts\fP);
43 \fBField_Options field_opts(const FIELD *\fIfield\fP);
45 \fBint field_opts_on(FIELD *\fIfield\fP, Field_Options \fIopts\fP);
46 \fBint field_opts_off(FIELD *\fIfield\fP, Field_Options \fIopts\fP);
49 The function \fBset_field_opts\fP sets all the given field's option bits (field
50 option bits may be logically-OR'ed together).
52 The function \fBfield_opts_on\fP turns on the given option bits, and leaves
55 The function \fBfield_opts_off\fP turns off the given option bits, and leaves
58 The function \fBfield_opts\fP returns the field's current option bits.
60 The following standard options are defined (all are on by default):
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.
70 Skip to the next field when this one fills.
73 The field is cleared whenever a character is entered at the first position.
76 The field can be edited.
82 Validate field only if modified by user.
85 The field contents are displayed as data is entered.
88 Field buffers are fixed to field's original size.
89 Turn this option off to create a dynamic field.
92 The field is displayed.
93 If this option is off, display of the field is
97 Words that do not fit on a line are wrapped to the next line.
101 These extension options are defined (extensions are off by default):
104 Permit dynamic fields to be justified, like static fields.
107 Preserve leading whitespace in the field buffer, which is normally discarded.
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.
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.
123 Except for \fBfield_opts\fP, each routine returns one of the following:
126 The routine succeeded.
129 Routine detected an incorrect or out-of-range argument.
132 The field is the current field.
135 System error occurred (see \fBerrno\fP(3)).
137 These routines emulate the System V forms library.
138 They were not supported on
139 Version 7 or BSD versions.
142 Manual pages and adaptation for new curses by Eric S. Raymond.
146 \fB\%form_field_just\fP(3X)