ncurses 6.2 - patch 20210501
[ncurses.git] / man / form_opts.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
4 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
5 .\"                                                                          *
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:                 *
13 .\"                                                                          *
14 .\" The above copyright notice and this permission notice shall be included  *
15 .\" in all copies or substantial portions of the Software.                   *
16 .\"                                                                          *
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.                               *
24 .\"                                                                          *
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       *
28 .\" authorization.                                                           *
29 .\"***************************************************************************
30 .\"
31 .\" $Id: form_opts.3x,v 1.17 2020/10/18 00:03:49 tom Exp $
32 .TH form_opts 3X ""
33 .SH NAME
34 \fBset_form_opts\fP,
35 \fBform_opts_on\fP,
36 \fBform_opts_off\fP,
37 \fBform_opts\fR \- set and get form options
38 .SH SYNOPSIS
39 \fB#include <form.h>\fR
40 .sp
41 \fBint set_form_opts(FORM *\fP\fIform\fP\fB, Field_Options \fP\fIopts\fP\fB);\fP
42 .br
43 \fBField_Options form_opts(const FORM *\fP\fIform\fP\fB);\fP
44 .sp
45 \fBint form_opts_on(FORM *\fP\fIform\fP\fB, Field_Options \fP\fIopts\fP\fB);\fP
46 .br
47 \fBint form_opts_off(FORM *\fP\fIform\fP\fB, Field_Options \fP\fIopts\fP\fB);\fP
48 .br
49 .SH DESCRIPTION
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).
52 .PP
53 The function \fBform_opts_on\fR turns on the given option bits, and leaves
54 others alone.
55 .PP
56 The function \fBform_opts_off\fR turns off the given option bits, and leaves
57 others alone.
58 .PP
59 The function \fBform_opts\fR returns the form's current option bits.
60 .PP
61 The following options are defined (all are on by default):
62 .TP 5
63 O_NL_OVERLOAD
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.
66 .TP 5
67 O_BS_OVERLOAD
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.
70 .SH RETURN VALUE
71 Except for \fBform_opts\fR, each routine returns one of the following:
72 .TP 5
73 .B E_OK
74 The routine succeeded.
75 .TP 5
76 .B E_SYSTEM_ERROR
77 System error occurred (see \fBerrno\fR(3)).
78 .SH SEE ALSO
79 \fBcurses\fR(3X), \fBform\fR(3X).
80 .SH NOTES
81 The header file \fB<form.h>\fR automatically includes the header file
82 \fB<curses.h>\fR.
83 .SH PORTABILITY
84 These routines emulate the System V forms library.
85 They were not supported on
86 Version 7 or BSD versions.
87 .SH AUTHORS
88 Juergen Pfeifer.
89 Manual pages and adaptation for new curses by Eric S. Raymond.