1 .\"***************************************************************************
2 .\" Copyright 2018-2023,2024 Thomas E. Dickey *
3 .\" Copyright 1998-2010,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_opts.3x,v 1.34 2024/03/16 15:35:01 tom Exp $
31 .TH form_opts 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
37 set and get form options
42 \fBint set_form_opts(FORM *\fIform\fP, Field_Options \fIopts\fP);
43 \fBField_Options form_opts(const FORM *\fIform\fP);
45 \fBint form_opts_on(FORM *\fIform\fP, Field_Options \fIopts\fP);
46 \fBint form_opts_off(FORM *\fIform\fP, Field_Options \fIopts\fP);
49 The function \fBset_form_opts\fP sets all the given form's option bits (form
50 option bits may be logically-OR'ed together).
52 The function \fBform_opts_on\fP turns on the given option bits, and leaves
55 The function \fBform_opts_off\fP turns off the given option bits, and leaves
58 The function \fBform_opts\fP returns the form's current option bits.
60 The following options are defined (all are on by default):
63 Overload the \fBREQ_NEW_LINE\fP forms driver request so that calling it at the
64 end of a field goes to the next field.
67 Overload the \fBREQ_DEL_PREV\fP forms driver request so that calling it at the
68 beginning of a field goes to the previous field.
70 Except for \fBform_opts\fP, each routine returns one of the following:
73 The routine succeeded.
76 System error occurred (see \fBerrno\fP(3)).
78 These routines emulate the System V forms library.
79 They were not supported on
80 Version 7 or BSD versions.
83 Manual pages and adaptation for new curses by Eric S. Raymond.