3 ****************************************************************************
4 * Copyright (c) 1998-2015,2018 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 ****************************************************************************
30 * @Id: form_opts.3x,v 1.13 2018/07/28 21:34:06 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>form_opts 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 <H1 class="no-header">form_opts 3x</H1>
44 <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG> <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>set_form_opts</STRONG>, <STRONG>form_opts_on</STRONG>, <STRONG>form_opts_off</STRONG>, <STRONG>form_opts</STRONG> - set and get
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
56 int set_form_opts(FORM *form, Field_Options opts);
57 int form_opts_on(FORM *form, Field_Options opts);
58 int form_opts_off(FORM *form, Field_Options opts);
59 Field_Options form_opts(const FORM *form);
62 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63 The function <STRONG>set_form_opts</STRONG> sets all the given form's option bits (form
64 option bits may be logically-OR'ed together).
66 The function <STRONG>form_opts_on</STRONG> turns on the given option bits, and leaves
69 The function <STRONG>form_opts_off</STRONG> turns off the given option bits, and leaves
72 The function <STRONG>form_opts</STRONG> returns the form's current option bits.
74 The following options are defined (all are on by default):
77 Overload the <STRONG>REQ_NEW_LINE</STRONG> forms driver request so that calling it
78 at the end of a field goes to the next field.
81 Overload the <STRONG>REQ_DEL_PREV</STRONG> forms driver request so that calling it
82 at the beginning of a field goes to the previous field.
85 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
86 Except for <STRONG>form_opts</STRONG>, each routine returns one of the following:
88 <STRONG>E_OK</STRONG> The routine succeeded.
90 <STRONG>E_SYSTEM_ERROR</STRONG>
91 System error occurred (see <STRONG>errno</STRONG>).
94 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
95 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
98 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
99 The header file <STRONG><form.h></STRONG> automatically includes the header file
100 <STRONG><curses.h></STRONG>.
103 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
104 These routines emulate the System V forms library. They were not sup-
105 ported on Version 7 or BSD versions.
108 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
109 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
114 <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
118 <li><a href="#h2-NAME">NAME</a></li>
119 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
120 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
121 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
122 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
123 <li><a href="#h2-NOTES">NOTES</a></li>
124 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
125 <li><a href="#h2-AUTHORS">AUTHORS</a></li>