2 .\"***************************************************************************
3 .\" Copyright 2018-2019,2020 Thomas E. Dickey *
4 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
6 .\" Permission is hereby granted, free of charge, to any person obtaining a *
7 .\" copy of this software and associated documentation files (the *
8 .\" "Software"), to deal in the Software without restriction, including *
9 .\" without limitation the rights to use, copy, modify, merge, publish, *
10 .\" distribute, distribute with modifications, sublicense, and/or sell *
11 .\" copies of the Software, and to permit persons to whom the Software is *
12 .\" furnished to do so, subject to the following conditions: *
14 .\" The above copyright notice and this permission notice shall be included *
15 .\" in all copies or substantial portions of the Software. *
17 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 .\" Except as contained in this notice, the name(s) of the above copyright *
26 .\" holders shall not be used in advertising or otherwise to promote the *
27 .\" sale, use or other dealings in this Software without prior written *
29 .\"***************************************************************************
31 .\" $Id: form_opts.3x,v 1.17 2020/10/18 00:03:49 tom Exp $
37 \fBform_opts\fR \- set and get form options
39 \fB#include <form.h>\fR
41 \fBint set_form_opts(FORM *\fP\fIform\fP\fB, Field_Options \fP\fIopts\fP\fB);\fP
43 \fBField_Options form_opts(const FORM *\fP\fIform\fP\fB);\fP
45 \fBint form_opts_on(FORM *\fP\fIform\fP\fB, Field_Options \fP\fIopts\fP\fB);\fP
47 \fBint form_opts_off(FORM *\fP\fIform\fP\fB, Field_Options \fP\fIopts\fP\fB);\fP
50 The function \fBset_form_opts\fR sets all the given form's option bits (form
51 option bits may be logically-OR'ed together).
53 The function \fBform_opts_on\fR turns on the given option bits, and leaves
56 The function \fBform_opts_off\fR turns off the given option bits, and leaves
59 The function \fBform_opts\fR returns the form's current option bits.
61 The following options are defined (all are on by default):
64 Overload the \fBREQ_NEW_LINE\fR forms driver request so that calling it at the
65 end of a field goes to the next field.
68 Overload the \fBREQ_DEL_PREV\fR forms driver request so that calling it at the
69 beginning of a field goes to the previous field.
71 Except for \fBform_opts\fR, each routine returns one of the following:
74 The routine succeeded.
77 System error occurred (see \fBerrno\fR(3)).
79 \fBcurses\fR(3X), \fBform\fR(3X).
81 The header file \fB<form.h>\fR automatically includes the header file
84 These routines emulate the System V forms library.
85 They were not supported on
86 Version 7 or BSD versions.
89 Manual pages and adaptation for new curses by Eric S. Raymond.