Debian Codegraph @

upstream/debian-unstable/man3/opts.3form

raw
1 .\"***************************************************************************
2 .\" Copyright 2018-2024,2025 Thomas E. Dickey *
3 .\" Copyright 1998-2010,2015 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_opts.3x,v 1.37 2025/01/19 00:51:10 tom Exp $
31 .TH opts 3FORM 2025-01-18 "ncurses 6.6" "Library calls"
32 .ie \n(.g \{\
33 .ds `` \(lq
34 .ds '' \(rq
35 .\}
36 .el \{\
37 .ie t .ds `` ``
38 .el .ds `` ""
39 .ie t .ds '' ''
40 .el .ds '' ""
41 .\}
42 .SH NAME
43 \fBset_form_opts\fP,
44 \fBform_opts_on\fP,
45 \fBform_opts_off\fP,
46 \fBform_opts\fP \-
47 set and get form options
48 .SH SYNOPSIS
49 .nf
50 \fB#include <form.h>
51 .PP
52 \fBint set_form_opts(FORM *\fIform\fP, Field_Options \fIopts\fP);
53 \fBField_Options form_opts(const FORM *\fIform\fP);
54 .PP
55 \fBint form_opts_on(FORM *\fIform\fP, Field_Options \fIopts\fP);
56 \fBint form_opts_off(FORM *\fIform\fP, Field_Options \fIopts\fP);
57 .fi
58 .SH DESCRIPTION
59 The function \fBset_form_opts\fP sets all the given form's option bits
60 (form option bits may be logically \*(``or\*(''-ed together).
61 .PP
62 The function \fBform_opts_on\fP turns on the given option bits, and leaves
63 others alone.
64 .PP
65 The function \fBform_opts_off\fP turns off the given option bits, and leaves
66 others alone.
67 .PP
68 The function \fBform_opts\fP returns the form's current option bits.
69 .PP
70 The following options are defined (all are on by default):
71 .TP 5
72 O_NL_OVERLOAD
73 Overload the \fBREQ_NEW_LINE\fP forms driver request so that calling it at the
74 end of a field goes to the next field.
75 .TP 5
76 O_BS_OVERLOAD
77 Overload the \fBREQ_DEL_PREV\fP forms driver request so that calling it at the
78 beginning of a field goes to the previous field.
79 .SH RETURN VALUE
80 Except for \fBform_opts\fP, each routine returns one of the following:
81 .TP 5
82 .B E_OK
83 The routine succeeded.
84 .TP 5
85 .B E_SYSTEM_ERROR
86 System error occurred (see \fBerrno\fP(3)).
87 .SH PORTABILITY
88 These routines emulate the System V forms library.
89 They were not supported on
90 Version 7 or BSD versions.
91 .SH AUTHORS
92 Juergen Pfeifer.
93 Manual pages and adaptation for new curses by Eric S. Raymond.
94 .SH SEE ALSO
95 \fB\%ncurses\fP(3NCURSES),
96 \fB\%form\fP(3FORM)